diff --git a/client-sdks/go/api-reference/analytics.mdx b/client-sdks/go/api-reference/analytics.mdx deleted file mode 100644 index 9ba0a233..00000000 --- a/client-sdks/go/api-reference/analytics.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: Analytics - Go SDK -sidebarTitle: Analytics -description: Analytics method reference -seoTitle: Analytics | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/analytics' -'og:site_name': OpenRouter Documentation -'og:title': Analytics | OpenRouter Go SDK -'og:description': >- - Analytics method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analytics%20-%20Go%20SDK&description=Analytics%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: chart-simple ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Analytics and usage endpoints - -### Available Operations - -* [GetUserActivity](#getuseractivity) - Get user activity grouped by endpoint - -## GetUserActivity - -Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getUserActivity" method="get" path="/activity" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Analytics.GetUserActivity(ctx, nil, nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.ActivityResponse](/client-sdks/go/api-reference/models/activityresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/apikeys.mdx b/client-sdks/go/api-reference/apikeys.mdx deleted file mode 100644 index 121537a7..00000000 --- a/client-sdks/go/api-reference/apikeys.mdx +++ /dev/null @@ -1,396 +0,0 @@ ---- -title: APIKeys - Go SDK -sidebarTitle: APIKeys -description: APIKeys method reference -seoTitle: APIKeys | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/apikeys' -'og:site_name': OpenRouter Documentation -'og:title': APIKeys | OpenRouter Go SDK -'og:description': >- - APIKeys method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIKeys%20-%20Go%20SDK&description=APIKeys%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: key ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -API key management endpoints - -### Available Operations - -* [GetCurrentKeyMetadata](#getcurrentkeymetadata) - Get current API key -* [List](#list) - List API keys -* [Create](#create) - Create a new API key -* [Delete](#delete) - Delete an API key -* [Get](#get) - Get a single API key -* [Update](#update) - Update an API key - -## GetCurrentKeyMetadata - -Get information on the API key associated with the current authentication session - -### Example Usage - -{/* UsageSnippet language="go" operationID="getCurrentKey" method="get" path="/key" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.GetCurrentKeyMetadata(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.GetCurrentKeyResponse](/client-sdks/go/api-reference/operations/getcurrentkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## List - -List all API keys for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="list" method="get" path="/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.List(ctx, nil, optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListResponse](/client-sdks/go/api-reference/operations/listresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Create - -Create a new API key for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createKeys" method="post" path="/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/types" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.Create(ctx, operations.CreateKeysRequest{ - ExpiresAt: optionalnullable.From(openrouter.Pointer(types.MustNewTimeFromString("2027-12-31T23:59:59Z"))), - IncludeByokInLimit: openrouter.Pointer(true), - Limit: optionalnullable.From(openrouter.Pointer[float64](50.0)), - LimitReset: optionalnullable.From(openrouter.Pointer(operations.CreateKeysLimitResetMonthly)), - Name: "My New API Key", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/createkeysrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.CreateKeysResponse](/client-sdks/go/api-reference/operations/createkeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Delete - -Delete an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="deleteKeys" method="delete" path="/keys/{hash}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.Delete(ctx, "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.DeleteKeysResponse](/client-sdks/go/api-reference/operations/deletekeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Get - -Get a single API key by hash. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getKey" method="get" path="/keys/{hash}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.Get(ctx, "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.GetKeyResponse](/client-sdks/go/api-reference/operations/getkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Update - -Update an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="updateKeys" method="patch" path="/keys/{hash}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.APIKeys.Update(ctx, "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", operations.UpdateKeysRequestBody{ - Disabled: openrouter.Pointer(false), - IncludeByokInLimit: openrouter.Pointer(true), - Limit: optionalnullable.From(openrouter.Pointer[float64](75.0)), - LimitReset: optionalnullable.From(openrouter.Pointer(operations.UpdateKeysLimitResetDaily)), - Name: openrouter.Pointer("Updated API Key Name"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.UpdateKeysResponse](/client-sdks/go/api-reference/operations/updatekeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/byok.mdx b/client-sdks/go/api-reference/byok.mdx deleted file mode 100644 index a6a1be0e..00000000 --- a/client-sdks/go/api-reference/byok.mdx +++ /dev/null @@ -1,344 +0,0 @@ ---- -title: Byok - Go SDK -sidebarTitle: Byok -description: Byok method reference -seoTitle: Byok | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/byok' -'og:site_name': OpenRouter Documentation -'og:title': Byok | OpenRouter Go SDK -'og:description': >- - Byok method documentation for the OpenRouter Go SDK. Learn how to use this API - endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Byok%20-%20Go%20SDK&description=Byok%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -BYOK endpoints - -### Available Operations - -* [List](#list) - List BYOK provider credentials -* [Create](#create) - Create a BYOK provider credential -* [Delete](#delete) - Delete a BYOK provider credential -* [Get](#get) - Get a BYOK provider credential -* [Update](#update) - Update a BYOK provider credential - -## List - -List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace, or the `provider` query parameter to filter by upstream provider. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listBYOKKeys" method="get" path="/byok" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Byok.List(ctx, optionalnullable.From[int64](nil), nil, nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `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 | -| `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](/client-sdks/go/api-reference/operations/provider) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListBYOKKeysResponse](/client-sdks/go/api-reference/operations/listbyokkeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Create - -Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createBYOKKey" method="post" path="/byok" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Byok.Create(ctx, components.CreateBYOKKeyRequest{ - Key: "sk-proj-abc123...", - Name: optionalnullable.From(openrouter.Pointer("Production OpenAI Key")), - Provider: components.BYOKProviderSlugOpenai, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/createbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.CreateBYOKKeyResponse](/client-sdks/go/api-reference/models/createbyokkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Delete - -Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its `id`. The encrypted key material is wiped and the record is marked as deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="deleteBYOKKey" method="delete" path="/byok/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Byok.Delete(ctx, "11111111-2222-3333-4444-555555555555") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.DeleteBYOKKeyResponse](/client-sdks/go/api-reference/models/deletebyokkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Get - -Get a single bring-your-own-key (BYOK) provider credential by its `id`. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getBYOKKey" method="get" path="/byok/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Byok.Get(ctx, "11111111-2222-3333-4444-555555555555") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GetBYOKKeyResponse](/client-sdks/go/api-reference/models/getbyokkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Update - -Update an existing bring-your-own-key (BYOK) provider credential by its `id`. Include the `key` field to rotate the raw provider API key in-place (the previous key material is overwritten). [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="updateBYOKKey" method="patch" path="/byok/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Byok.Update(ctx, "11111111-2222-3333-4444-555555555555", components.UpdateBYOKKeyRequest{ - Disabled: openrouter.Pointer(false), - Name: optionalnullable.From(openrouter.Pointer("Updated OpenAI Key")), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/updatebyokkeyrequest) | :heavy_check_mark: | N/A | `{"disabled": false,"name": "Updated OpenAI Key"}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.UpdateBYOKKeyResponse](/client-sdks/go/api-reference/models/updatebyokkeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/chat.mdx b/client-sdks/go/api-reference/chat.mdx deleted file mode 100644 index 5a87c940..00000000 --- a/client-sdks/go/api-reference/chat.mdx +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: Chat - Go SDK -sidebarTitle: Chat -description: Chat method reference -seoTitle: Chat | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/chat' -'og:site_name': OpenRouter Documentation -'og:title': Chat | OpenRouter Go SDK -'og:description': >- - Chat method documentation for the OpenRouter Go SDK. Learn how to use this API - endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Chat%20-%20Go%20SDK&description=Chat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: comments ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -### Available Operations - -* [Send](#send) - Create a chat completion - -## Send - -Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes. - -### Example Usage: guardrail-blocked - -{/* UsageSnippet language="go" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" example="guardrail-blocked" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Chat.Send(ctx, components.ChatRequest{ - Messages: []components.ChatMessages{ - components.CreateChatMessagesSystem( - components.ChatSystemMessage{ - Content: components.CreateChatSystemMessageContentStr( - "You are a helpful assistant.", - ), - Role: components.ChatSystemMessageRoleSystem, - }, - ), - components.CreateChatMessagesUser( - components.ChatUserMessage{ - Content: components.CreateChatUserMessageContentStr( - "What is the capital of France?", - ), - Role: components.ChatUserMessageRoleUser, - }, - ), - }, - }, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - defer res.ChatStreamingResponse.Close() - - for res.ChatStreamingResponse.Next() { - event := res.ChatStreamingResponse.Value() - log.Print(event) - // Handle the event - } - } -} -``` -### Example Usage: insufficient-permissions - -{/* UsageSnippet language="go" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" example="insufficient-permissions" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Chat.Send(ctx, components.ChatRequest{ - Messages: []components.ChatMessages{ - components.CreateChatMessagesSystem( - components.ChatSystemMessage{ - Content: components.CreateChatSystemMessageContentStr( - "You are a helpful assistant.", - ), - Role: components.ChatSystemMessageRoleSystem, - }, - ), - components.CreateChatMessagesUser( - components.ChatUserMessage{ - Content: components.CreateChatUserMessageContentStr( - "What is the capital of France?", - ), - Role: components.ChatUserMessageRoleUser, - }, - ), - }, - }, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - defer res.ChatStreamingResponse.Close() - - for res.ChatStreamingResponse.Next() { - event := res.ChatStreamingResponse.Value() - log.Print(event) - // Handle the event - } - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/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
\} | -| `xOpenRouterExperimentalMetadata` | [*components.MetadataLevel](/client-sdks/go/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.SendChatCompletionRequestResponse](/client-sdks/go/api-reference/operations/sendchatcompletionrequestresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.RequestTimeoutResponseError | 408 | application/json | -| sdkerrors.PayloadTooLargeResponseError | 413 | application/json | -| sdkerrors.UnprocessableEntityResponseError | 422 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/credits.mdx b/client-sdks/go/api-reference/credits.mdx deleted file mode 100644 index d4a7b462..00000000 --- a/client-sdks/go/api-reference/credits.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Credits - Go SDK -sidebarTitle: Credits -description: Credits method reference -seoTitle: Credits | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/credits' -'og:site_name': OpenRouter Documentation -'og:title': Credits | OpenRouter Go SDK -'og:description': >- - Credits method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Credits%20-%20Go%20SDK&description=Credits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: coins ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Credit management endpoints - -### Available Operations - -* [GetCredits](#getcredits) - Get remaining credits - -## GetCredits - -Get total credits purchased and used for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getCredits" method="get" path="/credits" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Credits.GetCredits(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.GetCreditsResponse](/client-sdks/go/api-reference/operations/getcreditsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/datasets.mdx b/client-sdks/go/api-reference/datasets.mdx deleted file mode 100644 index 3eee23c5..00000000 --- a/client-sdks/go/api-reference/datasets.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Datasets - Go SDK -sidebarTitle: Datasets -description: Datasets method reference -seoTitle: Datasets | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/datasets' -'og:site_name': OpenRouter Documentation -'og:title': Datasets | OpenRouter Go SDK -'og:description': >- - Datasets method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datasets%20-%20Go%20SDK&description=Datasets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Datasets endpoints - -### Available Operations - -* [GetRankingsDaily](#getrankingsdaily) - Daily token totals for top 50 models - -## GetRankingsDaily - -Returns the top 50 public models per day by total token usage on OpenRouter, plus a -single aggregated `other` row per day that sums every model outside that top 50. -Token totals are `prompt_tokens + completion_tokens`, matching the public rankings -chart on openrouter.ai/rankings. - -Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the -reserved permaslug `other` and is always returned last within its date, so callers -can compute `top-50 traffic / total daily traffic` without a second request. - -Authenticate with any valid OpenRouter API key (same key used for inference). -Rate-limited to 30 requests/minute per key and 500 requests/day per account. - -When republishing or quoting this dataset, OpenRouter must be cited as: -"Source: OpenRouter (openrouter.ai/rankings), as of \{as_of\}." - -Token counts come from each upstream provider's own tokenizer (Anthropic counts -are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so -a token in one row is not directly comparable to a token in another row from a -different provider. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getRankingsDaily" method="get" path="/datasets/rankings-daily" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Datasets.GetRankingsDaily(ctx, nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `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 | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.RankingsDailyResponse](/client-sdks/go/api-reference/models/rankingsdailyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/embeddings.mdx b/client-sdks/go/api-reference/embeddings.mdx deleted file mode 100644 index 8890e9b8..00000000 --- a/client-sdks/go/api-reference/embeddings.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: Embeddings - Go SDK -sidebarTitle: Embeddings -description: Embeddings method reference -seoTitle: Embeddings | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/embeddings' -'og:site_name': OpenRouter Documentation -'og:title': Embeddings | OpenRouter Go SDK -'og:description': >- - Embeddings method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embeddings%20-%20Go%20SDK&description=Embeddings%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Text embedding endpoints - -### Available Operations - -* [Generate](#generate) - Submit an embedding request -* [ListModels](#listmodels) - List all embeddings models - -## Generate - -Submits an embedding request to the embeddings router - -### Example Usage - -{/* UsageSnippet language="go" operationID="createEmbeddings" method="post" path="/embeddings" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Embeddings.Generate(ctx, operations.CreateEmbeddingsRequest{ - Input: operations.CreateInputUnionStr( - "The quick brown fox jumps over the lazy dog", - ), - Model: "openai/text-embedding-3-small", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/createembeddingsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.CreateEmbeddingsResponse](/client-sdks/go/api-reference/operations/createembeddingsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListModels - -Returns a list of all available embeddings models and their properties - -### Example Usage - -{/* UsageSnippet language="go" operationID="listEmbeddingsModels" method="get" path="/embeddings/models" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Embeddings.ListModels(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.ModelsListResponse](/client-sdks/go/api-reference/models/modelslistresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/endpoints.mdx b/client-sdks/go/api-reference/endpoints.mdx deleted file mode 100644 index 3fbd91c3..00000000 --- a/client-sdks/go/api-reference/endpoints.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: Endpoints - Go SDK -sidebarTitle: Endpoints -description: Endpoints method reference -seoTitle: Endpoints | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/endpoints' -'og:site_name': OpenRouter Documentation -'og:title': Endpoints | OpenRouter Go SDK -'og:description': >- - Endpoints method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Endpoints%20-%20Go%20SDK&description=Endpoints%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: network-wired ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Endpoint information - -### Available Operations - -* [ListZdrEndpoints](#listzdrendpoints) - Preview the impact of ZDR on the available endpoints -* [List](#list) - List all endpoints for a model - -## ListZdrEndpoints - -Preview the impact of ZDR on the available endpoints - -### Example Usage - -{/* UsageSnippet language="go" operationID="listEndpointsZdr" method="get" path="/endpoints/zdr" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Endpoints.ListZdrEndpoints(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.ListEndpointsZdrResponse](/client-sdks/go/api-reference/operations/listendpointszdrresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## List - -List all endpoints for a model - -### Example Usage - -{/* UsageSnippet language="go" operationID="listEndpoints" method="get" path="/models/{author}/{slug}/endpoints" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Endpoints.List(ctx, "", "") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListEndpointsResponse](/client-sdks/go/api-reference/operations/listendpointsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/generations.mdx b/client-sdks/go/api-reference/generations.mdx deleted file mode 100644 index 54c42c37..00000000 --- a/client-sdks/go/api-reference/generations.mdx +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: Generations - Go SDK -sidebarTitle: Generations -description: Generations method reference -seoTitle: Generations | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/generations' -'og:site_name': OpenRouter Documentation -'og:title': Generations | OpenRouter Go SDK -'og:description': >- - Generations method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Generations%20-%20Go%20SDK&description=Generations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: diagram-project ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Generation history endpoints - -### Available Operations - -* [GetGeneration](#getgeneration) - Get request & usage metadata for a generation -* [ListGenerationContent](#listgenerationcontent) - Get stored prompt and completion content for a generation - -## GetGeneration - -Get request & usage metadata for a generation - -### Example Usage - -{/* UsageSnippet language="go" operationID="getGeneration" method="get" path="/generation" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Generations.GetGeneration(ctx, "") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GenerationResponse](/client-sdks/go/api-reference/models/generationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListGenerationContent - -Get stored prompt and completion content for a generation - -### Example Usage - -{/* UsageSnippet language="go" operationID="listGenerationContent" method="get" path="/generation/content" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Generations.ListGenerationContent(ctx, "gen-1234567890") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GenerationContentResponse](/client-sdks/go/api-reference/models/generationcontentresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/guardrails.mdx b/client-sdks/go/api-reference/guardrails.mdx deleted file mode 100644 index 4af233b7..00000000 --- a/client-sdks/go/api-reference/guardrails.mdx +++ /dev/null @@ -1,892 +0,0 @@ ---- -title: Guardrails - Go SDK -sidebarTitle: Guardrails -description: Guardrails method reference -seoTitle: Guardrails | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/guardrails' -'og:site_name': OpenRouter Documentation -'og:title': Guardrails | OpenRouter Go SDK -'og:description': >- - Guardrails method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrails%20-%20Go%20SDK&description=Guardrails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Guardrails endpoints - -### Available Operations - -* [List](#list) - List guardrails -* [Create](#create) - Create a guardrail -* [Delete](#delete) - Delete a guardrail -* [Get](#get) - Get a guardrail -* [Update](#update) - Update a guardrail -* [ListGuardrailKeyAssignments](#listguardrailkeyassignments) - List key assignments for a guardrail -* [BulkAssignKeys](#bulkassignkeys) - Bulk assign keys to a guardrail -* [BulkUnassignKeys](#bulkunassignkeys) - Bulk unassign keys from a guardrail -* [ListGuardrailMemberAssignments](#listguardrailmemberassignments) - List member assignments for a guardrail -* [BulkAssignMembers](#bulkassignmembers) - Bulk assign members to a guardrail -* [BulkUnassignMembers](#bulkunassignmembers) - Bulk unassign members from a guardrail -* [ListKeyAssignments](#listkeyassignments) - List all key assignments -* [ListMemberAssignments](#listmemberassignments) - List all member assignments - -## List - -List all guardrails for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listGuardrails" method="get" path="/guardrails" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.List(ctx, optionalnullable.From[int64](nil), nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `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 | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListGuardrailsResponse](/client-sdks/go/api-reference/operations/listguardrailsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Create - -Create a new guardrail for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createGuardrail" method="post" path="/guardrails" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.Create(ctx, components.CreateGuardrailRequest{ - AllowedModels: optionalnullable.From[[]string](nil), - AllowedProviders: optionalnullable.From(openrouter.Pointer([]string{ - "openai", - "anthropic", - "deepseek", - })), - Description: optionalnullable.From(openrouter.Pointer("A guardrail for limiting API usage")), - EnforceZdrAnthropic: optionalnullable.From(openrouter.Pointer(true)), - EnforceZdrGoogle: optionalnullable.From(openrouter.Pointer(false)), - EnforceZdrOpenai: optionalnullable.From(openrouter.Pointer(true)), - EnforceZdrOther: optionalnullable.From(openrouter.Pointer(false)), - IgnoredModels: optionalnullable.From[[]string](nil), - IgnoredProviders: optionalnullable.From[[]string](nil), - LimitUsd: optionalnullable.From(openrouter.Pointer[float64](50.0)), - Name: "My New Guardrail", - ResetInterval: optionalnullable.From(openrouter.Pointer(components.GuardrailIntervalMonthly)), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/createguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.CreateGuardrailResponse](/client-sdks/go/api-reference/models/createguardrailresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Delete - -Delete an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="deleteGuardrail" method="delete" path="/guardrails/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.Delete(ctx, "550e8400-e29b-41d4-a716-446655440000") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.DeleteGuardrailResponse](/client-sdks/go/api-reference/models/deleteguardrailresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Get - -Get a single guardrail by ID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getGuardrail" method="get" path="/guardrails/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.Get(ctx, "550e8400-e29b-41d4-a716-446655440000") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GetGuardrailResponse](/client-sdks/go/api-reference/models/getguardrailresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Update - -Update an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="updateGuardrail" method="patch" path="/guardrails/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.Update(ctx, "550e8400-e29b-41d4-a716-446655440000", components.UpdateGuardrailRequest{ - Description: optionalnullable.From(openrouter.Pointer("Updated description")), - LimitUsd: optionalnullable.From(openrouter.Pointer[float64](75.0)), - Name: openrouter.Pointer("Updated Guardrail Name"), - ResetInterval: optionalnullable.From(openrouter.Pointer(components.GuardrailIntervalWeekly)), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/updateguardrailrequest) | :heavy_check_mark: | N/A | `{"description": "Updated description","limit_usd": 75,"name": "Updated Guardrail Name","reset_interval": "weekly"}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.UpdateGuardrailResponse](/client-sdks/go/api-reference/models/updateguardrailresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListGuardrailKeyAssignments - -List all API key assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listGuardrailKeyAssignments" method="get" path="/guardrails/{id}/assignments/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.ListGuardrailKeyAssignments(ctx, "550e8400-e29b-41d4-a716-446655440000", optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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 | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListGuardrailKeyAssignmentsResponse](/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkAssignKeys - -Assign multiple API keys to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkAssignKeysToGuardrail" method="post" path="/guardrails/{id}/assignments/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.BulkAssignKeys(ctx, "550e8400-e29b-41d4-a716-446655440000", components.BulkAssignKeysRequest{ - KeyHashes: []string{ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/bulkassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkAssignKeysResponse](/client-sdks/go/api-reference/models/bulkassignkeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkUnassignKeys - -Unassign multiple API keys from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkUnassignKeysFromGuardrail" method="post" path="/guardrails/{id}/assignments/keys/remove" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.BulkUnassignKeys(ctx, "550e8400-e29b-41d4-a716-446655440000", components.BulkUnassignKeysRequest{ - KeyHashes: []string{ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkUnassignKeysResponse](/client-sdks/go/api-reference/models/bulkunassignkeysresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListGuardrailMemberAssignments - -List all organization member assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listGuardrailMemberAssignments" method="get" path="/guardrails/{id}/assignments/members" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.ListGuardrailMemberAssignments(ctx, "550e8400-e29b-41d4-a716-446655440000", optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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 | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListGuardrailMemberAssignmentsResponse](/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkAssignMembers - -Assign multiple organization members to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkAssignMembersToGuardrail" method="post" path="/guardrails/{id}/assignments/members" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.BulkAssignMembers(ctx, "550e8400-e29b-41d4-a716-446655440000", components.BulkAssignMembersRequest{ - MemberUserIds: []string{ - "user_abc123", - "user_def456", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/bulkassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkAssignMembersResponse](/client-sdks/go/api-reference/models/bulkassignmembersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkUnassignMembers - -Unassign multiple organization members from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkUnassignMembersFromGuardrail" method="post" path="/guardrails/{id}/assignments/members/remove" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.BulkUnassignMembers(ctx, "550e8400-e29b-41d4-a716-446655440000", components.BulkUnassignMembersRequest{ - MemberUserIds: []string{ - "user_abc123", - "user_def456", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkUnassignMembersResponse](/client-sdks/go/api-reference/models/bulkunassignmembersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListKeyAssignments - -List all API key guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listKeyAssignments" method="get" path="/guardrails/assignments/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.ListKeyAssignments(ctx, optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListKeyAssignmentsResponse](/client-sdks/go/api-reference/operations/listkeyassignmentsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListMemberAssignments - -List all organization member guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listMemberAssignments" method="get" path="/guardrails/assignments/members" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Guardrails.ListMemberAssignments(ctx, optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListMemberAssignmentsResponse](/client-sdks/go/api-reference/operations/listmemberassignmentsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models.mdx b/client-sdks/go/api-reference/models.mdx deleted file mode 100644 index 40db7bb6..00000000 --- a/client-sdks/go/api-reference/models.mdx +++ /dev/null @@ -1,204 +0,0 @@ ---- -title: Models - Go SDK -sidebarTitle: Models -description: Models method reference -seoTitle: Models | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models' -'og:site_name': OpenRouter Documentation -'og:title': Models | OpenRouter Go SDK -'og:description': >- - Models method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Models%20-%20Go%20SDK&description=Models%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: cube ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Model information endpoints - -### Available Operations - -* [List](#list) - List all models and their properties -* [Count](#count) - Get total count of available models -* [ListForUser](#listforuser) - List models filtered by user provider preferences, privacy settings, and guardrails - -## List - -List all models and their properties - -### Example Usage - -{/* UsageSnippet language="go" operationID="getModels" method="get" path="/models" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Models.List(ctx, nil, nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `category` | [*operations.Category](/client-sdks/go/api-reference/operations/category) | :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 | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.ModelsListResponse](/client-sdks/go/api-reference/models/modelslistresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Count - -Get total count of available models - -### Example Usage - -{/* UsageSnippet language="go" operationID="listModelsCount" method="get" path="/models/count" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Models.Count(ctx, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.ModelsCountResponse](/client-sdks/go/api-reference/models/modelscountresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListForUser - -List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing). - -### Example Usage - -{/* UsageSnippet language="go" operationID="listModelsUser" method="get" path="/models/user" */} -```go expandable lines -package main - -import( - "context" - openrouter "github.com/OpenRouterTeam/go-sdk" - "os" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New() - - res, err := s.Models.ListForUser(ctx, operations.ListModelsUserSecurity{ - Bearer: os.Getenv("OPENROUTER_BEARER"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `security` | [operations.ListModelsUserSecurity](/client-sdks/go/api-reference/operations/listmodelsusersecurity) | :heavy_check_mark: | The security requirements to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.ModelsListResponse](/client-sdks/go/api-reference/models/modelslistresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/action.mdx b/client-sdks/go/api-reference/models/action.mdx deleted file mode 100644 index 226549d7..00000000 --- a/client-sdks/go/api-reference/models/action.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Action - Go SDK -sidebarTitle: Action -description: Action type definition -seoTitle: Action Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/action' -'og:site_name': OpenRouter Documentation -'og:title': Action Type | OpenRouter Go SDK -'og:description': >- - Action type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Action%20-%20Go%20SDK&description=Action%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputWebSearchCallItemActionSearch - -```go lines -action := components.CreateActionSearch(components.OutputWebSearchCallItemActionSearch{/* values here */}) -``` - -### ActionOpenPage - -```go lines -action := components.CreateActionOpenPage(components.ActionOpenPage{/* values here */}) -``` - -### ActionFindInPage - -```go lines -action := components.CreateActionFindInPage(components.ActionFindInPage{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch action.Type { - case components.ActionTypeSearchValue: - // action.OutputWebSearchCallItemActionSearch is populated - case components.ActionTypeOpenPage: - // action.ActionOpenPage is populated - case components.ActionTypeFindInPage: - // action.ActionFindInPage is populated - default: - // Unknown type - use action.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/actionenum.mdx b/client-sdks/go/api-reference/models/actionenum.mdx deleted file mode 100644 index ddf68649..00000000 --- a/client-sdks/go/api-reference/models/actionenum.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ActionEnum - Go SDK -sidebarTitle: ActionEnum -description: ActionEnum type definition -seoTitle: ActionEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/actionenum' -'og:site_name': OpenRouter Documentation -'og:title': ActionEnum Type | OpenRouter Go SDK -'og:description': >- - ActionEnum type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionEnum%20-%20Go%20SDK&description=ActionEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ActionEnumRead - -// Open enum: custom values can be created with a direct type cast -custom := components.ActionEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `ActionEnumRead` | read | -| `ActionEnumWrite` | write | -| `ActionEnumDelete` | delete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/actionfindinpage.mdx b/client-sdks/go/api-reference/models/actionfindinpage.mdx deleted file mode 100644 index 91c3637e..00000000 --- a/client-sdks/go/api-reference/models/actionfindinpage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ActionFindInPage - Go SDK -sidebarTitle: ActionFindInPage -description: ActionFindInPage type definition -seoTitle: ActionFindInPage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/actionfindinpage' -'og:site_name': OpenRouter Documentation -'og:title': ActionFindInPage Type | OpenRouter Go SDK -'og:description': >- - ActionFindInPage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionFindInPage%20-%20Go%20SDK&description=ActionFindInPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Pattern` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeFindInPage](/client-sdks/go/api-reference/models/typefindinpage) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/actionopenpage.mdx b/client-sdks/go/api-reference/models/actionopenpage.mdx deleted file mode 100644 index 4fd3feb5..00000000 --- a/client-sdks/go/api-reference/models/actionopenpage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ActionOpenPage - Go SDK -sidebarTitle: ActionOpenPage -description: ActionOpenPage type definition -seoTitle: ActionOpenPage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/actionopenpage' -'og:site_name': OpenRouter Documentation -'og:title': ActionOpenPage Type | OpenRouter Go SDK -'og:description': >- - ActionOpenPage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionOpenPage%20-%20Go%20SDK&description=ActionOpenPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Type` | [components.TypeOpenPage](/client-sdks/go/api-reference/models/typeopenpage) | :heavy_check_mark: | N/A | -| `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/actiontypesearch.mdx b/client-sdks/go/api-reference/models/actiontypesearch.mdx deleted file mode 100644 index 57f6843f..00000000 --- a/client-sdks/go/api-reference/models/actiontypesearch.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ActionTypeSearch - Go SDK -sidebarTitle: ActionTypeSearch -description: ActionTypeSearch type definition -seoTitle: ActionTypeSearch Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/actiontypesearch' -'og:site_name': OpenRouter Documentation -'og:title': ActionTypeSearch Type | OpenRouter Go SDK -'og:description': >- - ActionTypeSearch type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionTypeSearch%20-%20Go%20SDK&description=ActionTypeSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ActionTypeSearchSearch -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ActionTypeSearchSearch` | search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/activityitem.mdx b/client-sdks/go/api-reference/models/activityitem.mdx deleted file mode 100644 index cdae51cb..00000000 --- a/client-sdks/go/api-reference/models/activityitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ActivityItem - Go SDK -sidebarTitle: ActivityItem -description: ActivityItem type definition -seoTitle: ActivityItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/activityitem' -'og:site_name': OpenRouter Documentation -'og:title': ActivityItem Type | OpenRouter Go SDK -'og:description': >- - ActivityItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityItem%20-%20Go%20SDK&description=ActivityItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `ByokUsageInference` | `float64` | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `CompletionTokens` | `int64` | :heavy_check_mark: | Total completion tokens generated | 125 | -| `Date` | `string` | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `EndpointID` | `string` | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `Model` | `string` | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `PromptTokens` | `int64` | :heavy_check_mark: | Total prompt tokens used | 50 | -| `ProviderName` | `string` | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `ReasoningTokens` | `int64` | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `Requests` | `int64` | :heavy_check_mark: | Number of requests made | 5 | -| `Usage` | `float64` | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/activityresponse.mdx b/client-sdks/go/api-reference/models/activityresponse.mdx deleted file mode 100644 index 254e7abb..00000000 --- a/client-sdks/go/api-reference/models/activityresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ActivityResponse - Go SDK -sidebarTitle: ActivityResponse -description: ActivityResponse type definition -seoTitle: ActivityResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/activityresponse' -'og:site_name': OpenRouter Documentation -'og:title': ActivityResponse Type | OpenRouter Go SDK -'og:description': >- - ActivityResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityResponse%20-%20Go%20SDK&description=ActivityResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Data` | [][components.ActivityItem](/client-sdks/go/api-reference/models/activityitem) | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/allowedtools.mdx b/client-sdks/go/api-reference/models/allowedtools.mdx deleted file mode 100644 index 2f3fd673..00000000 --- a/client-sdks/go/api-reference/models/allowedtools.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AllowedTools - Go SDK -sidebarTitle: AllowedTools -description: AllowedTools type definition -seoTitle: AllowedTools Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/allowedtools' -'og:site_name': OpenRouter Documentation -'og:title': AllowedTools Type | OpenRouter Go SDK -'og:description': >- - AllowedTools type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedTools%20-%20Go%20SDK&description=AllowedTools%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `ReadOnly` | `*bool` | :heavy_minus_sign: | N/A | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/allowedtoolsunion.mdx b/client-sdks/go/api-reference/models/allowedtoolsunion.mdx deleted file mode 100644 index ef0d062d..00000000 --- a/client-sdks/go/api-reference/models/allowedtoolsunion.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: AllowedToolsUnion - Go SDK -sidebarTitle: AllowedToolsUnion -description: AllowedToolsUnion type definition -seoTitle: AllowedToolsUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/allowedtoolsunion' -'og:site_name': OpenRouter Documentation -'og:title': AllowedToolsUnion Type | OpenRouter Go SDK -'og:description': >- - AllowedToolsUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedToolsUnion%20-%20Go%20SDK&description=AllowedToolsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -allowedToolsUnion := components.CreateAllowedToolsUnionArrayOfStr([]string{/* values here */}) -``` - -### AllowedTools - -```go lines -allowedToolsUnion := components.CreateAllowedToolsUnionAllowedTools(components.AllowedTools{/* values here */}) -``` - -### - -```go lines -allowedToolsUnion := components.CreateAllowedToolsUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch allowedToolsUnion.Type { - case components.AllowedToolsUnionTypeArrayOfStr: - // allowedToolsUnion.ArrayOfStr is populated - case components.AllowedToolsUnionTypeAllowedTools: - // allowedToolsUnion.AllowedTools is populated - case components.AllowedToolsUnionTypeAny: - // allowedToolsUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/always.mdx b/client-sdks/go/api-reference/models/always.mdx deleted file mode 100644 index 3ac994ab..00000000 --- a/client-sdks/go/api-reference/models/always.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Always - Go SDK -sidebarTitle: Always -description: Always type definition -seoTitle: Always Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/always' -'og:site_name': OpenRouter Documentation -'og:title': Always Type | OpenRouter Go SDK -'og:description': >- - Always type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Always%20-%20Go%20SDK&description=Always%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/analysis.mdx b/client-sdks/go/api-reference/models/analysis.mdx deleted file mode 100644 index 901c2d0f..00000000 --- a/client-sdks/go/api-reference/models/analysis.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Analysis - Go SDK -sidebarTitle: Analysis -description: Analysis type definition -seoTitle: Analysis Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/analysis' -'og:site_name': OpenRouter Documentation -'og:title': Analysis Type | OpenRouter Go SDK -'og:description': >- - Analysis type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analysis%20-%20Go%20SDK&description=Analysis%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Structured analysis produced by the fusion judge model. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `BlindSpots` | []`string` | :heavy_check_mark: | N/A | -| `Consensus` | []`string` | :heavy_check_mark: | N/A | -| `Contradictions` | [][components.Contradiction](/client-sdks/go/api-reference/models/contradiction) | :heavy_check_mark: | N/A | -| `PartialCoverage` | [][components.PartialCoverage](/client-sdks/go/api-reference/models/partialcoverage) | :heavy_check_mark: | N/A | -| `UniqueInsights` | [][components.UniqueInsight](/client-sdks/go/api-reference/models/uniqueinsight) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/annotationaddedevent.mdx b/client-sdks/go/api-reference/models/annotationaddedevent.mdx deleted file mode 100644 index 39445a8d..00000000 --- a/client-sdks/go/api-reference/models/annotationaddedevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: AnnotationAddedEvent - Go SDK -sidebarTitle: AnnotationAddedEvent -description: AnnotationAddedEvent type definition -seoTitle: AnnotationAddedEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/annotationaddedevent' -'og:site_name': OpenRouter Documentation -'og:title': AnnotationAddedEvent Type | OpenRouter Go SDK -'og:description': >- - AnnotationAddedEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnnotationAddedEvent%20-%20Go%20SDK&description=AnnotationAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a text annotation is added to output - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Annotation` | [components.OpenAIResponsesAnnotation](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/annotationaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/annotationaddedeventtype.mdx b/client-sdks/go/api-reference/models/annotationaddedeventtype.mdx deleted file mode 100644 index 3ecddc67..00000000 --- a/client-sdks/go/api-reference/models/annotationaddedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnnotationAddedEventType - Go SDK -sidebarTitle: AnnotationAddedEventType -description: AnnotationAddedEventType type definition -seoTitle: AnnotationAddedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/annotationaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': AnnotationAddedEventType Type | OpenRouter Go SDK -'og:description': >- - AnnotationAddedEventType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnnotationAddedEventType%20-%20Go%20SDK&description=AnnotationAddedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnnotationAddedEventTypeResponseOutputTextAnnotationAdded -``` - -## Values - -| Name | Value | -| ----------------------------------------------------------- | ----------------------------------------------------------- | -| `AnnotationAddedEventTypeResponseOutputTextAnnotationAdded` | response.output_text.annotation.added | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicallowedcallers.mdx b/client-sdks/go/api-reference/models/anthropicallowedcallers.mdx deleted file mode 100644 index 8b19e4c0..00000000 --- a/client-sdks/go/api-reference/models/anthropicallowedcallers.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: AnthropicAllowedCallers - Go SDK -sidebarTitle: AnthropicAllowedCallers -description: AnthropicAllowedCallers type definition -seoTitle: AnthropicAllowedCallers Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicallowedcallers -'og:site_name': OpenRouter Documentation -'og:title': AnthropicAllowedCallers Type | OpenRouter Go SDK -'og:description': >- - AnthropicAllowedCallers type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicAllowedCallers%20-%20Go%20SDK&description=AnthropicAllowedCallers%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicAllowedCallersDirect - -// Open enum: custom values can be created with a direct type cast -custom := components.AnthropicAllowedCallers("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `AnthropicAllowedCallersDirect` | direct | -| `AnthropicAllowedCallersCodeExecution20250825` | code_execution_20250825 | -| `AnthropicAllowedCallersCodeExecution20260120` | code_execution_20260120 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicbase64imagesource.mdx b/client-sdks/go/api-reference/models/anthropicbase64imagesource.mdx deleted file mode 100644 index 514ea1f0..00000000 --- a/client-sdks/go/api-reference/models/anthropicbase64imagesource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicBase64ImageSource - Go SDK -sidebarTitle: AnthropicBase64ImageSource -description: AnthropicBase64ImageSource type definition -seoTitle: AnthropicBase64ImageSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicbase64imagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64ImageSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicBase64ImageSource type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64ImageSource%20-%20Go%20SDK&description=AnthropicBase64ImageSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | | -| `MediaType` | [components.AnthropicImageMimeType](/client-sdks/go/api-reference/models/anthropicimagemimetype) | :heavy_check_mark: | N/A | image/jpeg | -| `Type` | [components.AnthropicBase64ImageSourceType](/client-sdks/go/api-reference/models/anthropicbase64imagesourcetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicbase64imagesourcetype.mdx b/client-sdks/go/api-reference/models/anthropicbase64imagesourcetype.mdx deleted file mode 100644 index 1160f010..00000000 --- a/client-sdks/go/api-reference/models/anthropicbase64imagesourcetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicBase64ImageSourceType - Go SDK -sidebarTitle: AnthropicBase64ImageSourceType -description: AnthropicBase64ImageSourceType type definition -seoTitle: AnthropicBase64ImageSourceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicbase64imagesourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64ImageSourceType Type | OpenRouter Go SDK -'og:description': >- - AnthropicBase64ImageSourceType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64ImageSourceType%20-%20Go%20SDK&description=AnthropicBase64ImageSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicBase64ImageSourceTypeBase64 -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `AnthropicBase64ImageSourceTypeBase64` | base64 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicbase64pdfsource.mdx b/client-sdks/go/api-reference/models/anthropicbase64pdfsource.mdx deleted file mode 100644 index 35abc91a..00000000 --- a/client-sdks/go/api-reference/models/anthropicbase64pdfsource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicBase64PdfSource - Go SDK -sidebarTitle: AnthropicBase64PdfSource -description: AnthropicBase64PdfSource type definition -seoTitle: AnthropicBase64PdfSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicbase64pdfsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicBase64PdfSource type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSource%20-%20Go%20SDK&description=AnthropicBase64PdfSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](/client-sdks/go/api-reference/models/anthropicbase64pdfsourcemediatype) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBase64PdfSourceType](/client-sdks/go/api-reference/models/anthropicbase64pdfsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicbase64pdfsourcemediatype.mdx b/client-sdks/go/api-reference/models/anthropicbase64pdfsourcemediatype.mdx deleted file mode 100644 index b8dbf6c7..00000000 --- a/client-sdks/go/api-reference/models/anthropicbase64pdfsourcemediatype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicBase64PdfSourceMediaType - Go SDK -sidebarTitle: AnthropicBase64PdfSourceMediaType -description: AnthropicBase64PdfSourceMediaType type definition -seoTitle: AnthropicBase64PdfSourceMediaType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicbase64pdfsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSourceMediaType Type | OpenRouter Go SDK -'og:description': >- - AnthropicBase64PdfSourceMediaType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSourceMediaType%20-%20Go%20SDK&description=AnthropicBase64PdfSourceMediaType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicBase64PdfSourceMediaTypeApplicationPdf -``` - -## Values - -| Name | Value | -| ------------------------------------------------- | ------------------------------------------------- | -| `AnthropicBase64PdfSourceMediaTypeApplicationPdf` | application/pdf | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicbase64pdfsourcetype.mdx b/client-sdks/go/api-reference/models/anthropicbase64pdfsourcetype.mdx deleted file mode 100644 index 15302f30..00000000 --- a/client-sdks/go/api-reference/models/anthropicbase64pdfsourcetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicBase64PdfSourceType - Go SDK -sidebarTitle: AnthropicBase64PdfSourceType -description: AnthropicBase64PdfSourceType type definition -seoTitle: AnthropicBase64PdfSourceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicbase64pdfsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSourceType Type | OpenRouter Go SDK -'og:description': >- - AnthropicBase64PdfSourceType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSourceType%20-%20Go%20SDK&description=AnthropicBase64PdfSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicBase64PdfSourceTypeBase64 -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `AnthropicBase64PdfSourceTypeBase64` | base64 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccachecontroldirective.mdx b/client-sdks/go/api-reference/models/anthropiccachecontroldirective.mdx deleted file mode 100644 index 22504aa1..00000000 --- a/client-sdks/go/api-reference/models/anthropiccachecontroldirective.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AnthropicCacheControlDirective - Go SDK -sidebarTitle: AnthropicCacheControlDirective -description: AnthropicCacheControlDirective type definition -seoTitle: AnthropicCacheControlDirective Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccachecontroldirective -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirective Type | OpenRouter Go SDK -'og:description': >- - AnthropicCacheControlDirective type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirective%20-%20Go%20SDK&description=AnthropicCacheControlDirective%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `TTL` | [*components.AnthropicCacheControlTTL](/client-sdks/go/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.AnthropicCacheControlDirectiveType](/client-sdks/go/api-reference/models/anthropiccachecontroldirectivetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccachecontroldirectivetype.mdx b/client-sdks/go/api-reference/models/anthropiccachecontroldirectivetype.mdx deleted file mode 100644 index 4c36b3bf..00000000 --- a/client-sdks/go/api-reference/models/anthropiccachecontroldirectivetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCacheControlDirectiveType - Go SDK -sidebarTitle: AnthropicCacheControlDirectiveType -description: AnthropicCacheControlDirectiveType type definition -seoTitle: AnthropicCacheControlDirectiveType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccachecontroldirectivetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirectiveType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCacheControlDirectiveType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirectiveType%20-%20Go%20SDK&description=AnthropicCacheControlDirectiveType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCacheControlDirectiveTypeEphemeral -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `AnthropicCacheControlDirectiveTypeEphemeral` | ephemeral | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccachecontrolttl.mdx b/client-sdks/go/api-reference/models/anthropiccachecontrolttl.mdx deleted file mode 100644 index 2b54d0ed..00000000 --- a/client-sdks/go/api-reference/models/anthropiccachecontrolttl.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicCacheControlTTL - Go SDK -sidebarTitle: AnthropicCacheControlTTL -description: AnthropicCacheControlTTL type definition -seoTitle: AnthropicCacheControlTTL Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccachecontrolttl -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlTTL Type | OpenRouter Go SDK -'og:description': >- - AnthropicCacheControlTTL type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlTTL%20-%20Go%20SDK&description=AnthropicCacheControlTTL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCacheControlTTLFivem - -// Open enum: custom values can be created with a direct type cast -custom := components.AnthropicCacheControlTTL("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `AnthropicCacheControlTTLFivem` | 5m | -| `AnthropicCacheControlTTLOneh` | 1h | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationcharlocationparam.mdx b/client-sdks/go/api-reference/models/anthropiccitationcharlocationparam.mdx deleted file mode 100644 index 2cd78cbc..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationcharlocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationCharLocationParam - Go SDK -sidebarTitle: AnthropicCitationCharLocationParam -description: AnthropicCitationCharLocationParam type definition -seoTitle: AnthropicCitationCharLocationParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationcharlocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationCharLocationParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationCharLocationParam type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationCharLocationParam%20-%20Go%20SDK&description=AnthropicCitationCharLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationCharLocationParamType](/client-sdks/go/api-reference/models/anthropiccitationcharlocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationcharlocationparamtype.mdx b/client-sdks/go/api-reference/models/anthropiccitationcharlocationparamtype.mdx deleted file mode 100644 index e4b8cc8c..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationcharlocationparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCitationCharLocationParamType - Go SDK -sidebarTitle: AnthropicCitationCharLocationParamType -description: AnthropicCitationCharLocationParamType type definition -seoTitle: AnthropicCitationCharLocationParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationcharlocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationCharLocationParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationCharLocationParamType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationCharLocationParamType%20-%20Go%20SDK&description=AnthropicCitationCharLocationParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCitationCharLocationParamTypeCharLocation -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `AnthropicCitationCharLocationParamTypeCharLocation` | char_location | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparam.mdx b/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparam.mdx deleted file mode 100644 index 2a55bbbc..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationContentBlockLocationParam - Go SDK -sidebarTitle: AnthropicCitationContentBlockLocationParam -description: AnthropicCitationContentBlockLocationParam type definition -seoTitle: AnthropicCitationContentBlockLocationParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationcontentblocklocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationContentBlockLocationParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationContentBlockLocationParam type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationContentBlockLocationParam%20-%20Go%20SDK&description=AnthropicCitationContentBlockLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationParamType](/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparamtype.mdx b/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparamtype.mdx deleted file mode 100644 index dfab27de..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationcontentblocklocationparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCitationContentBlockLocationParamType - Go SDK -sidebarTitle: AnthropicCitationContentBlockLocationParamType -description: AnthropicCitationContentBlockLocationParamType type definition -seoTitle: AnthropicCitationContentBlockLocationParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationcontentblocklocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationContentBlockLocationParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationContentBlockLocationParamType type reference for the - OpenRouter Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationContentBlockLocationParamType%20-%20Go%20SDK&description=AnthropicCitationContentBlockLocationParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCitationContentBlockLocationParamTypeContentBlockLocation -``` - -## Values - -| Name | Value | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `AnthropicCitationContentBlockLocationParamTypeContentBlockLocation` | content_block_location | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationpagelocationparam.mdx b/client-sdks/go/api-reference/models/anthropiccitationpagelocationparam.mdx deleted file mode 100644 index 4f3450f1..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationpagelocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationPageLocationParam - Go SDK -sidebarTitle: AnthropicCitationPageLocationParam -description: AnthropicCitationPageLocationParam type definition -seoTitle: AnthropicCitationPageLocationParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationpagelocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationPageLocationParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationPageLocationParam type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationPageLocationParam%20-%20Go%20SDK&description=AnthropicCitationPageLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `DocumentIndex` | `int64` | :heavy_check_mark: | N/A | -| `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | -| `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationPageLocationParamType](/client-sdks/go/api-reference/models/anthropiccitationpagelocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationpagelocationparamtype.mdx b/client-sdks/go/api-reference/models/anthropiccitationpagelocationparamtype.mdx deleted file mode 100644 index d2470fba..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationpagelocationparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCitationPageLocationParamType - Go SDK -sidebarTitle: AnthropicCitationPageLocationParamType -description: AnthropicCitationPageLocationParamType type definition -seoTitle: AnthropicCitationPageLocationParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationpagelocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationPageLocationParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationPageLocationParamType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationPageLocationParamType%20-%20Go%20SDK&description=AnthropicCitationPageLocationParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCitationPageLocationParamTypePageLocation -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `AnthropicCitationPageLocationParamTypePageLocation` | page_location | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocation.mdx b/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocation.mdx deleted file mode 100644 index 71938b80..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocation.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: AnthropicCitationSearchResultLocation - Go SDK -sidebarTitle: AnthropicCitationSearchResultLocation -description: AnthropicCitationSearchResultLocation type definition -seoTitle: AnthropicCitationSearchResultLocation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationSearchResultLocation Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationSearchResultLocation type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationSearchResultLocation%20-%20Go%20SDK&description=AnthropicCitationSearchResultLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `SearchResultIndex` | `int64` | :heavy_check_mark: | N/A | -| `Source` | `string` | :heavy_check_mark: | N/A | -| `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationType](/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocationtype.mdx b/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocationtype.mdx deleted file mode 100644 index c1474491..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationsearchresultlocationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCitationSearchResultLocationType - Go SDK -sidebarTitle: AnthropicCitationSearchResultLocationType -description: AnthropicCitationSearchResultLocationType type definition -seoTitle: AnthropicCitationSearchResultLocationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationsearchresultlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationSearchResultLocationType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationSearchResultLocationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationSearchResultLocationType%20-%20Go%20SDK&description=AnthropicCitationSearchResultLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCitationSearchResultLocationTypeSearchResultLocation -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------- | --------------------------------------------------------------- | -| `AnthropicCitationSearchResultLocationTypeSearchResultLocation` | search_result_location | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocation.mdx b/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocation.mdx deleted file mode 100644 index faf5b03a..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicCitationWebSearchResultLocation - Go SDK -sidebarTitle: AnthropicCitationWebSearchResultLocation -description: AnthropicCitationWebSearchResultLocation type definition -seoTitle: AnthropicCitationWebSearchResultLocation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationwebsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationWebSearchResultLocation Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationWebSearchResultLocation type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationWebSearchResultLocation%20-%20Go%20SDK&description=AnthropicCitationWebSearchResultLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `CitedText` | `string` | :heavy_check_mark: | N/A | -| `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | -| `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationType](/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocationtype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocationtype.mdx b/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocationtype.mdx deleted file mode 100644 index 5bf152ef..00000000 --- a/client-sdks/go/api-reference/models/anthropiccitationwebsearchresultlocationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCitationWebSearchResultLocationType - Go SDK -sidebarTitle: AnthropicCitationWebSearchResultLocationType -description: AnthropicCitationWebSearchResultLocationType type definition -seoTitle: AnthropicCitationWebSearchResultLocationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropiccitationwebsearchresultlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationWebSearchResultLocationType Type | OpenRouter Go SDK -'og:description': >- - AnthropicCitationWebSearchResultLocationType type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationWebSearchResultLocationType%20-%20Go%20SDK&description=AnthropicCitationWebSearchResultLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicCitationWebSearchResultLocationTypeWebSearchResultLocation -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `AnthropicCitationWebSearchResultLocationTypeWebSearchResultLocation` | web_search_result_location | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicdocumentblockparam.mdx b/client-sdks/go/api-reference/models/anthropicdocumentblockparam.mdx deleted file mode 100644 index f99e283d..00000000 --- a/client-sdks/go/api-reference/models/anthropicdocumentblockparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicDocumentBlockParam - Go SDK -sidebarTitle: AnthropicDocumentBlockParam -description: AnthropicDocumentBlockParam type definition -seoTitle: AnthropicDocumentBlockParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicdocumentblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicDocumentBlockParam type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParam%20-%20Go%20SDK&description=AnthropicDocumentBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Citations` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](/client-sdks/go/api-reference/models/anthropicdocumentblockparamcitations)] | :heavy_minus_sign: | N/A | | -| `Context` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](/client-sdks/go/api-reference/models/anthropicdocumentblockparamsourceunion) | :heavy_check_mark: | N/A | | -| `Title` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.TypeDocument](/client-sdks/go/api-reference/models/typedocument) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcitations.mdx b/client-sdks/go/api-reference/models/anthropicdocumentblockparamcitations.mdx deleted file mode 100644 index 7e60d45e..00000000 --- a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcitations.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicDocumentBlockParamCitations - Go SDK -sidebarTitle: AnthropicDocumentBlockParamCitations -description: AnthropicDocumentBlockParamCitations type definition -seoTitle: AnthropicDocumentBlockParamCitations Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicdocumentblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamCitations Type | OpenRouter Go SDK -'og:description': >- - AnthropicDocumentBlockParamCitations type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamCitations%20-%20Go%20SDK&description=AnthropicDocumentBlockParamCitations%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent1.mdx b/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent1.mdx deleted file mode 100644 index ee75f99a..00000000 --- a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent1.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent1 - Go SDK -sidebarTitle: AnthropicDocumentBlockParamContent1 -description: AnthropicDocumentBlockParamContent1 type definition -seoTitle: AnthropicDocumentBlockParamContent1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicdocumentblockparamcontent1 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent1 Type | OpenRouter Go SDK -'og:description': >- - AnthropicDocumentBlockParamContent1 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent1%20-%20Go%20SDK&description=AnthropicDocumentBlockParamContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicImageBlockParam - -```go lines -anthropicDocumentBlockParamContent1 := components.CreateAnthropicDocumentBlockParamContent1Image(components.AnthropicImageBlockParam{/* values here */}) -``` - -### AnthropicTextBlockParam - -```go lines -anthropicDocumentBlockParamContent1 := components.CreateAnthropicDocumentBlockParamContent1Text(components.AnthropicTextBlockParam{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch anthropicDocumentBlockParamContent1.Type { - case components.AnthropicDocumentBlockParamContent1TypeImage: - // anthropicDocumentBlockParamContent1.AnthropicImageBlockParam is populated - case components.AnthropicDocumentBlockParamContent1TypeText: - // anthropicDocumentBlockParamContent1.AnthropicTextBlockParam is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent2.mdx b/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent2.mdx deleted file mode 100644 index 49224c9e..00000000 --- a/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent2 - Go SDK -sidebarTitle: AnthropicDocumentBlockParamContent2 -description: AnthropicDocumentBlockParamContent2 type definition -seoTitle: AnthropicDocumentBlockParamContent2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicdocumentblockparamcontent2 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent2 Type | OpenRouter Go SDK -'og:description': >- - AnthropicDocumentBlockParamContent2 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent2%20-%20Go%20SDK&description=AnthropicDocumentBlockParamContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -anthropicDocumentBlockParamContent2 := components.CreateAnthropicDocumentBlockParamContent2Str(string{/* values here */}) -``` - -### - -```go lines -anthropicDocumentBlockParamContent2 := components.CreateAnthropicDocumentBlockParamContent2ArrayOfAnthropicDocumentBlockParamContent1([]components.AnthropicDocumentBlockParamContent1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch anthropicDocumentBlockParamContent2.Type { - case components.AnthropicDocumentBlockParamContent2TypeStr: - // anthropicDocumentBlockParamContent2.Str is populated - case components.AnthropicDocumentBlockParamContent2TypeArrayOfAnthropicDocumentBlockParamContent1: - // anthropicDocumentBlockParamContent2.ArrayOfAnthropicDocumentBlockParamContent1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicdocumentblockparamsourceunion.mdx b/client-sdks/go/api-reference/models/anthropicdocumentblockparamsourceunion.mdx deleted file mode 100644 index 9e949f3b..00000000 --- a/client-sdks/go/api-reference/models/anthropicdocumentblockparamsourceunion.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: AnthropicDocumentBlockParamSourceUnion - Go SDK -sidebarTitle: AnthropicDocumentBlockParamSourceUnion -description: AnthropicDocumentBlockParamSourceUnion type definition -seoTitle: AnthropicDocumentBlockParamSourceUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicdocumentblockparamsourceunion -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamSourceUnion Type | OpenRouter Go SDK -'og:description': >- - AnthropicDocumentBlockParamSourceUnion type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamSourceUnion%20-%20Go%20SDK&description=AnthropicDocumentBlockParamSourceUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicBase64PdfSource - -```go lines -anthropicDocumentBlockParamSourceUnion := components.CreateAnthropicDocumentBlockParamSourceUnionBase64(components.AnthropicBase64PdfSource{/* values here */}) -``` - -### AnthropicPlainTextSource - -```go lines -anthropicDocumentBlockParamSourceUnion := components.CreateAnthropicDocumentBlockParamSourceUnionText(components.AnthropicPlainTextSource{/* values here */}) -``` - -### SourceContent - -```go lines -anthropicDocumentBlockParamSourceUnion := components.CreateAnthropicDocumentBlockParamSourceUnionContent(components.SourceContent{/* values here */}) -``` - -### AnthropicURLPdfSource - -```go lines -anthropicDocumentBlockParamSourceUnion := components.CreateAnthropicDocumentBlockParamSourceUnionURLObj(components.AnthropicURLPdfSource{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch anthropicDocumentBlockParamSourceUnion.Type { - case components.AnthropicDocumentBlockParamSourceUnionTypeBase64: - // anthropicDocumentBlockParamSourceUnion.AnthropicBase64PdfSource is populated - case components.AnthropicDocumentBlockParamSourceUnionTypeText: - // anthropicDocumentBlockParamSourceUnion.AnthropicPlainTextSource is populated - case components.AnthropicDocumentBlockParamSourceUnionTypeContent: - // anthropicDocumentBlockParamSourceUnion.SourceContent is populated - case components.AnthropicDocumentBlockParamSourceUnionTypeURLObj: - // anthropicDocumentBlockParamSourceUnion.AnthropicURLPdfSource is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicimageblockparam.mdx b/client-sdks/go/api-reference/models/anthropicimageblockparam.mdx deleted file mode 100644 index 0db19b12..00000000 --- a/client-sdks/go/api-reference/models/anthropicimageblockparam.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicImageBlockParam - Go SDK -sidebarTitle: AnthropicImageBlockParam -description: AnthropicImageBlockParam type definition -seoTitle: AnthropicImageBlockParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicimageblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicImageBlockParam type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParam%20-%20Go%20SDK&description=AnthropicImageBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Source` | [components.AnthropicImageBlockParamSource](/client-sdks/go/api-reference/models/anthropicimageblockparamsource) | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicImageBlockParamType](/client-sdks/go/api-reference/models/anthropicimageblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicimageblockparamsource.mdx b/client-sdks/go/api-reference/models/anthropicimageblockparamsource.mdx deleted file mode 100644 index e4992a3a..00000000 --- a/client-sdks/go/api-reference/models/anthropicimageblockparamsource.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AnthropicImageBlockParamSource - Go SDK -sidebarTitle: AnthropicImageBlockParamSource -description: AnthropicImageBlockParamSource type definition -seoTitle: AnthropicImageBlockParamSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicimageblockparamsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParamSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicImageBlockParamSource type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParamSource%20-%20Go%20SDK&description=AnthropicImageBlockParamSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicBase64ImageSource - -```go lines -anthropicImageBlockParamSource := components.CreateAnthropicImageBlockParamSourceBase64(components.AnthropicBase64ImageSource{/* values here */}) -``` - -### AnthropicURLImageSource - -```go lines -anthropicImageBlockParamSource := components.CreateAnthropicImageBlockParamSourceURLObj(components.AnthropicURLImageSource{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch anthropicImageBlockParamSource.Type { - case components.AnthropicImageBlockParamSourceTypeBase64: - // anthropicImageBlockParamSource.AnthropicBase64ImageSource is populated - case components.AnthropicImageBlockParamSourceTypeURLObj: - // anthropicImageBlockParamSource.AnthropicURLImageSource is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicimageblockparamtype.mdx b/client-sdks/go/api-reference/models/anthropicimageblockparamtype.mdx deleted file mode 100644 index 98bd6b53..00000000 --- a/client-sdks/go/api-reference/models/anthropicimageblockparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicImageBlockParamType - Go SDK -sidebarTitle: AnthropicImageBlockParamType -description: AnthropicImageBlockParamType type definition -seoTitle: AnthropicImageBlockParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicimageblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicImageBlockParamType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParamType%20-%20Go%20SDK&description=AnthropicImageBlockParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicImageBlockParamTypeImage -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `AnthropicImageBlockParamTypeImage` | image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicimagemimetype.mdx b/client-sdks/go/api-reference/models/anthropicimagemimetype.mdx deleted file mode 100644 index 58c2baf2..00000000 --- a/client-sdks/go/api-reference/models/anthropicimagemimetype.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: AnthropicImageMimeType - Go SDK -sidebarTitle: AnthropicImageMimeType -description: AnthropicImageMimeType type definition -seoTitle: AnthropicImageMimeType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/anthropicimagemimetype' -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageMimeType Type | OpenRouter Go SDK -'og:description': >- - AnthropicImageMimeType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageMimeType%20-%20Go%20SDK&description=AnthropicImageMimeType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicImageMimeTypeImageJpeg - -// Open enum: custom values can be created with a direct type cast -custom := components.AnthropicImageMimeType("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `AnthropicImageMimeTypeImageJpeg` | image/jpeg | -| `AnthropicImageMimeTypeImagePng` | image/png | -| `AnthropicImageMimeTypeImageGif` | image/gif | -| `AnthropicImageMimeTypeImageWebp` | image/webp | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicinputtokensclearatleast.mdx b/client-sdks/go/api-reference/models/anthropicinputtokensclearatleast.mdx deleted file mode 100644 index d6a63487..00000000 --- a/client-sdks/go/api-reference/models/anthropicinputtokensclearatleast.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeast - Go SDK -sidebarTitle: AnthropicInputTokensClearAtLeast -description: AnthropicInputTokensClearAtLeast type definition -seoTitle: AnthropicInputTokensClearAtLeast Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicinputtokensclearatleast -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeast Type | OpenRouter Go SDK -'og:description': >- - AnthropicInputTokensClearAtLeast type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeast%20-%20Go%20SDK&description=AnthropicInputTokensClearAtLeast%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicInputTokensClearAtLeastType](/client-sdks/go/api-reference/models/anthropicinputtokensclearatleasttype) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicinputtokensclearatleasttype.mdx b/client-sdks/go/api-reference/models/anthropicinputtokensclearatleasttype.mdx deleted file mode 100644 index 4db7ccf8..00000000 --- a/client-sdks/go/api-reference/models/anthropicinputtokensclearatleasttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeastType - Go SDK -sidebarTitle: AnthropicInputTokensClearAtLeastType -description: AnthropicInputTokensClearAtLeastType type definition -seoTitle: AnthropicInputTokensClearAtLeastType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicinputtokensclearatleasttype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeastType Type | OpenRouter Go SDK -'og:description': >- - AnthropicInputTokensClearAtLeastType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeastType%20-%20Go%20SDK&description=AnthropicInputTokensClearAtLeastType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicInputTokensClearAtLeastTypeInputTokens -``` - -## Values - -| Name | Value | -| ------------------------------------------------- | ------------------------------------------------- | -| `AnthropicInputTokensClearAtLeastTypeInputTokens` | input_tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicinputtokenstrigger.mdx b/client-sdks/go/api-reference/models/anthropicinputtokenstrigger.mdx deleted file mode 100644 index 26bcc396..00000000 --- a/client-sdks/go/api-reference/models/anthropicinputtokenstrigger.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicInputTokensTrigger - Go SDK -sidebarTitle: AnthropicInputTokensTrigger -description: AnthropicInputTokensTrigger type definition -seoTitle: AnthropicInputTokensTrigger Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicinputtokenstrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensTrigger Type | OpenRouter Go SDK -'og:description': >- - AnthropicInputTokensTrigger type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensTrigger%20-%20Go%20SDK&description=AnthropicInputTokensTrigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicInputTokensTriggerType](/client-sdks/go/api-reference/models/anthropicinputtokenstriggertype) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicinputtokenstriggertype.mdx b/client-sdks/go/api-reference/models/anthropicinputtokenstriggertype.mdx deleted file mode 100644 index 19ac84c3..00000000 --- a/client-sdks/go/api-reference/models/anthropicinputtokenstriggertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicInputTokensTriggerType - Go SDK -sidebarTitle: AnthropicInputTokensTriggerType -description: AnthropicInputTokensTriggerType type definition -seoTitle: AnthropicInputTokensTriggerType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicinputtokenstriggertype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensTriggerType Type | OpenRouter Go SDK -'og:description': >- - AnthropicInputTokensTriggerType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensTriggerType%20-%20Go%20SDK&description=AnthropicInputTokensTriggerType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicInputTokensTriggerTypeInputTokens -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `AnthropicInputTokensTriggerTypeInputTokens` | input_tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicplaintextsource.mdx b/client-sdks/go/api-reference/models/anthropicplaintextsource.mdx deleted file mode 100644 index f43c2752..00000000 --- a/client-sdks/go/api-reference/models/anthropicplaintextsource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicPlainTextSource - Go SDK -sidebarTitle: AnthropicPlainTextSource -description: AnthropicPlainTextSource type definition -seoTitle: AnthropicPlainTextSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicplaintextsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicPlainTextSource type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSource%20-%20Go%20SDK&description=AnthropicPlainTextSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicPlainTextSourceMediaType](/client-sdks/go/api-reference/models/anthropicplaintextsourcemediatype) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicPlainTextSourceType](/client-sdks/go/api-reference/models/anthropicplaintextsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicplaintextsourcemediatype.mdx b/client-sdks/go/api-reference/models/anthropicplaintextsourcemediatype.mdx deleted file mode 100644 index 8088bfd3..00000000 --- a/client-sdks/go/api-reference/models/anthropicplaintextsourcemediatype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicPlainTextSourceMediaType - Go SDK -sidebarTitle: AnthropicPlainTextSourceMediaType -description: AnthropicPlainTextSourceMediaType type definition -seoTitle: AnthropicPlainTextSourceMediaType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicplaintextsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSourceMediaType Type | OpenRouter Go SDK -'og:description': >- - AnthropicPlainTextSourceMediaType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSourceMediaType%20-%20Go%20SDK&description=AnthropicPlainTextSourceMediaType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicPlainTextSourceMediaTypeTextPlain -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `AnthropicPlainTextSourceMediaTypeTextPlain` | text/plain | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicplaintextsourcetype.mdx b/client-sdks/go/api-reference/models/anthropicplaintextsourcetype.mdx deleted file mode 100644 index 9bb88da2..00000000 --- a/client-sdks/go/api-reference/models/anthropicplaintextsourcetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicPlainTextSourceType - Go SDK -sidebarTitle: AnthropicPlainTextSourceType -description: AnthropicPlainTextSourceType type definition -seoTitle: AnthropicPlainTextSourceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicplaintextsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSourceType Type | OpenRouter Go SDK -'og:description': >- - AnthropicPlainTextSourceType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSourceType%20-%20Go%20SDK&description=AnthropicPlainTextSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicPlainTextSourceTypeText -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `AnthropicPlainTextSourceTypeText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicsearchresultblockparam.mdx b/client-sdks/go/api-reference/models/anthropicsearchresultblockparam.mdx deleted file mode 100644 index 308c17b0..00000000 --- a/client-sdks/go/api-reference/models/anthropicsearchresultblockparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicSearchResultBlockParam - Go SDK -sidebarTitle: AnthropicSearchResultBlockParam -description: AnthropicSearchResultBlockParam type definition -seoTitle: AnthropicSearchResultBlockParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicSearchResultBlockParam type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParam%20-%20Go%20SDK&description=AnthropicSearchResultBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Citations` | [*components.AnthropicSearchResultBlockParamCitations](/client-sdks/go/api-reference/models/anthropicsearchresultblockparamcitations) | :heavy_minus_sign: | N/A | | -| `Content` | [][components.AnthropicTextBlockParam](/client-sdks/go/api-reference/models/anthropictextblockparam) | :heavy_check_mark: | N/A | | -| `Source` | `string` | :heavy_check_mark: | N/A | | -| `Title` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicSearchResultBlockParamType](/client-sdks/go/api-reference/models/anthropicsearchresultblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicsearchresultblockparamcitations.mdx b/client-sdks/go/api-reference/models/anthropicsearchresultblockparamcitations.mdx deleted file mode 100644 index e91afd51..00000000 --- a/client-sdks/go/api-reference/models/anthropicsearchresultblockparamcitations.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicSearchResultBlockParamCitations - Go SDK -sidebarTitle: AnthropicSearchResultBlockParamCitations -description: AnthropicSearchResultBlockParamCitations type definition -seoTitle: AnthropicSearchResultBlockParamCitations Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicsearchresultblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParamCitations Type | OpenRouter Go SDK -'og:description': >- - AnthropicSearchResultBlockParamCitations type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParamCitations%20-%20Go%20SDK&description=AnthropicSearchResultBlockParamCitations%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicsearchresultblockparamtype.mdx b/client-sdks/go/api-reference/models/anthropicsearchresultblockparamtype.mdx deleted file mode 100644 index e041280f..00000000 --- a/client-sdks/go/api-reference/models/anthropicsearchresultblockparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicSearchResultBlockParamType - Go SDK -sidebarTitle: AnthropicSearchResultBlockParamType -description: AnthropicSearchResultBlockParamType type definition -seoTitle: AnthropicSearchResultBlockParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicsearchresultblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicSearchResultBlockParamType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParamType%20-%20Go%20SDK&description=AnthropicSearchResultBlockParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicSearchResultBlockParamTypeSearchResult -``` - -## Values - -| Name | Value | -| ------------------------------------------------- | ------------------------------------------------- | -| `AnthropicSearchResultBlockParamTypeSearchResult` | search_result | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictextblockparam.mdx b/client-sdks/go/api-reference/models/anthropictextblockparam.mdx deleted file mode 100644 index db607bc7..00000000 --- a/client-sdks/go/api-reference/models/anthropictextblockparam.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AnthropicTextBlockParam - Go SDK -sidebarTitle: AnthropicTextBlockParam -description: AnthropicTextBlockParam type definition -seoTitle: AnthropicTextBlockParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropictextblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicTextBlockParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicTextBlockParam type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicTextBlockParam%20-%20Go%20SDK&description=AnthropicTextBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Citations` | optionalnullable.OptionalNullable[[][components.Citation](/client-sdks/go/api-reference/models/citation)] | :heavy_minus_sign: | N/A | | -| `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicTextBlockParamType](/client-sdks/go/api-reference/models/anthropictextblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictextblockparamtype.mdx b/client-sdks/go/api-reference/models/anthropictextblockparamtype.mdx deleted file mode 100644 index ba6b1b04..00000000 --- a/client-sdks/go/api-reference/models/anthropictextblockparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicTextBlockParamType - Go SDK -sidebarTitle: AnthropicTextBlockParamType -description: AnthropicTextBlockParamType type definition -seoTitle: AnthropicTextBlockParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropictextblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicTextBlockParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicTextBlockParamType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicTextBlockParamType%20-%20Go%20SDK&description=AnthropicTextBlockParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicTextBlockParamTypeText -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `AnthropicTextBlockParamTypeText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicthinkingdisplay.mdx b/client-sdks/go/api-reference/models/anthropicthinkingdisplay.mdx deleted file mode 100644 index fa0aac40..00000000 --- a/client-sdks/go/api-reference/models/anthropicthinkingdisplay.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicThinkingDisplay - Go SDK -sidebarTitle: AnthropicThinkingDisplay -description: AnthropicThinkingDisplay type definition -seoTitle: AnthropicThinkingDisplay Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicthinkingdisplay -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingDisplay Type | OpenRouter Go SDK -'og:description': >- - AnthropicThinkingDisplay type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingDisplay%20-%20Go%20SDK&description=AnthropicThinkingDisplay%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicThinkingDisplaySummarized - -// Open enum: custom values can be created with a direct type cast -custom := components.AnthropicThinkingDisplay("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `AnthropicThinkingDisplaySummarized` | summarized | -| `AnthropicThinkingDisplayOmitted` | omitted | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicthinkingturns.mdx b/client-sdks/go/api-reference/models/anthropicthinkingturns.mdx deleted file mode 100644 index bd6e7492..00000000 --- a/client-sdks/go/api-reference/models/anthropicthinkingturns.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicThinkingTurns - Go SDK -sidebarTitle: AnthropicThinkingTurns -description: AnthropicThinkingTurns type definition -seoTitle: AnthropicThinkingTurns Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/anthropicthinkingturns' -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurns Type | OpenRouter Go SDK -'og:description': >- - AnthropicThinkingTurns type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurns%20-%20Go%20SDK&description=AnthropicThinkingTurns%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicThinkingTurnsType](/client-sdks/go/api-reference/models/anthropicthinkingturnstype) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicthinkingturnstype.mdx b/client-sdks/go/api-reference/models/anthropicthinkingturnstype.mdx deleted file mode 100644 index dc882af9..00000000 --- a/client-sdks/go/api-reference/models/anthropicthinkingturnstype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicThinkingTurnsType - Go SDK -sidebarTitle: AnthropicThinkingTurnsType -description: AnthropicThinkingTurnsType type definition -seoTitle: AnthropicThinkingTurnsType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicthinkingturnstype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurnsType Type | OpenRouter Go SDK -'og:description': >- - AnthropicThinkingTurnsType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurnsType%20-%20Go%20SDK&description=AnthropicThinkingTurnsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicThinkingTurnsTypeThinkingTurns -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `AnthropicThinkingTurnsTypeThinkingTurns` | thinking_turns | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictooluseskeep.mdx b/client-sdks/go/api-reference/models/anthropictooluseskeep.mdx deleted file mode 100644 index 450ed044..00000000 --- a/client-sdks/go/api-reference/models/anthropictooluseskeep.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicToolUsesKeep - Go SDK -sidebarTitle: AnthropicToolUsesKeep -description: AnthropicToolUsesKeep type definition -seoTitle: AnthropicToolUsesKeep Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/anthropictooluseskeep' -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeep Type | OpenRouter Go SDK -'og:description': >- - AnthropicToolUsesKeep type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeep%20-%20Go%20SDK&description=AnthropicToolUsesKeep%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesKeepType](/client-sdks/go/api-reference/models/anthropictooluseskeeptype) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictooluseskeeptype.mdx b/client-sdks/go/api-reference/models/anthropictooluseskeeptype.mdx deleted file mode 100644 index 15310980..00000000 --- a/client-sdks/go/api-reference/models/anthropictooluseskeeptype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicToolUsesKeepType - Go SDK -sidebarTitle: AnthropicToolUsesKeepType -description: AnthropicToolUsesKeepType type definition -seoTitle: AnthropicToolUsesKeepType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropictooluseskeeptype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeepType Type | OpenRouter Go SDK -'og:description': >- - AnthropicToolUsesKeepType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeepType%20-%20Go%20SDK&description=AnthropicToolUsesKeepType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicToolUsesKeepTypeToolUses -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `AnthropicToolUsesKeepTypeToolUses` | tool_uses | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictoolusestrigger.mdx b/client-sdks/go/api-reference/models/anthropictoolusestrigger.mdx deleted file mode 100644 index c6a03607..00000000 --- a/client-sdks/go/api-reference/models/anthropictoolusestrigger.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicToolUsesTrigger - Go SDK -sidebarTitle: AnthropicToolUsesTrigger -description: AnthropicToolUsesTrigger type definition -seoTitle: AnthropicToolUsesTrigger Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropictoolusestrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesTrigger Type | OpenRouter Go SDK -'og:description': >- - AnthropicToolUsesTrigger type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesTrigger%20-%20Go%20SDK&description=AnthropicToolUsesTrigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesTriggerType](/client-sdks/go/api-reference/models/anthropictoolusestriggertype) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropictoolusestriggertype.mdx b/client-sdks/go/api-reference/models/anthropictoolusestriggertype.mdx deleted file mode 100644 index 0db8a55e..00000000 --- a/client-sdks/go/api-reference/models/anthropictoolusestriggertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicToolUsesTriggerType - Go SDK -sidebarTitle: AnthropicToolUsesTriggerType -description: AnthropicToolUsesTriggerType type definition -seoTitle: AnthropicToolUsesTriggerType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropictoolusestriggertype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesTriggerType Type | OpenRouter Go SDK -'og:description': >- - AnthropicToolUsesTriggerType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesTriggerType%20-%20Go%20SDK&description=AnthropicToolUsesTriggerType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicToolUsesTriggerTypeToolUses -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `AnthropicToolUsesTriggerTypeToolUses` | tool_uses | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicurlimagesource.mdx b/client-sdks/go/api-reference/models/anthropicurlimagesource.mdx deleted file mode 100644 index 3b063f70..00000000 --- a/client-sdks/go/api-reference/models/anthropicurlimagesource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicURLImageSource - Go SDK -sidebarTitle: AnthropicURLImageSource -description: AnthropicURLImageSource type definition -seoTitle: AnthropicURLImageSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicurlimagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLImageSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicURLImageSource type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLImageSource%20-%20Go%20SDK&description=AnthropicURLImageSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicURLImageSourceType](/client-sdks/go/api-reference/models/anthropicurlimagesourcetype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicurlimagesourcetype.mdx b/client-sdks/go/api-reference/models/anthropicurlimagesourcetype.mdx deleted file mode 100644 index d14b8160..00000000 --- a/client-sdks/go/api-reference/models/anthropicurlimagesourcetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicURLImageSourceType - Go SDK -sidebarTitle: AnthropicURLImageSourceType -description: AnthropicURLImageSourceType type definition -seoTitle: AnthropicURLImageSourceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicurlimagesourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLImageSourceType Type | OpenRouter Go SDK -'og:description': >- - AnthropicURLImageSourceType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLImageSourceType%20-%20Go%20SDK&description=AnthropicURLImageSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicURLImageSourceTypeURL -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `AnthropicURLImageSourceTypeURL` | url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicurlpdfsource.mdx b/client-sdks/go/api-reference/models/anthropicurlpdfsource.mdx deleted file mode 100644 index a3385a05..00000000 --- a/client-sdks/go/api-reference/models/anthropicurlpdfsource.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicURLPdfSource - Go SDK -sidebarTitle: AnthropicURLPdfSource -description: AnthropicURLPdfSource type definition -seoTitle: AnthropicURLPdfSource Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/anthropicurlpdfsource' -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLPdfSource Type | OpenRouter Go SDK -'og:description': >- - AnthropicURLPdfSource type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLPdfSource%20-%20Go%20SDK&description=AnthropicURLPdfSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicURLPdfSourceType](/client-sdks/go/api-reference/models/anthropicurlpdfsourcetype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicurlpdfsourcetype.mdx b/client-sdks/go/api-reference/models/anthropicurlpdfsourcetype.mdx deleted file mode 100644 index af455b71..00000000 --- a/client-sdks/go/api-reference/models/anthropicurlpdfsourcetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicURLPdfSourceType - Go SDK -sidebarTitle: AnthropicURLPdfSourceType -description: AnthropicURLPdfSourceType type definition -seoTitle: AnthropicURLPdfSourceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicurlpdfsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLPdfSourceType Type | OpenRouter Go SDK -'og:description': >- - AnthropicURLPdfSourceType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLPdfSourceType%20-%20Go%20SDK&description=AnthropicURLPdfSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicURLPdfSourceTypeURL -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `AnthropicURLPdfSourceTypeURL` | url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparam.mdx b/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparam.mdx deleted file mode 100644 index 6e08dee0..00000000 --- a/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparam.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParam - Go SDK -sidebarTitle: AnthropicWebSearchResultBlockParam -description: AnthropicWebSearchResultBlockParam type definition -seoTitle: AnthropicWebSearchResultBlockParam Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicwebsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParam Type | OpenRouter Go SDK -'og:description': >- - AnthropicWebSearchResultBlockParam type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParam%20-%20Go%20SDK&description=AnthropicWebSearchResultBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparamtype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparamtype.mdx b/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparamtype.mdx deleted file mode 100644 index e4d3313a..00000000 --- a/client-sdks/go/api-reference/models/anthropicwebsearchresultblockparamtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParamType - Go SDK -sidebarTitle: AnthropicWebSearchResultBlockParamType -description: AnthropicWebSearchResultBlockParamType type definition -seoTitle: AnthropicWebSearchResultBlockParamType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicwebsearchresultblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParamType Type | OpenRouter Go SDK -'og:description': >- - AnthropicWebSearchResultBlockParamType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParamType%20-%20Go%20SDK&description=AnthropicWebSearchResultBlockParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicWebSearchResultBlockParamTypeWebSearchResult -``` - -## Values - -| Name | Value | -| ------------------------------------------------------- | ------------------------------------------------------- | -| `AnthropicWebSearchResultBlockParamTypeWebSearchResult` | web_search_result | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocation.mdx b/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocation.mdx deleted file mode 100644 index 7eb3028f..00000000 --- a/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocation - Go SDK -sidebarTitle: AnthropicWebSearchToolUserLocation -description: AnthropicWebSearchToolUserLocation type definition -seoTitle: AnthropicWebSearchToolUserLocation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicwebsearchtooluserlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocation Type | OpenRouter Go SDK -'og:description': >- - AnthropicWebSearchToolUserLocation type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocation%20-%20Go%20SDK&description=AnthropicWebSearchToolUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx b/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx deleted file mode 100644 index 285da6da..00000000 --- a/client-sdks/go/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocationType - Go SDK -sidebarTitle: AnthropicWebSearchToolUserLocationType -description: AnthropicWebSearchToolUserLocationType type definition -seoTitle: AnthropicWebSearchToolUserLocationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/anthropicwebsearchtooluserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocationType Type | OpenRouter Go SDK -'og:description': >- - AnthropicWebSearchToolUserLocationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocationType%20-%20Go%20SDK&description=AnthropicWebSearchToolUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AnthropicWebSearchToolUserLocationTypeApproximate -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `AnthropicWebSearchToolUserLocationTypeApproximate` | approximate | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/apitype.mdx b/client-sdks/go/api-reference/models/apitype.mdx deleted file mode 100644 index 61f557a6..00000000 --- a/client-sdks/go/api-reference/models/apitype.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: APIType - Go SDK -sidebarTitle: APIType -description: APIType type definition -seoTitle: APIType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/apitype' -'og:site_name': OpenRouter Documentation -'og:title': APIType Type | OpenRouter Go SDK -'og:description': >- - APIType type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIType%20-%20Go%20SDK&description=APIType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Type of API used for the generation - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.APITypeCompletions - -// Open enum: custom values can be created with a direct type cast -custom := components.APIType("custom_value") -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `APITypeCompletions` | completions | -| `APITypeEmbeddings` | embeddings | -| `APITypeRerank` | rerank | -| `APITypeTts` | tts | -| `APITypeStt` | stt | -| `APITypeVideo` | video | -| `APITypeImage` | image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcallitem.mdx b/client-sdks/go/api-reference/models/applypatchcallitem.mdx deleted file mode 100644 index 7ed4f5a9..00000000 --- a/client-sdks/go/api-reference/models/applypatchcallitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ApplyPatchCallItem - Go SDK -sidebarTitle: ApplyPatchCallItem -description: ApplyPatchCallItem type definition -seoTitle: ApplyPatchCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/applypatchcallitem' -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItem Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItem%20-%20Go%20SDK&description=ApplyPatchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A tool call emitted by the model requesting a V4A patch operation. The client applies the patch and echoes an `apply_patch_call_output` on the next turn. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](/client-sdks/go/api-reference/models/applypatchcalloperation) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `Status` | [components.ApplyPatchCallStatus](/client-sdks/go/api-reference/models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.ApplyPatchCallItemType](/client-sdks/go/api-reference/models/applypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcallitemtype.mdx b/client-sdks/go/api-reference/models/applypatchcallitemtype.mdx deleted file mode 100644 index f1935a05..00000000 --- a/client-sdks/go/api-reference/models/applypatchcallitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ApplyPatchCallItemType - Go SDK -sidebarTitle: ApplyPatchCallItemType -description: ApplyPatchCallItemType type definition -seoTitle: ApplyPatchCallItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/applypatchcallitemtype' -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItemType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItemType%20-%20Go%20SDK&description=ApplyPatchCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallItemTypeApplyPatchCall -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `ApplyPatchCallItemTypeApplyPatchCall` | apply_patch_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloperation.mdx b/client-sdks/go/api-reference/models/applypatchcalloperation.mdx deleted file mode 100644 index 478791ed..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloperation.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: ApplyPatchCallOperation - Go SDK -sidebarTitle: ApplyPatchCallOperation -description: ApplyPatchCallOperation type definition -seoTitle: ApplyPatchCallOperation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperation Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOperation type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperation%20-%20Go%20SDK&description=ApplyPatchCallOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. - -## Supported Types - -### ApplyPatchCreateFileOperation - -```go lines -applyPatchCallOperation := components.CreateApplyPatchCallOperationCreateFile(components.ApplyPatchCreateFileOperation{/* values here */}) -``` - -### ApplyPatchDeleteFileOperation - -```go lines -applyPatchCallOperation := components.CreateApplyPatchCallOperationDeleteFile(components.ApplyPatchDeleteFileOperation{/* values here */}) -``` - -### ApplyPatchUpdateFileOperation - -```go lines -applyPatchCallOperation := components.CreateApplyPatchCallOperationUpdateFile(components.ApplyPatchUpdateFileOperation{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch applyPatchCallOperation.Type { - case components.ApplyPatchCallOperationTypeCreateFile: - // applyPatchCallOperation.ApplyPatchCreateFileOperation is populated - case components.ApplyPatchCallOperationTypeDeleteFile: - // applyPatchCallOperation.ApplyPatchDeleteFileOperation is populated - case components.ApplyPatchCallOperationTypeUpdateFile: - // applyPatchCallOperation.ApplyPatchUpdateFileOperation is populated - default: - // Unknown type - use applyPatchCallOperation.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx b/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx deleted file mode 100644 index d00257ee..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDeltaEvent - Go SDK -sidebarTitle: ApplyPatchCallOperationDiffDeltaEvent -description: ApplyPatchCallOperationDiffDeltaEvent type definition -seoTitle: ApplyPatchCallOperationDiffDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloperationdiffdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOperationDiffDeltaEvent type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDeltaEvent%20-%20Go%20SDK&description=ApplyPatchCallOperationDiffDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI's streaming shape. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :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.ApplyPatchCallOperationDiffDeltaEventType](/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaeventtype.mdx b/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaeventtype.mdx deleted file mode 100644 index 17631122..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdeltaeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDeltaEventType - Go SDK -sidebarTitle: ApplyPatchCallOperationDiffDeltaEventType -description: ApplyPatchCallOperationDiffDeltaEventType type definition -seoTitle: ApplyPatchCallOperationDiffDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloperationdiffdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOperationDiffDeltaEventType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDeltaEventType%20-%20Go%20SDK&description=ApplyPatchCallOperationDiffDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallOperationDiffDeltaEventTypeResponseApplyPatchCallOperationDiffDelta -``` - -## Values - -| Name | Value | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `ApplyPatchCallOperationDiffDeltaEventTypeResponseApplyPatchCallOperationDiffDelta` | response.apply_patch_call_operation_diff.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneevent.mdx b/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneevent.mdx deleted file mode 100644 index a3544f05..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDoneEvent - Go SDK -sidebarTitle: ApplyPatchCallOperationDiffDoneEvent -description: ApplyPatchCallOperationDiffDoneEvent type definition -seoTitle: ApplyPatchCallOperationDiffDoneEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloperationdiffdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDoneEvent Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOperationDiffDoneEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDoneEvent%20-%20Go%20SDK&description=ApplyPatchCallOperationDiffDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Emitted when `operation.diff` streaming completes for an `apply_patch_call`. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `Diff` | `string` | :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.ApplyPatchCallOperationDiffDoneEventType](/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneeventtype.mdx b/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneeventtype.mdx deleted file mode 100644 index efc6abbc..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloperationdiffdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDoneEventType - Go SDK -sidebarTitle: ApplyPatchCallOperationDiffDoneEventType -description: ApplyPatchCallOperationDiffDoneEventType type definition -seoTitle: ApplyPatchCallOperationDiffDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloperationdiffdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDoneEventType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOperationDiffDoneEventType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDoneEventType%20-%20Go%20SDK&description=ApplyPatchCallOperationDiffDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallOperationDiffDoneEventTypeResponseApplyPatchCallOperationDiffDone -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `ApplyPatchCallOperationDiffDoneEventTypeResponseApplyPatchCallOperationDiffDone` | response.apply_patch_call_operation_diff.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloutputitem.mdx b/client-sdks/go/api-reference/models/applypatchcalloutputitem.mdx deleted file mode 100644 index 69dcd181..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloutputitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOutputItem - Go SDK -sidebarTitle: ApplyPatchCallOutputItem -description: ApplyPatchCallOutputItem type definition -seoTitle: ApplyPatchCallOutputItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItem Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOutputItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItem%20-%20Go%20SDK&description=ApplyPatchCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The client's echo of an `apply_patch_call` after applying the patch. `output` is an optional human-readable log; `status` is `completed` when the patch was applied successfully, `failed` otherwise. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/applypatchcalloutputitemstatus) | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOutputItemType](/client-sdks/go/api-reference/models/applypatchcalloutputitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloutputitemstatus.mdx b/client-sdks/go/api-reference/models/applypatchcalloutputitemstatus.mdx deleted file mode 100644 index 382fe826..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloutputitemstatus.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ApplyPatchCallOutputItemStatus - Go SDK -sidebarTitle: ApplyPatchCallOutputItemStatus -description: ApplyPatchCallOutputItemStatus type definition -seoTitle: ApplyPatchCallOutputItemStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemStatus Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOutputItemStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemStatus%20-%20Go%20SDK&description=ApplyPatchCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallOutputItemStatusCompleted - -// Open enum: custom values can be created with a direct type cast -custom := components.ApplyPatchCallOutputItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `ApplyPatchCallOutputItemStatusCompleted` | completed | -| `ApplyPatchCallOutputItemStatusFailed` | failed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcalloutputitemtype.mdx b/client-sdks/go/api-reference/models/applypatchcalloutputitemtype.mdx deleted file mode 100644 index e2f756bd..00000000 --- a/client-sdks/go/api-reference/models/applypatchcalloutputitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchCallOutputItemType - Go SDK -sidebarTitle: ApplyPatchCallOutputItemType -description: ApplyPatchCallOutputItemType type definition -seoTitle: ApplyPatchCallOutputItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallOutputItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemType%20-%20Go%20SDK&description=ApplyPatchCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallOutputItemTypeApplyPatchCallOutput -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `ApplyPatchCallOutputItemTypeApplyPatchCallOutput` | apply_patch_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcallstatus.mdx b/client-sdks/go/api-reference/models/applypatchcallstatus.mdx deleted file mode 100644 index 12dccb57..00000000 --- a/client-sdks/go/api-reference/models/applypatchcallstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ApplyPatchCallStatus - Go SDK -sidebarTitle: ApplyPatchCallStatus -description: ApplyPatchCallStatus type definition -seoTitle: ApplyPatchCallStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/applypatchcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallStatus Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCallStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallStatus%20-%20Go%20SDK&description=ApplyPatchCallStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Lifecycle state of an `apply_patch_call` output item. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCallStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.ApplyPatchCallStatus("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ApplyPatchCallStatusInProgress` | in_progress | -| `ApplyPatchCallStatusCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcreatefileoperation.mdx b/client-sdks/go/api-reference/models/applypatchcreatefileoperation.mdx deleted file mode 100644 index c3bce574..00000000 --- a/client-sdks/go/api-reference/models/applypatchcreatefileoperation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ApplyPatchCreateFileOperation - Go SDK -sidebarTitle: ApplyPatchCreateFileOperation -description: ApplyPatchCreateFileOperation type definition -seoTitle: ApplyPatchCreateFileOperation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcreatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCreateFileOperation Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCreateFileOperation type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCreateFileOperation%20-%20Go%20SDK&description=ApplyPatchCreateFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing the new file contents. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | :heavy_check_mark: | N/A | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCreateFileOperationType](/client-sdks/go/api-reference/models/applypatchcreatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchcreatefileoperationtype.mdx b/client-sdks/go/api-reference/models/applypatchcreatefileoperationtype.mdx deleted file mode 100644 index f69a08c8..00000000 --- a/client-sdks/go/api-reference/models/applypatchcreatefileoperationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchCreateFileOperationType - Go SDK -sidebarTitle: ApplyPatchCreateFileOperationType -description: ApplyPatchCreateFileOperationType type definition -seoTitle: ApplyPatchCreateFileOperationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchcreatefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCreateFileOperationType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchCreateFileOperationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCreateFileOperationType%20-%20Go%20SDK&description=ApplyPatchCreateFileOperationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchCreateFileOperationTypeCreateFile -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ApplyPatchCreateFileOperationTypeCreateFile` | create_file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchdeletefileoperation.mdx b/client-sdks/go/api-reference/models/applypatchdeletefileoperation.mdx deleted file mode 100644 index e6f4ed95..00000000 --- a/client-sdks/go/api-reference/models/applypatchdeletefileoperation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApplyPatchDeleteFileOperation - Go SDK -sidebarTitle: ApplyPatchDeleteFileOperation -description: ApplyPatchDeleteFileOperation type definition -seoTitle: ApplyPatchDeleteFileOperation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchdeletefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchDeleteFileOperation Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchDeleteFileOperation type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchDeleteFileOperation%20-%20Go%20SDK&description=ApplyPatchDeleteFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The `delete_file` variant of an `apply_patch_call.operation`. Identifies the file to remove; no diff is required. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchDeleteFileOperationType](/client-sdks/go/api-reference/models/applypatchdeletefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchdeletefileoperationtype.mdx b/client-sdks/go/api-reference/models/applypatchdeletefileoperationtype.mdx deleted file mode 100644 index 67f62f6a..00000000 --- a/client-sdks/go/api-reference/models/applypatchdeletefileoperationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchDeleteFileOperationType - Go SDK -sidebarTitle: ApplyPatchDeleteFileOperationType -description: ApplyPatchDeleteFileOperationType type definition -seoTitle: ApplyPatchDeleteFileOperationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchdeletefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchDeleteFileOperationType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchDeleteFileOperationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchDeleteFileOperationType%20-%20Go%20SDK&description=ApplyPatchDeleteFileOperationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchDeleteFileOperationTypeDeleteFile -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ApplyPatchDeleteFileOperationTypeDeleteFile` | delete_file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchengineenum.mdx b/client-sdks/go/api-reference/models/applypatchengineenum.mdx deleted file mode 100644 index 21621faf..00000000 --- a/client-sdks/go/api-reference/models/applypatchengineenum.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ApplyPatchEngineEnum - Go SDK -sidebarTitle: ApplyPatchEngineEnum -description: ApplyPatchEngineEnum type definition -seoTitle: ApplyPatchEngineEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/applypatchengineenum' -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchEngineEnum Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchEngineEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchEngineEnum%20-%20Go%20SDK&description=ApplyPatchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchEngineEnumAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ApplyPatchEngineEnum("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ApplyPatchEngineEnumAuto` | auto | -| `ApplyPatchEngineEnumNative` | native | -| `ApplyPatchEngineEnumOpenrouter` | openrouter | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchservertool.mdx b/client-sdks/go/api-reference/models/applypatchservertool.mdx deleted file mode 100644 index 06f426d5..00000000 --- a/client-sdks/go/api-reference/models/applypatchservertool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ApplyPatchServerTool - Go SDK -sidebarTitle: ApplyPatchServerTool -description: ApplyPatchServerTool type definition -seoTitle: ApplyPatchServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/applypatchservertool' -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerTool Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerTool%20-%20Go%20SDK&description=ApplyPatchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Apply patch tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ApplyPatchServerToolType](/client-sdks/go/api-reference/models/applypatchservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchservertoolconfig.mdx b/client-sdks/go/api-reference/models/applypatchservertoolconfig.mdx deleted file mode 100644 index 0359bbdf..00000000 --- a/client-sdks/go/api-reference/models/applypatchservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ApplyPatchServerToolConfig - Go SDK -sidebarTitle: ApplyPatchServerToolConfig -description: ApplyPatchServerToolConfig type definition -seoTitle: ApplyPatchServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchServerToolConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolConfig%20-%20Go%20SDK&description=ApplyPatchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:apply_patch server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.ApplyPatchEngineEnum](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/applypatchservertoolopenrouter.mdx b/client-sdks/go/api-reference/models/applypatchservertoolopenrouter.mdx deleted file mode 100644 index 322f8572..00000000 --- a/client-sdks/go/api-reference/models/applypatchservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApplyPatchServerToolOpenRouter - Go SDK -sidebarTitle: ApplyPatchServerToolOpenRouter -description: ApplyPatchServerToolOpenRouter type definition -seoTitle: ApplyPatchServerToolOpenRouter Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolOpenRouter Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchServerToolOpenRouter type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolOpenRouter%20-%20Go%20SDK&description=ApplyPatchServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: validates V4A diff patches for file operations (create, update, delete). Restricted to the Responses API. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ApplyPatchServerToolConfig](/client-sdks/go/api-reference/models/applypatchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | `{"engine": "auto"}` | -| `Type` | [components.ApplyPatchServerToolOpenRouterType](/client-sdks/go/api-reference/models/applypatchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchservertoolopenroutertype.mdx b/client-sdks/go/api-reference/models/applypatchservertoolopenroutertype.mdx deleted file mode 100644 index dd0a3382..00000000 --- a/client-sdks/go/api-reference/models/applypatchservertoolopenroutertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchServerToolOpenRouterType - Go SDK -sidebarTitle: ApplyPatchServerToolOpenRouterType -description: ApplyPatchServerToolOpenRouterType type definition -seoTitle: ApplyPatchServerToolOpenRouterType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolOpenRouterType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchServerToolOpenRouterType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolOpenRouterType%20-%20Go%20SDK&description=ApplyPatchServerToolOpenRouterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchServerToolOpenRouterTypeOpenrouterApplyPatch -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `ApplyPatchServerToolOpenRouterTypeOpenrouterApplyPatch` | openrouter:apply_patch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchservertooltype.mdx b/client-sdks/go/api-reference/models/applypatchservertooltype.mdx deleted file mode 100644 index 968c558c..00000000 --- a/client-sdks/go/api-reference/models/applypatchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchServerToolType - Go SDK -sidebarTitle: ApplyPatchServerToolType -description: ApplyPatchServerToolType type definition -seoTitle: ApplyPatchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchServerToolType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolType%20-%20Go%20SDK&description=ApplyPatchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchServerToolTypeApplyPatch -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `ApplyPatchServerToolTypeApplyPatch` | apply_patch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchupdatefileoperation.mdx b/client-sdks/go/api-reference/models/applypatchupdatefileoperation.mdx deleted file mode 100644 index 51fd9f16..00000000 --- a/client-sdks/go/api-reference/models/applypatchupdatefileoperation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ApplyPatchUpdateFileOperation - Go SDK -sidebarTitle: ApplyPatchUpdateFileOperation -description: ApplyPatchUpdateFileOperation type definition -seoTitle: ApplyPatchUpdateFileOperation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchupdatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchUpdateFileOperation Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchUpdateFileOperation type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchUpdateFileOperation%20-%20Go%20SDK&description=ApplyPatchUpdateFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing edits to an existing file. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Diff` | `string` | :heavy_check_mark: | N/A | -| `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchUpdateFileOperationType](/client-sdks/go/api-reference/models/applypatchupdatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/applypatchupdatefileoperationtype.mdx b/client-sdks/go/api-reference/models/applypatchupdatefileoperationtype.mdx deleted file mode 100644 index e208fb38..00000000 --- a/client-sdks/go/api-reference/models/applypatchupdatefileoperationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchUpdateFileOperationType - Go SDK -sidebarTitle: ApplyPatchUpdateFileOperationType -description: ApplyPatchUpdateFileOperationType type definition -seoTitle: ApplyPatchUpdateFileOperationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/applypatchupdatefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchUpdateFileOperationType Type | OpenRouter Go SDK -'og:description': >- - ApplyPatchUpdateFileOperationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchUpdateFileOperationType%20-%20Go%20SDK&description=ApplyPatchUpdateFileOperationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ApplyPatchUpdateFileOperationTypeUpdateFile -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ApplyPatchUpdateFileOperationTypeUpdateFile` | update_file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/architecture.mdx b/client-sdks/go/api-reference/models/architecture.mdx deleted file mode 100644 index d5034d4f..00000000 --- a/client-sdks/go/api-reference/models/architecture.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Architecture - Go SDK -sidebarTitle: Architecture -description: Architecture type definition -seoTitle: Architecture Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/architecture' -'og:site_name': OpenRouter Documentation -'og:title': Architecture Type | OpenRouter Go SDK -'og:description': >- - Architecture type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Architecture%20-%20Go%20SDK&description=Architecture%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `InputModalities` | [][components.InputModality](/client-sdks/go/api-reference/models/inputmodality) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | [*components.InstructType](/client-sdks/go/api-reference/models/instructtype) | :heavy_check_mark: | Instruction format type | chatml | -| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text | -| `OutputModalities` | [][components.OutputModality](/client-sdks/go/api-reference/models/outputmodality) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.Tokenizer](/client-sdks/go/api-reference/models/tokenizer) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/aspectratio.mdx b/client-sdks/go/api-reference/models/aspectratio.mdx deleted file mode 100644 index ce210475..00000000 --- a/client-sdks/go/api-reference/models/aspectratio.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: AspectRatio - Go SDK -sidebarTitle: AspectRatio -description: AspectRatio type definition -seoTitle: AspectRatio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/aspectratio' -'og:site_name': OpenRouter Documentation -'og:title': AspectRatio Type | OpenRouter Go SDK -'og:description': >- - AspectRatio type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AspectRatio%20-%20Go%20SDK&description=AspectRatio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Aspect ratio of the generated video - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AspectRatioOneHundredAndSixtyNine - -// Open enum: custom values can be created with a direct type cast -custom := components.AspectRatio("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `AspectRatioOneHundredAndSixtyNine` | 16:9 | -| `AspectRatioNineHundredAndSixteen` | 9:16 | -| `AspectRatioEleven` | 1:1 | -| `AspectRatioFortyThree` | 4:3 | -| `AspectRatioThirtyFour` | 3:4 | -| `AspectRatioThirtyTwo` | 3:2 | -| `AspectRatioTwentyThree` | 2:3 | -| `AspectRatioTwoHundredAndNineteen` | 21:9 | -| `AspectRatioNineHundredAndTwentyOne` | 9:21 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/autorouterplugin.mdx b/client-sdks/go/api-reference/models/autorouterplugin.mdx deleted file mode 100644 index 78997cdf..00000000 --- a/client-sdks/go/api-reference/models/autorouterplugin.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AutoRouterPlugin - Go SDK -sidebarTitle: AutoRouterPlugin -description: AutoRouterPlugin type definition -seoTitle: AutoRouterPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/autorouterplugin' -'og:site_name': OpenRouter Documentation -'og:title': AutoRouterPlugin Type | OpenRouter Go SDK -'og:description': >- - AutoRouterPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AutoRouterPlugin%20-%20Go%20SDK&description=AutoRouterPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | []`string` | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| `CostQualityTradeoff` | `*int64` | :heavy_minus_sign: | 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. | 7 | -| `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `ID` | [components.AutoRouterPluginID](/client-sdks/go/api-reference/models/autorouterpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/autorouterpluginid.mdx b/client-sdks/go/api-reference/models/autorouterpluginid.mdx deleted file mode 100644 index dd810ca7..00000000 --- a/client-sdks/go/api-reference/models/autorouterpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: AutoRouterPluginID - Go SDK -sidebarTitle: AutoRouterPluginID -description: AutoRouterPluginID type definition -seoTitle: AutoRouterPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/autorouterpluginid' -'og:site_name': OpenRouter Documentation -'og:title': AutoRouterPluginID Type | OpenRouter Go SDK -'og:description': >- - AutoRouterPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AutoRouterPluginID%20-%20Go%20SDK&description=AutoRouterPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.AutoRouterPluginIDAutoRouter -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `AutoRouterPluginIDAutoRouter` | auto-router | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/background.mdx b/client-sdks/go/api-reference/models/background.mdx deleted file mode 100644 index 66774178..00000000 --- a/client-sdks/go/api-reference/models/background.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Background - Go SDK -sidebarTitle: Background -description: Background type definition -seoTitle: Background Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/background' -'og:site_name': OpenRouter Documentation -'og:title': Background Type | OpenRouter Go SDK -'og:description': >- - Background type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Background%20-%20Go%20SDK&description=Background%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BackgroundTransparent - -// Open enum: custom values can be created with a direct type cast -custom := components.Background("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `BackgroundTransparent` | transparent | -| `BackgroundOpaque` | opaque | -| `BackgroundAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/badgatewayresponseerror.mdx b/client-sdks/go/api-reference/models/badgatewayresponseerror.mdx deleted file mode 100644 index 80264ca0..00000000 --- a/client-sdks/go/api-reference/models/badgatewayresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadGatewayResponseError - Go SDK -sidebarTitle: BadGatewayResponseError -description: BadGatewayResponseError type definition -seoTitle: BadGatewayResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/badgatewayresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseError Type | OpenRouter Go SDK -'og:description': >- - BadGatewayResponseError type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseError%20-%20Go%20SDK&description=BadGatewayResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Bad Gateway - Provider/upstream API failure - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadGatewayResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/badgatewayresponseerrordata.mdx b/client-sdks/go/api-reference/models/badgatewayresponseerrordata.mdx deleted file mode 100644 index a4ed0594..00000000 --- a/client-sdks/go/api-reference/models/badgatewayresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadGatewayResponseErrorData - Go SDK -sidebarTitle: BadGatewayResponseErrorData -description: BadGatewayResponseErrorData type definition -seoTitle: BadGatewayResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/badgatewayresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - BadGatewayResponseErrorData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseErrorData%20-%20Go%20SDK&description=BadGatewayResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for BadGatewayResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/badrequestresponseerror.mdx b/client-sdks/go/api-reference/models/badrequestresponseerror.mdx deleted file mode 100644 index b2f33f53..00000000 --- a/client-sdks/go/api-reference/models/badrequestresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadRequestResponseError - Go SDK -sidebarTitle: BadRequestResponseError -description: BadRequestResponseError type definition -seoTitle: BadRequestResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/badrequestresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseError Type | OpenRouter Go SDK -'og:description': >- - BadRequestResponseError type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseError%20-%20Go%20SDK&description=BadRequestResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Bad Request - Invalid request parameters or malformed input - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadRequestResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/badrequestresponseerrordata.mdx b/client-sdks/go/api-reference/models/badrequestresponseerrordata.mdx deleted file mode 100644 index f2f590fd..00000000 --- a/client-sdks/go/api-reference/models/badrequestresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadRequestResponseErrorData - Go SDK -sidebarTitle: BadRequestResponseErrorData -description: BadRequestResponseErrorData type definition -seoTitle: BadRequestResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/badrequestresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - BadRequestResponseErrorData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseErrorData%20-%20Go%20SDK&description=BadRequestResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for BadRequestResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputscontent1.mdx b/client-sdks/go/api-reference/models/baseinputscontent1.mdx deleted file mode 100644 index 916f9be9..00000000 --- a/client-sdks/go/api-reference/models/baseinputscontent1.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: BaseInputsContent1 - Go SDK -sidebarTitle: BaseInputsContent1 -description: BaseInputsContent1 type definition -seoTitle: BaseInputsContent1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputscontent1' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent1 Type | OpenRouter Go SDK -'og:description': >- - BaseInputsContent1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent1%20-%20Go%20SDK&description=BaseInputsContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputAudio - -```go lines -baseInputsContent1 := components.CreateBaseInputsContent1InputAudio(components.InputAudio{/* values here */}) -``` - -### InputFile - -```go lines -baseInputsContent1 := components.CreateBaseInputsContent1InputFile(components.InputFile{/* values here */}) -``` - -### InputImage - -```go lines -baseInputsContent1 := components.CreateBaseInputsContent1InputImage(components.InputImage{/* values here */}) -``` - -### InputText - -```go lines -baseInputsContent1 := components.CreateBaseInputsContent1InputText(components.InputText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch baseInputsContent1.Type { - case components.BaseInputsContent1TypeInputAudio: - // baseInputsContent1.InputAudio is populated - case components.BaseInputsContent1TypeInputFile: - // baseInputsContent1.InputFile is populated - case components.BaseInputsContent1TypeInputImage: - // baseInputsContent1.InputImage is populated - case components.BaseInputsContent1TypeInputText: - // baseInputsContent1.InputText is populated - default: - // Unknown type - use baseInputsContent1.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputscontent2.mdx b/client-sdks/go/api-reference/models/baseinputscontent2.mdx deleted file mode 100644 index 17f25fdf..00000000 --- a/client-sdks/go/api-reference/models/baseinputscontent2.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BaseInputsContent2 - Go SDK -sidebarTitle: BaseInputsContent2 -description: BaseInputsContent2 type definition -seoTitle: BaseInputsContent2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputscontent2' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent2 Type | OpenRouter Go SDK -'og:description': >- - BaseInputsContent2 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent2%20-%20Go%20SDK&description=BaseInputsContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -baseInputsContent2 := components.CreateBaseInputsContent2ArrayOfBaseInputsContent1([]components.BaseInputsContent1{/* values here */}) -``` - -### - -```go lines -baseInputsContent2 := components.CreateBaseInputsContent2Str(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch baseInputsContent2.Type { - case components.BaseInputsContent2TypeArrayOfBaseInputsContent1: - // baseInputsContent2.ArrayOfBaseInputsContent1 is populated - case components.BaseInputsContent2TypeStr: - // baseInputsContent2.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsmessage.mdx b/client-sdks/go/api-reference/models/baseinputsmessage.mdx deleted file mode 100644 index 2cf44278..00000000 --- a/client-sdks/go/api-reference/models/baseinputsmessage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BaseInputsMessage - Go SDK -sidebarTitle: BaseInputsMessage -description: BaseInputsMessage type definition -seoTitle: BaseInputsMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsmessage' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsMessage Type | OpenRouter Go SDK -'og:description': >- - BaseInputsMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsMessage%20-%20Go%20SDK&description=BaseInputsMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.BaseInputsContent2](/client-sdks/go/api-reference/models/baseinputscontent2) | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](/client-sdks/go/api-reference/models/baseinputsphaseunion)] | :heavy_minus_sign: | N/A | -| `Role` | [components.BaseInputsRoleUnion](/client-sdks/go/api-reference/models/baseinputsroleunion) | :heavy_check_mark: | N/A | -| `Type` | [*components.BaseInputsType](/client-sdks/go/api-reference/models/baseinputstype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsphasecommentary.mdx b/client-sdks/go/api-reference/models/baseinputsphasecommentary.mdx deleted file mode 100644 index 8c1bb7be..00000000 --- a/client-sdks/go/api-reference/models/baseinputsphasecommentary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BaseInputsPhaseCommentary - Go SDK -sidebarTitle: BaseInputsPhaseCommentary -description: BaseInputsPhaseCommentary type definition -seoTitle: BaseInputsPhaseCommentary Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/baseinputsphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseCommentary Type | OpenRouter Go SDK -'og:description': >- - BaseInputsPhaseCommentary type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseCommentary%20-%20Go%20SDK&description=BaseInputsPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsPhaseCommentaryCommentary -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `BaseInputsPhaseCommentaryCommentary` | commentary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsphasefinalanswer.mdx b/client-sdks/go/api-reference/models/baseinputsphasefinalanswer.mdx deleted file mode 100644 index c5815851..00000000 --- a/client-sdks/go/api-reference/models/baseinputsphasefinalanswer.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BaseInputsPhaseFinalAnswer - Go SDK -sidebarTitle: BaseInputsPhaseFinalAnswer -description: BaseInputsPhaseFinalAnswer type definition -seoTitle: BaseInputsPhaseFinalAnswer Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/baseinputsphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseFinalAnswer Type | OpenRouter Go SDK -'og:description': >- - BaseInputsPhaseFinalAnswer type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseFinalAnswer%20-%20Go%20SDK&description=BaseInputsPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsPhaseFinalAnswerFinalAnswer -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `BaseInputsPhaseFinalAnswerFinalAnswer` | final_answer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsphaseunion.mdx b/client-sdks/go/api-reference/models/baseinputsphaseunion.mdx deleted file mode 100644 index 348ada01..00000000 --- a/client-sdks/go/api-reference/models/baseinputsphaseunion.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: BaseInputsPhaseUnion - Go SDK -sidebarTitle: BaseInputsPhaseUnion -description: BaseInputsPhaseUnion type definition -seoTitle: BaseInputsPhaseUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsphaseunion' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseUnion Type | OpenRouter Go SDK -'og:description': >- - BaseInputsPhaseUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseUnion%20-%20Go%20SDK&description=BaseInputsPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### BaseInputsPhaseCommentary - -```go lines -baseInputsPhaseUnion := components.CreateBaseInputsPhaseUnionBaseInputsPhaseCommentary(components.BaseInputsPhaseCommentary{/* values here */}) -``` - -### BaseInputsPhaseFinalAnswer - -```go lines -baseInputsPhaseUnion := components.CreateBaseInputsPhaseUnionBaseInputsPhaseFinalAnswer(components.BaseInputsPhaseFinalAnswer{/* values here */}) -``` - -### - -```go lines -baseInputsPhaseUnion := components.CreateBaseInputsPhaseUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch baseInputsPhaseUnion.Type { - case components.BaseInputsPhaseUnionTypeBaseInputsPhaseCommentary: - // baseInputsPhaseUnion.BaseInputsPhaseCommentary is populated - case components.BaseInputsPhaseUnionTypeBaseInputsPhaseFinalAnswer: - // baseInputsPhaseUnion.BaseInputsPhaseFinalAnswer is populated - case components.BaseInputsPhaseUnionTypeAny: - // baseInputsPhaseUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsroleassistant.mdx b/client-sdks/go/api-reference/models/baseinputsroleassistant.mdx deleted file mode 100644 index 099a9723..00000000 --- a/client-sdks/go/api-reference/models/baseinputsroleassistant.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BaseInputsRoleAssistant - Go SDK -sidebarTitle: BaseInputsRoleAssistant -description: BaseInputsRoleAssistant type definition -seoTitle: BaseInputsRoleAssistant Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/baseinputsroleassistant -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleAssistant Type | OpenRouter Go SDK -'og:description': >- - BaseInputsRoleAssistant type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleAssistant%20-%20Go%20SDK&description=BaseInputsRoleAssistant%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsRoleAssistantAssistant -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `BaseInputsRoleAssistantAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsroledeveloper.mdx b/client-sdks/go/api-reference/models/baseinputsroledeveloper.mdx deleted file mode 100644 index df1c8eb1..00000000 --- a/client-sdks/go/api-reference/models/baseinputsroledeveloper.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BaseInputsRoleDeveloper - Go SDK -sidebarTitle: BaseInputsRoleDeveloper -description: BaseInputsRoleDeveloper type definition -seoTitle: BaseInputsRoleDeveloper Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/baseinputsroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleDeveloper Type | OpenRouter Go SDK -'og:description': >- - BaseInputsRoleDeveloper type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleDeveloper%20-%20Go%20SDK&description=BaseInputsRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsRoleDeveloperDeveloper -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `BaseInputsRoleDeveloperDeveloper` | developer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsrolesystem.mdx b/client-sdks/go/api-reference/models/baseinputsrolesystem.mdx deleted file mode 100644 index e3d54227..00000000 --- a/client-sdks/go/api-reference/models/baseinputsrolesystem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BaseInputsRoleSystem - Go SDK -sidebarTitle: BaseInputsRoleSystem -description: BaseInputsRoleSystem type definition -seoTitle: BaseInputsRoleSystem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsrolesystem' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleSystem Type | OpenRouter Go SDK -'og:description': >- - BaseInputsRoleSystem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleSystem%20-%20Go%20SDK&description=BaseInputsRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsRoleSystemSystem -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `BaseInputsRoleSystemSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsroleunion.mdx b/client-sdks/go/api-reference/models/baseinputsroleunion.mdx deleted file mode 100644 index edee0783..00000000 --- a/client-sdks/go/api-reference/models/baseinputsroleunion.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: BaseInputsRoleUnion - Go SDK -sidebarTitle: BaseInputsRoleUnion -description: BaseInputsRoleUnion type definition -seoTitle: BaseInputsRoleUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsroleunion' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUnion Type | OpenRouter Go SDK -'og:description': >- - BaseInputsRoleUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUnion%20-%20Go%20SDK&description=BaseInputsRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### BaseInputsRoleUser - -```go lines -baseInputsRoleUnion := components.CreateBaseInputsRoleUnionBaseInputsRoleUser(components.BaseInputsRoleUser{/* values here */}) -``` - -### BaseInputsRoleSystem - -```go lines -baseInputsRoleUnion := components.CreateBaseInputsRoleUnionBaseInputsRoleSystem(components.BaseInputsRoleSystem{/* values here */}) -``` - -### BaseInputsRoleAssistant - -```go lines -baseInputsRoleUnion := components.CreateBaseInputsRoleUnionBaseInputsRoleAssistant(components.BaseInputsRoleAssistant{/* values here */}) -``` - -### BaseInputsRoleDeveloper - -```go lines -baseInputsRoleUnion := components.CreateBaseInputsRoleUnionBaseInputsRoleDeveloper(components.BaseInputsRoleDeveloper{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch baseInputsRoleUnion.Type { - case components.BaseInputsRoleUnionTypeBaseInputsRoleUser: - // baseInputsRoleUnion.BaseInputsRoleUser is populated - case components.BaseInputsRoleUnionTypeBaseInputsRoleSystem: - // baseInputsRoleUnion.BaseInputsRoleSystem is populated - case components.BaseInputsRoleUnionTypeBaseInputsRoleAssistant: - // baseInputsRoleUnion.BaseInputsRoleAssistant is populated - case components.BaseInputsRoleUnionTypeBaseInputsRoleDeveloper: - // baseInputsRoleUnion.BaseInputsRoleDeveloper is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsroleuser.mdx b/client-sdks/go/api-reference/models/baseinputsroleuser.mdx deleted file mode 100644 index a5aa07ca..00000000 --- a/client-sdks/go/api-reference/models/baseinputsroleuser.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BaseInputsRoleUser - Go SDK -sidebarTitle: BaseInputsRoleUser -description: BaseInputsRoleUser type definition -seoTitle: BaseInputsRoleUser Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsroleuser' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUser Type | OpenRouter Go SDK -'og:description': >- - BaseInputsRoleUser type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUser%20-%20Go%20SDK&description=BaseInputsRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsRoleUserUser -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `BaseInputsRoleUserUser` | user | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputstype.mdx b/client-sdks/go/api-reference/models/baseinputstype.mdx deleted file mode 100644 index 71e1601b..00000000 --- a/client-sdks/go/api-reference/models/baseinputstype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BaseInputsType - Go SDK -sidebarTitle: BaseInputsType -description: BaseInputsType type definition -seoTitle: BaseInputsType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputstype' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsType Type | OpenRouter Go SDK -'og:description': >- - BaseInputsType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsType%20-%20Go%20SDK&description=BaseInputsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BaseInputsTypeMessage -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `BaseInputsTypeMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsunion.mdx b/client-sdks/go/api-reference/models/baseinputsunion.mdx deleted file mode 100644 index dfee995c..00000000 --- a/client-sdks/go/api-reference/models/baseinputsunion.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: BaseInputsUnion - Go SDK -sidebarTitle: BaseInputsUnion -description: BaseInputsUnion type definition -seoTitle: BaseInputsUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsunion' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion Type | OpenRouter Go SDK -'og:description': >- - BaseInputsUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion%20-%20Go%20SDK&description=BaseInputsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -baseInputsUnion := components.CreateBaseInputsUnionStr(string{/* values here */}) -``` - -### - -```go lines -baseInputsUnion := components.CreateBaseInputsUnionArrayOfBaseInputsUnion1([]components.BaseInputsUnion1{/* values here */}) -``` - -### - -```go lines -baseInputsUnion := components.CreateBaseInputsUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch baseInputsUnion.Type { - case components.BaseInputsUnionTypeStr: - // baseInputsUnion.Str is populated - case components.BaseInputsUnionTypeArrayOfBaseInputsUnion1: - // baseInputsUnion.ArrayOfBaseInputsUnion1 is populated - case components.BaseInputsUnionTypeAny: - // baseInputsUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/baseinputsunion1.mdx b/client-sdks/go/api-reference/models/baseinputsunion1.mdx deleted file mode 100644 index bd4804a6..00000000 --- a/client-sdks/go/api-reference/models/baseinputsunion1.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: BaseInputsUnion1 - Go SDK -sidebarTitle: BaseInputsUnion1 -description: BaseInputsUnion1 type definition -seoTitle: BaseInputsUnion1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/baseinputsunion1' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion1 Type | OpenRouter Go SDK -'og:description': >- - BaseInputsUnion1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion1%20-%20Go%20SDK&description=BaseInputsUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### BaseInputsMessage - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1BaseInputsMessage(components.BaseInputsMessage{/* values here */}) -``` - -### OpenAIResponseInputMessageItem - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OpenAIResponseInputMessageItem(components.OpenAIResponseInputMessageItem{/* values here */}) -``` - -### OpenAIResponseFunctionToolCallOutput - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OpenAIResponseFunctionToolCallOutput(components.OpenAIResponseFunctionToolCallOutput{/* values here */}) -``` - -### OpenAIResponseFunctionToolCall - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OpenAIResponseFunctionToolCall(components.OpenAIResponseFunctionToolCall{/* values here */}) -``` - -### OutputItemImageGenerationCall - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OutputItemImageGenerationCall(components.OutputItemImageGenerationCall{/* values here */}) -``` - -### OutputMessage - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OutputMessage(components.OutputMessage{/* values here */}) -``` - -### OpenAIResponseCustomToolCall - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OpenAIResponseCustomToolCall(components.OpenAIResponseCustomToolCall{/* values here */}) -``` - -### OpenAIResponseCustomToolCallOutput - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1OpenAIResponseCustomToolCallOutput(components.OpenAIResponseCustomToolCallOutput{/* values here */}) -``` - -### ApplyPatchCallItem - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1ApplyPatchCallItem(components.ApplyPatchCallItem{/* values here */}) -``` - -### ApplyPatchCallOutputItem - -```go lines -baseInputsUnion1 := components.CreateBaseInputsUnion1ApplyPatchCallOutputItem(components.ApplyPatchCallOutputItem{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch baseInputsUnion1.Type { - case components.BaseInputsUnion1TypeBaseInputsMessage: - // baseInputsUnion1.BaseInputsMessage is populated - case components.BaseInputsUnion1TypeOpenAIResponseInputMessageItem: - // baseInputsUnion1.OpenAIResponseInputMessageItem is populated - case components.BaseInputsUnion1TypeOpenAIResponseFunctionToolCallOutput: - // baseInputsUnion1.OpenAIResponseFunctionToolCallOutput is populated - case components.BaseInputsUnion1TypeOpenAIResponseFunctionToolCall: - // baseInputsUnion1.OpenAIResponseFunctionToolCall is populated - case components.BaseInputsUnion1TypeOutputItemImageGenerationCall: - // baseInputsUnion1.OutputItemImageGenerationCall is populated - case components.BaseInputsUnion1TypeOutputMessage: - // baseInputsUnion1.OutputMessage is populated - case components.BaseInputsUnion1TypeOpenAIResponseCustomToolCall: - // baseInputsUnion1.OpenAIResponseCustomToolCall is populated - case components.BaseInputsUnion1TypeOpenAIResponseCustomToolCallOutput: - // baseInputsUnion1.OpenAIResponseCustomToolCallOutput is populated - case components.BaseInputsUnion1TypeApplyPatchCallItem: - // baseInputsUnion1.ApplyPatchCallItem is populated - case components.BaseInputsUnion1TypeApplyPatchCallOutputItem: - // baseInputsUnion1.ApplyPatchCallOutputItem is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/basereasoningconfig.mdx b/client-sdks/go/api-reference/models/basereasoningconfig.mdx deleted file mode 100644 index 945dd99f..00000000 --- a/client-sdks/go/api-reference/models/basereasoningconfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseReasoningConfig - Go SDK -sidebarTitle: BaseReasoningConfig -description: BaseReasoningConfig type definition -seoTitle: BaseReasoningConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/basereasoningconfig' -'og:site_name': OpenRouter Documentation -'og:title': BaseReasoningConfig Type | OpenRouter Go SDK -'og:description': >- - BaseReasoningConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseReasoningConfig%20-%20Go%20SDK&description=BaseReasoningConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](/client-sdks/go/api-reference/models/reasoningeffort)] | :heavy_minus_sign: | N/A | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](/client-sdks/go/api-reference/models/reasoningsummaryverbosity)] | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkaddworkspacemembersrequest.mdx b/client-sdks/go/api-reference/models/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index 1a318dc7..00000000 --- a/client-sdks/go/api-reference/models/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - Go SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest type definition -seoTitle: BulkAddWorkspaceMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAddWorkspaceMembersRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20Go%20SDK&description=BulkAddWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkaddworkspacemembersresponse.mdx b/client-sdks/go/api-reference/models/bulkaddworkspacemembersresponse.mdx deleted file mode 100644 index 1992b099..00000000 --- a/client-sdks/go/api-reference/models/bulkaddworkspacemembersresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAddWorkspaceMembersResponse - Go SDK -sidebarTitle: BulkAddWorkspaceMembersResponse -description: BulkAddWorkspaceMembersResponse type definition -seoTitle: BulkAddWorkspaceMembersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkaddworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersResponse Type | OpenRouter Go SDK -'og:description': >- - BulkAddWorkspaceMembersResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersResponse%20-%20Go%20SDK&description=BulkAddWorkspaceMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `AddedCount` | `int64` | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `Data` | [][components.WorkspaceMember](/client-sdks/go/api-reference/models/workspacemember) | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkassignkeysrequest.mdx b/client-sdks/go/api-reference/models/bulkassignkeysrequest.mdx deleted file mode 100644 index a4a71744..00000000 --- a/client-sdks/go/api-reference/models/bulkassignkeysrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkAssignKeysRequest - Go SDK -sidebarTitle: BulkAssignKeysRequest -description: BulkAssignKeysRequest type definition -seoTitle: BulkAssignKeysRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/bulkassignkeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAssignKeysRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysRequest%20-%20Go%20SDK&description=BulkAssignKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkassignkeysresponse.mdx b/client-sdks/go/api-reference/models/bulkassignkeysresponse.mdx deleted file mode 100644 index 574bbab0..00000000 --- a/client-sdks/go/api-reference/models/bulkassignkeysresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkAssignKeysResponse - Go SDK -sidebarTitle: BulkAssignKeysResponse -description: BulkAssignKeysResponse type definition -seoTitle: BulkAssignKeysResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/bulkassignkeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysResponse Type | OpenRouter Go SDK -'og:description': >- - BulkAssignKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysResponse%20-%20Go%20SDK&description=BulkAssignKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `AssignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkassignmembersrequest.mdx b/client-sdks/go/api-reference/models/bulkassignmembersrequest.mdx deleted file mode 100644 index 339b5654..00000000 --- a/client-sdks/go/api-reference/models/bulkassignmembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignMembersRequest - Go SDK -sidebarTitle: BulkAssignMembersRequest -description: BulkAssignMembersRequest type definition -seoTitle: BulkAssignMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAssignMembersRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersRequest%20-%20Go%20SDK&description=BulkAssignMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkassignmembersresponse.mdx b/client-sdks/go/api-reference/models/bulkassignmembersresponse.mdx deleted file mode 100644 index 7534d6cc..00000000 --- a/client-sdks/go/api-reference/models/bulkassignmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignMembersResponse - Go SDK -sidebarTitle: BulkAssignMembersResponse -description: BulkAssignMembersResponse type definition -seoTitle: BulkAssignMembersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersResponse Type | OpenRouter Go SDK -'og:description': >- - BulkAssignMembersResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersResponse%20-%20Go%20SDK&description=BulkAssignMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `AssignedCount` | `int64` | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkremoveworkspacemembersrequest.mdx b/client-sdks/go/api-reference/models/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index de87f50b..00000000 --- a/client-sdks/go/api-reference/models/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - Go SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest type definition -seoTitle: BulkRemoveWorkspaceMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20Go%20SDK&description=BulkRemoveWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `UserIds` | []`string` | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkremoveworkspacemembersresponse.mdx b/client-sdks/go/api-reference/models/bulkremoveworkspacemembersresponse.mdx deleted file mode 100644 index 2dc63a95..00000000 --- a/client-sdks/go/api-reference/models/bulkremoveworkspacemembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersResponse - Go SDK -sidebarTitle: BulkRemoveWorkspaceMembersResponse -description: BulkRemoveWorkspaceMembersResponse type definition -seoTitle: BulkRemoveWorkspaceMembersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkremoveworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersResponse Type | OpenRouter Go SDK -'og:description': >- - BulkRemoveWorkspaceMembersResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersResponse%20-%20Go%20SDK&description=BulkRemoveWorkspaceMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `RemovedCount` | `int64` | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkunassignkeysrequest.mdx b/client-sdks/go/api-reference/models/bulkunassignkeysrequest.mdx deleted file mode 100644 index f0221508..00000000 --- a/client-sdks/go/api-reference/models/bulkunassignkeysrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignKeysRequest - Go SDK -sidebarTitle: BulkUnassignKeysRequest -description: BulkUnassignKeysRequest type definition -seoTitle: BulkUnassignKeysRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkunassignkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysRequest Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignKeysRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysRequest%20-%20Go%20SDK&description=BulkUnassignKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `KeyHashes` | []`string` | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkunassignkeysresponse.mdx b/client-sdks/go/api-reference/models/bulkunassignkeysresponse.mdx deleted file mode 100644 index 911c7c05..00000000 --- a/client-sdks/go/api-reference/models/bulkunassignkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignKeysResponse - Go SDK -sidebarTitle: BulkUnassignKeysResponse -description: BulkUnassignKeysResponse type definition -seoTitle: BulkUnassignKeysResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkunassignkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysResponse Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignKeysResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysResponse%20-%20Go%20SDK&description=BulkUnassignKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkunassignmembersrequest.mdx b/client-sdks/go/api-reference/models/bulkunassignmembersrequest.mdx deleted file mode 100644 index f83bf06a..00000000 --- a/client-sdks/go/api-reference/models/bulkunassignmembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignMembersRequest - Go SDK -sidebarTitle: BulkUnassignMembersRequest -description: BulkUnassignMembersRequest type definition -seoTitle: BulkUnassignMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkunassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignMembersRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersRequest%20-%20Go%20SDK&description=BulkUnassignMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `MemberUserIds` | []`string` | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/bulkunassignmembersresponse.mdx b/client-sdks/go/api-reference/models/bulkunassignmembersresponse.mdx deleted file mode 100644 index bbffd512..00000000 --- a/client-sdks/go/api-reference/models/bulkunassignmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignMembersResponse - Go SDK -sidebarTitle: BulkUnassignMembersResponse -description: BulkUnassignMembersResponse type definition -seoTitle: BulkUnassignMembersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/bulkunassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersResponse Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignMembersResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersResponse%20-%20Go%20SDK&description=BulkUnassignMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `UnassignedCount` | `int64` | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/by.mdx b/client-sdks/go/api-reference/models/by.mdx deleted file mode 100644 index c80a8ae8..00000000 --- a/client-sdks/go/api-reference/models/by.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: By - Go SDK -sidebarTitle: By -description: By type definition -seoTitle: By Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/by' -'og:site_name': OpenRouter Documentation -'og:title': By Type | OpenRouter Go SDK -'og:description': >- - By type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=By%20-%20Go%20SDK&description=By%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ByPrice - -// Open enum: custom values can be created with a direct type cast -custom := components.By("custom_value") -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `ByPrice` | price | -| `ByThroughput` | throughput | -| `ByLatency` | latency | -| `ByExacto` | exacto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/byokkey.mdx b/client-sdks/go/api-reference/models/byokkey.mdx deleted file mode 100644 index 4d61596f..00000000 --- a/client-sdks/go/api-reference/models/byokkey.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BYOKKey - Go SDK -sidebarTitle: BYOKKey -description: BYOKKey type definition -seoTitle: BYOKKey Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/byokkey' -'og:site_name': OpenRouter Documentation -'og:title': BYOKKey Type | OpenRouter Go SDK -'og:description': >- - BYOKKey type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKKey%20-%20Go%20SDK&description=BYOKKey%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedAPIKeyHashes` | []`string` | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `AllowedModels` | []`string` | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `AllowedUserIds` | []`string` | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `Disabled` | `bool` | :heavy_check_mark: | Whether this credential is currently disabled. | false | -| `ID` | `string` | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/byokproviderslug.mdx b/client-sdks/go/api-reference/models/byokproviderslug.mdx deleted file mode 100644 index 533a39fd..00000000 --- a/client-sdks/go/api-reference/models/byokproviderslug.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: BYOKProviderSlug - Go SDK -sidebarTitle: BYOKProviderSlug -description: BYOKProviderSlug type definition -seoTitle: BYOKProviderSlug Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/byokproviderslug' -'og:site_name': OpenRouter Documentation -'og:title': BYOKProviderSlug Type | OpenRouter Go SDK -'og:description': >- - BYOKProviderSlug type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKProviderSlug%20-%20Go%20SDK&description=BYOKProviderSlug%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.BYOKProviderSlugAi21 - -// Open enum: custom values can be created with a direct type cast -custom := components.BYOKProviderSlug("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `BYOKProviderSlugAi21` | ai21 | -| `BYOKProviderSlugAionLabs` | aion-labs | -| `BYOKProviderSlugAkashml` | akashml | -| `BYOKProviderSlugAlibaba` | alibaba | -| `BYOKProviderSlugAmazonBedrock` | amazon-bedrock | -| `BYOKProviderSlugAmazonNova` | amazon-nova | -| `BYOKProviderSlugAmbient` | ambient | -| `BYOKProviderSlugAnthropic` | anthropic | -| `BYOKProviderSlugArceeAi` | arcee-ai | -| `BYOKProviderSlugAtlasCloud` | atlas-cloud | -| `BYOKProviderSlugAvian` | avian | -| `BYOKProviderSlugAzure` | azure | -| `BYOKProviderSlugBaidu` | baidu | -| `BYOKProviderSlugBaseten` | baseten | -| `BYOKProviderSlugBlackForestLabs` | black-forest-labs | -| `BYOKProviderSlugByteplus` | byteplus | -| `BYOKProviderSlugCerebras` | cerebras | -| `BYOKProviderSlugChutes` | chutes | -| `BYOKProviderSlugCirrascale` | cirrascale | -| `BYOKProviderSlugClarifai` | clarifai | -| `BYOKProviderSlugCloudflare` | cloudflare | -| `BYOKProviderSlugCohere` | cohere | -| `BYOKProviderSlugCrusoe` | crusoe | -| `BYOKProviderSlugDarkbloom` | darkbloom | -| `BYOKProviderSlugDeepinfra` | deepinfra | -| `BYOKProviderSlugDeepseek` | deepseek | -| `BYOKProviderSlugDekallm` | dekallm | -| `BYOKProviderSlugDigitalocean` | digitalocean | -| `BYOKProviderSlugFeatherless` | featherless | -| `BYOKProviderSlugFireworks` | fireworks | -| `BYOKProviderSlugFriendli` | friendli | -| `BYOKProviderSlugGmicloud` | gmicloud | -| `BYOKProviderSlugGoogleAiStudio` | google-ai-studio | -| `BYOKProviderSlugGoogleVertex` | google-vertex | -| `BYOKProviderSlugGroq` | groq | -| `BYOKProviderSlugHyperbolic` | hyperbolic | -| `BYOKProviderSlugInception` | inception | -| `BYOKProviderSlugInceptron` | inceptron | -| `BYOKProviderSlugInferenceNet` | inference-net | -| `BYOKProviderSlugInfermatic` | infermatic | -| `BYOKProviderSlugInflection` | inflection | -| `BYOKProviderSlugIoNet` | io-net | -| `BYOKProviderSlugIonstream` | ionstream | -| `BYOKProviderSlugLiquid` | liquid | -| `BYOKProviderSlugMancer` | mancer | -| `BYOKProviderSlugMara` | mara | -| `BYOKProviderSlugMinimax` | minimax | -| `BYOKProviderSlugMistral` | mistral | -| `BYOKProviderSlugModelrun` | modelrun | -| `BYOKProviderSlugModular` | modular | -| `BYOKProviderSlugMoonshotai` | moonshotai | -| `BYOKProviderSlugMorph` | morph | -| `BYOKProviderSlugNcompass` | ncompass | -| `BYOKProviderSlugNebius` | nebius | -| `BYOKProviderSlugNexAgi` | nex-agi | -| `BYOKProviderSlugNextbit` | nextbit | -| `BYOKProviderSlugNovita` | novita | -| `BYOKProviderSlugNvidia` | nvidia | -| `BYOKProviderSlugOpenInference` | open-inference | -| `BYOKProviderSlugOpenai` | openai | -| `BYOKProviderSlugParasail` | parasail | -| `BYOKProviderSlugPerceptron` | perceptron | -| `BYOKProviderSlugPerplexity` | perplexity | -| `BYOKProviderSlugPhala` | phala | -| `BYOKProviderSlugPoolside` | poolside | -| `BYOKProviderSlugRecraft` | recraft | -| `BYOKProviderSlugReka` | reka | -| `BYOKProviderSlugRelace` | relace | -| `BYOKProviderSlugSambanova` | sambanova | -| `BYOKProviderSlugSeed` | seed | -| `BYOKProviderSlugSiliconflow` | siliconflow | -| `BYOKProviderSlugSourceful` | sourceful | -| `BYOKProviderSlugStepfun` | stepfun | -| `BYOKProviderSlugStreamlake` | streamlake | -| `BYOKProviderSlugSwitchpoint` | switchpoint | -| `BYOKProviderSlugTogether` | together | -| `BYOKProviderSlugUpstage` | upstage | -| `BYOKProviderSlugVenice` | venice | -| `BYOKProviderSlugWandb` | wandb | -| `BYOKProviderSlugXai` | xai | -| `BYOKProviderSlugXiaomi` | xiaomi | -| `BYOKProviderSlugZAi` | z-ai | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/caching.mdx b/client-sdks/go/api-reference/models/caching.mdx deleted file mode 100644 index e37bf70d..00000000 --- a/client-sdks/go/api-reference/models/caching.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Caching - Go SDK -sidebarTitle: Caching -description: Caching type definition -seoTitle: Caching Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/caching' -'og:site_name': OpenRouter Documentation -'og:title': Caching Type | OpenRouter Go SDK -'og:description': >- - Caching type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Caching%20-%20Go%20SDK&description=Caching%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `TTL` | [*components.AnthropicCacheControlTTL](/client-sdks/go/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.ToolTypeEphemeral](/client-sdks/go/api-reference/models/tooltypeephemeral) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatassistantimages.mdx b/client-sdks/go/api-reference/models/chatassistantimages.mdx deleted file mode 100644 index 5116812c..00000000 --- a/client-sdks/go/api-reference/models/chatassistantimages.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatAssistantImages - Go SDK -sidebarTitle: ChatAssistantImages -description: ChatAssistantImages type definition -seoTitle: ChatAssistantImages Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatassistantimages' -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImages Type | OpenRouter Go SDK -'og:description': >- - ChatAssistantImages type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImages%20-%20Go%20SDK&description=ChatAssistantImages%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatAssistantImagesImageURL](/client-sdks/go/api-reference/models/chatassistantimagesimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatassistantimagesimageurl.mdx b/client-sdks/go/api-reference/models/chatassistantimagesimageurl.mdx deleted file mode 100644 index 9c961e2b..00000000 --- a/client-sdks/go/api-reference/models/chatassistantimagesimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatAssistantImagesImageURL - Go SDK -sidebarTitle: ChatAssistantImagesImageURL -description: ChatAssistantImagesImageURL type definition -seoTitle: ChatAssistantImagesImageURL Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatassistantimagesimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImagesImageURL Type | OpenRouter Go SDK -'og:description': >- - ChatAssistantImagesImageURL type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImagesImageURL%20-%20Go%20SDK&description=ChatAssistantImagesImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `URL` | `string` | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatassistantmessage.mdx b/client-sdks/go/api-reference/models/chatassistantmessage.mdx deleted file mode 100644 index 05a85178..00000000 --- a/client-sdks/go/api-reference/models/chatassistantmessage.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatAssistantMessage - Go SDK -sidebarTitle: ChatAssistantMessage -description: ChatAssistantMessage type definition -seoTitle: ChatAssistantMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatassistantmessage' -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessage Type | OpenRouter Go SDK -'og:description': >- - ChatAssistantMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessage%20-%20Go%20SDK&description=ChatAssistantMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Assistant message for requests and responses - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatassistantmessagecontent)] | :heavy_minus_sign: | Assistant message content | | -| `Images` | [][components.ChatAssistantImages](/client-sdks/go/api-reference/models/chatassistantimages) | :heavy_minus_sign: | Generated images from image generation models | [
`{"image_url": {"url": "data:image/png;base64,iVBORw0KGgo..."}`
\}
] | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the assistant | | -| `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning output | | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](/client-sdks/go/api-reference/models/reasoningdetailunion) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"thinking": "Let me work through this step by step...","type": "thinking"}`
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message if content was refused | | -| `Role` | [components.ChatAssistantMessageRole](/client-sdks/go/api-reference/models/chatassistantmessagerole) | :heavy_check_mark: | N/A | | -| `ToolCalls` | [][components.ChatToolCall](/client-sdks/go/api-reference/models/chattoolcall) | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatassistantmessagecontent.mdx b/client-sdks/go/api-reference/models/chatassistantmessagecontent.mdx deleted file mode 100644 index 1729a521..00000000 --- a/client-sdks/go/api-reference/models/chatassistantmessagecontent.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ChatAssistantMessageContent - Go SDK -sidebarTitle: ChatAssistantMessageContent -description: ChatAssistantMessageContent type definition -seoTitle: ChatAssistantMessageContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatassistantmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageContent Type | OpenRouter Go SDK -'og:description': >- - ChatAssistantMessageContent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageContent%20-%20Go%20SDK&description=ChatAssistantMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Assistant message content - -## Supported Types - -### - -```go lines -chatAssistantMessageContent := components.CreateChatAssistantMessageContentStr(string{/* values here */}) -``` - -### - -```go lines -chatAssistantMessageContent := components.CreateChatAssistantMessageContentArrayOfChatContentItems([]components.ChatContentItems{/* values here */}) -``` - -### - -```go lines -chatAssistantMessageContent := components.CreateChatAssistantMessageContentAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatAssistantMessageContent.Type { - case components.ChatAssistantMessageContentTypeStr: - // chatAssistantMessageContent.Str is populated - case components.ChatAssistantMessageContentTypeArrayOfChatContentItems: - // chatAssistantMessageContent.ArrayOfChatContentItems is populated - case components.ChatAssistantMessageContentTypeAny: - // chatAssistantMessageContent.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatassistantmessagerole.mdx b/client-sdks/go/api-reference/models/chatassistantmessagerole.mdx deleted file mode 100644 index 7417d1d1..00000000 --- a/client-sdks/go/api-reference/models/chatassistantmessagerole.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatAssistantMessageRole - Go SDK -sidebarTitle: ChatAssistantMessageRole -description: ChatAssistantMessageRole type definition -seoTitle: ChatAssistantMessageRole Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatassistantmessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageRole Type | OpenRouter Go SDK -'og:description': >- - ChatAssistantMessageRole type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageRole%20-%20Go%20SDK&description=ChatAssistantMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatAssistantMessageRoleAssistant -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ChatAssistantMessageRoleAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chataudiooutput.mdx b/client-sdks/go/api-reference/models/chataudiooutput.mdx deleted file mode 100644 index 337b60b3..00000000 --- a/client-sdks/go/api-reference/models/chataudiooutput.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatAudioOutput - Go SDK -sidebarTitle: ChatAudioOutput -description: ChatAudioOutput type definition -seoTitle: ChatAudioOutput Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chataudiooutput' -'og:site_name': OpenRouter Documentation -'og:title': ChatAudioOutput Type | OpenRouter Go SDK -'og:description': >- - ChatAudioOutput type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAudioOutput%20-%20Go%20SDK&description=ChatAudioOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Audio output data or reference - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `Data` | `*string` | :heavy_minus_sign: | Base64 encoded audio data | -| `ExpiresAt` | `*int64` | :heavy_minus_sign: | Audio expiration timestamp | -| `ID` | `*string` | :heavy_minus_sign: | Audio output identifier | -| `Transcript` | `*string` | :heavy_minus_sign: | Audio transcript | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatchoice.mdx b/client-sdks/go/api-reference/models/chatchoice.mdx deleted file mode 100644 index 2b82114b..00000000 --- a/client-sdks/go/api-reference/models/chatchoice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatChoice - Go SDK -sidebarTitle: ChatChoice -description: ChatChoice type definition -seoTitle: ChatChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatChoice Type | OpenRouter Go SDK -'og:description': >- - ChatChoice type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatChoice%20-%20Go%20SDK&description=ChatChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Chat completion choice - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FinishReason` | [*components.ChatFinishReasonEnum](/client-sdks/go/api-reference/models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | -| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](/client-sdks/go/api-reference/models/chattokenlogprobs)] | :heavy_minus_sign: | Log probabilities for the completion | `{"content": [{"bytes": null,"logprob": -0.612345,"token": " Hello","top_logprobs": []}`
],
"refusal": `null
`\} | -| `Message` | [components.ChatAssistantMessage](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/chatcontentaudio.mdx b/client-sdks/go/api-reference/models/chatcontentaudio.mdx deleted file mode 100644 index ec1f4e45..00000000 --- a/client-sdks/go/api-reference/models/chatcontentaudio.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatContentAudio - Go SDK -sidebarTitle: ChatContentAudio -description: ChatContentAudio type definition -seoTitle: ChatContentAudio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentaudio' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudio Type | OpenRouter Go SDK -'og:description': >- - ChatContentAudio type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudio%20-%20Go%20SDK&description=ChatContentAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Audio input content part. Supported audio formats vary by provider. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.ChatContentAudioInputAudio](/client-sdks/go/api-reference/models/chatcontentaudioinputaudio) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentAudioType](/client-sdks/go/api-reference/models/chatcontentaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentaudioinputaudio.mdx b/client-sdks/go/api-reference/models/chatcontentaudioinputaudio.mdx deleted file mode 100644 index 8efec062..00000000 --- a/client-sdks/go/api-reference/models/chatcontentaudioinputaudio.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatContentAudioInputAudio - Go SDK -sidebarTitle: ChatContentAudioInputAudio -description: ChatContentAudioInputAudio type definition -seoTitle: ChatContentAudioInputAudio Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatcontentaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudioInputAudio Type | OpenRouter Go SDK -'og:description': >- - ChatContentAudioInputAudio type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudioInputAudio%20-%20Go%20SDK&description=ChatContentAudioInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | Base64 encoded audio data | -| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentaudiotype.mdx b/client-sdks/go/api-reference/models/chatcontentaudiotype.mdx deleted file mode 100644 index 39802713..00000000 --- a/client-sdks/go/api-reference/models/chatcontentaudiotype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatContentAudioType - Go SDK -sidebarTitle: ChatContentAudioType -description: ChatContentAudioType type definition -seoTitle: ChatContentAudioType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentaudiotype' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudioType Type | OpenRouter Go SDK -'og:description': >- - ChatContentAudioType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudioType%20-%20Go%20SDK&description=ChatContentAudioType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentAudioTypeInputAudio -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ChatContentAudioTypeInputAudio` | input_audio | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentcachecontrol.mdx b/client-sdks/go/api-reference/models/chatcontentcachecontrol.mdx deleted file mode 100644 index b31c4c58..00000000 --- a/client-sdks/go/api-reference/models/chatcontentcachecontrol.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentCacheControl - Go SDK -sidebarTitle: ChatContentCacheControl -description: ChatContentCacheControl type definition -seoTitle: ChatContentCacheControl Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatcontentcachecontrol -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControl Type | OpenRouter Go SDK -'og:description': >- - ChatContentCacheControl type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControl%20-%20Go%20SDK&description=ChatContentCacheControl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Cache control for the content part - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `TTL` | [*components.AnthropicCacheControlTTL](/client-sdks/go/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.ChatContentCacheControlType](/client-sdks/go/api-reference/models/chatcontentcachecontroltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentcachecontroltype.mdx b/client-sdks/go/api-reference/models/chatcontentcachecontroltype.mdx deleted file mode 100644 index b9152164..00000000 --- a/client-sdks/go/api-reference/models/chatcontentcachecontroltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatContentCacheControlType - Go SDK -sidebarTitle: ChatContentCacheControlType -description: ChatContentCacheControlType type definition -seoTitle: ChatContentCacheControlType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatcontentcachecontroltype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControlType Type | OpenRouter Go SDK -'og:description': >- - ChatContentCacheControlType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControlType%20-%20Go%20SDK&description=ChatContentCacheControlType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentCacheControlTypeEphemeral -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `ChatContentCacheControlTypeEphemeral` | ephemeral | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentfile.mdx b/client-sdks/go/api-reference/models/chatcontentfile.mdx deleted file mode 100644 index f588b7c7..00000000 --- a/client-sdks/go/api-reference/models/chatcontentfile.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatContentFile - Go SDK -sidebarTitle: ChatContentFile -description: ChatContentFile type definition -seoTitle: ChatContentFile Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentfile' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentFile Type | OpenRouter Go SDK -'og:description': >- - ChatContentFile type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentFile%20-%20Go%20SDK&description=ChatContentFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -File content part for document processing - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `File` | [components.File](/client-sdks/go/api-reference/models/file) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentFileType](/client-sdks/go/api-reference/models/chatcontentfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentfiletype.mdx b/client-sdks/go/api-reference/models/chatcontentfiletype.mdx deleted file mode 100644 index aded4615..00000000 --- a/client-sdks/go/api-reference/models/chatcontentfiletype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatContentFileType - Go SDK -sidebarTitle: ChatContentFileType -description: ChatContentFileType type definition -seoTitle: ChatContentFileType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentfiletype' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentFileType Type | OpenRouter Go SDK -'og:description': >- - ChatContentFileType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentFileType%20-%20Go%20SDK&description=ChatContentFileType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentFileTypeFile -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `ChatContentFileTypeFile` | file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentimage.mdx b/client-sdks/go/api-reference/models/chatcontentimage.mdx deleted file mode 100644 index bd08b832..00000000 --- a/client-sdks/go/api-reference/models/chatcontentimage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatContentImage - Go SDK -sidebarTitle: ChatContentImage -description: ChatContentImage type definition -seoTitle: ChatContentImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentimage' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImage Type | OpenRouter Go SDK -'og:description': >- - ChatContentImage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImage%20-%20Go%20SDK&description=ChatContentImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image content part for vision models - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatContentImageImageURL](/client-sdks/go/api-reference/models/chatcontentimageimageurl) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentImageType](/client-sdks/go/api-reference/models/chatcontentimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentimagedetail.mdx b/client-sdks/go/api-reference/models/chatcontentimagedetail.mdx deleted file mode 100644 index 2899615d..00000000 --- a/client-sdks/go/api-reference/models/chatcontentimagedetail.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatContentImageDetail - Go SDK -sidebarTitle: ChatContentImageDetail -description: ChatContentImageDetail type definition -seoTitle: ChatContentImageDetail Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentimagedetail' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageDetail Type | OpenRouter Go SDK -'og:description': >- - ChatContentImageDetail type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageDetail%20-%20Go%20SDK&description=ChatContentImageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image detail level for vision models - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentImageDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatContentImageDetail("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `ChatContentImageDetailAuto` | auto | -| `ChatContentImageDetailLow` | low | -| `ChatContentImageDetailHigh` | high | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentimageimageurl.mdx b/client-sdks/go/api-reference/models/chatcontentimageimageurl.mdx deleted file mode 100644 index f881c2fa..00000000 --- a/client-sdks/go/api-reference/models/chatcontentimageimageurl.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatContentImageImageURL - Go SDK -sidebarTitle: ChatContentImageImageURL -description: ChatContentImageImageURL type definition -seoTitle: ChatContentImageImageURL Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatcontentimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageImageURL Type | OpenRouter Go SDK -'og:description': >- - ChatContentImageImageURL type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageImageURL%20-%20Go%20SDK&description=ChatContentImageImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `Detail` | [*components.ChatContentImageDetail](/client-sdks/go/api-reference/models/chatcontentimagedetail) | :heavy_minus_sign: | Image detail level for vision models | -| `URL` | `string` | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentimagetype.mdx b/client-sdks/go/api-reference/models/chatcontentimagetype.mdx deleted file mode 100644 index 45ea9878..00000000 --- a/client-sdks/go/api-reference/models/chatcontentimagetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatContentImageType - Go SDK -sidebarTitle: ChatContentImageType -description: ChatContentImageType type definition -seoTitle: ChatContentImageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentimagetype' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageType Type | OpenRouter Go SDK -'og:description': >- - ChatContentImageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageType%20-%20Go%20SDK&description=ChatContentImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentImageTypeImageURL -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ChatContentImageTypeImageURL` | image_url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentitems.mdx b/client-sdks/go/api-reference/models/chatcontentitems.mdx deleted file mode 100644 index 4d76a61e..00000000 --- a/client-sdks/go/api-reference/models/chatcontentitems.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: ChatContentItems - Go SDK -sidebarTitle: ChatContentItems -description: ChatContentItems type definition -seoTitle: ChatContentItems Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentitems' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentItems Type | OpenRouter Go SDK -'og:description': >- - ChatContentItems type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentItems%20-%20Go%20SDK&description=ChatContentItems%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Content part for chat completion messages - -## Supported Types - -### ChatContentFile - -```go lines -chatContentItems := components.CreateChatContentItemsFile(components.ChatContentFile{/* values here */}) -``` - -### ChatContentImage - -```go lines -chatContentItems := components.CreateChatContentItemsImageURL(components.ChatContentImage{/* values here */}) -``` - -### ChatContentAudio - -```go lines -chatContentItems := components.CreateChatContentItemsInputAudio(components.ChatContentAudio{/* values here */}) -``` - -### LegacyChatContentVideo - -```go lines -chatContentItems := components.CreateChatContentItemsInputVideo(components.LegacyChatContentVideo{/* values here */}) -``` - -### ChatContentText - -```go lines -chatContentItems := components.CreateChatContentItemsText(components.ChatContentText{/* values here */}) -``` - -### ChatContentVideo - -```go lines -chatContentItems := components.CreateChatContentItemsVideoURL(components.ChatContentVideo{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatContentItems.Type { - case components.ChatContentItemsTypeFile: - // chatContentItems.ChatContentFile is populated - case components.ChatContentItemsTypeImageURL: - // chatContentItems.ChatContentImage is populated - case components.ChatContentItemsTypeInputAudio: - // chatContentItems.ChatContentAudio is populated - case components.ChatContentItemsTypeInputVideo: - // chatContentItems.LegacyChatContentVideo is populated - case components.ChatContentItemsTypeText: - // chatContentItems.ChatContentText is populated - case components.ChatContentItemsTypeVideoURL: - // chatContentItems.ChatContentVideo is populated - default: - // Unknown type - use chatContentItems.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontenttext.mdx b/client-sdks/go/api-reference/models/chatcontenttext.mdx deleted file mode 100644 index da6e2f7b..00000000 --- a/client-sdks/go/api-reference/models/chatcontenttext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentText - Go SDK -sidebarTitle: ChatContentText -description: ChatContentText type definition -seoTitle: ChatContentText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontenttext' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentText Type | OpenRouter Go SDK -'og:description': >- - ChatContentText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentText%20-%20Go%20SDK&description=ChatContentText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text content part - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](/client-sdks/go/api-reference/models/chatcontentcachecontrol) | :heavy_minus_sign: | Cache control for the content part | `{"ttl": "5m","type": "ephemeral"}` | -| `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ChatContentTextType](/client-sdks/go/api-reference/models/chatcontenttexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontenttexttype.mdx b/client-sdks/go/api-reference/models/chatcontenttexttype.mdx deleted file mode 100644 index e4ea1ee8..00000000 --- a/client-sdks/go/api-reference/models/chatcontenttexttype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatContentTextType - Go SDK -sidebarTitle: ChatContentTextType -description: ChatContentTextType type definition -seoTitle: ChatContentTextType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontenttexttype' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentTextType Type | OpenRouter Go SDK -'og:description': >- - ChatContentTextType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentTextType%20-%20Go%20SDK&description=ChatContentTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentTextTypeText -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `ChatContentTextTypeText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentvideo.mdx b/client-sdks/go/api-reference/models/chatcontentvideo.mdx deleted file mode 100644 index 98850f7e..00000000 --- a/client-sdks/go/api-reference/models/chatcontentvideo.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatContentVideo - Go SDK -sidebarTitle: ChatContentVideo -description: ChatContentVideo type definition -seoTitle: ChatContentVideo Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentvideo' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideo Type | OpenRouter Go SDK -'og:description': >- - ChatContentVideo type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideo%20-%20Go%20SDK&description=ChatContentVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Video input content part - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.ChatContentVideoType](/client-sdks/go/api-reference/models/chatcontentvideotype) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.ChatContentVideoInput](/client-sdks/go/api-reference/models/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentvideoinput.mdx b/client-sdks/go/api-reference/models/chatcontentvideoinput.mdx deleted file mode 100644 index 18afe742..00000000 --- a/client-sdks/go/api-reference/models/chatcontentvideoinput.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatContentVideoInput - Go SDK -sidebarTitle: ChatContentVideoInput -description: ChatContentVideoInput type definition -seoTitle: ChatContentVideoInput Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentvideoinput' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideoInput Type | OpenRouter Go SDK -'og:description': >- - ChatContentVideoInput type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideoInput%20-%20Go%20SDK&description=ChatContentVideoInput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Video input object - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `URL` | `string` | :heavy_check_mark: | URL of the video (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatcontentvideotype.mdx b/client-sdks/go/api-reference/models/chatcontentvideotype.mdx deleted file mode 100644 index b550b6f9..00000000 --- a/client-sdks/go/api-reference/models/chatcontentvideotype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatContentVideoType - Go SDK -sidebarTitle: ChatContentVideoType -description: ChatContentVideoType type definition -seoTitle: ChatContentVideoType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatcontentvideotype' -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideoType Type | OpenRouter Go SDK -'og:description': >- - ChatContentVideoType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideoType%20-%20Go%20SDK&description=ChatContentVideoType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatContentVideoTypeVideoURL -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ChatContentVideoTypeVideoURL` | video_url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatdebugoptions.mdx b/client-sdks/go/api-reference/models/chatdebugoptions.mdx deleted file mode 100644 index 75be410f..00000000 --- a/client-sdks/go/api-reference/models/chatdebugoptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatDebugOptions - Go SDK -sidebarTitle: ChatDebugOptions -description: ChatDebugOptions type definition -seoTitle: ChatDebugOptions Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatdebugoptions' -'og:site_name': OpenRouter Documentation -'og:title': ChatDebugOptions Type | OpenRouter Go SDK -'og:description': >- - ChatDebugOptions type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDebugOptions%20-%20Go%20SDK&description=ChatDebugOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Debug options for inspecting request transformations (streaming only) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `EchoUpstreamBody` | `*bool` | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatdevelopermessage.mdx b/client-sdks/go/api-reference/models/chatdevelopermessage.mdx deleted file mode 100644 index a310c311..00000000 --- a/client-sdks/go/api-reference/models/chatdevelopermessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatDeveloperMessage - Go SDK -sidebarTitle: ChatDeveloperMessage -description: ChatDeveloperMessage type definition -seoTitle: ChatDeveloperMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatdevelopermessage' -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessage Type | OpenRouter Go SDK -'og:description': >- - ChatDeveloperMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessage%20-%20Go%20SDK&description=ChatDeveloperMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Developer message - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Content` | [components.ChatDeveloperMessageContent](/client-sdks/go/api-reference/models/chatdevelopermessagecontent) | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `Role` | [components.ChatDeveloperMessageRole](/client-sdks/go/api-reference/models/chatdevelopermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatdevelopermessagecontent.mdx b/client-sdks/go/api-reference/models/chatdevelopermessagecontent.mdx deleted file mode 100644 index be0ac01c..00000000 --- a/client-sdks/go/api-reference/models/chatdevelopermessagecontent.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ChatDeveloperMessageContent - Go SDK -sidebarTitle: ChatDeveloperMessageContent -description: ChatDeveloperMessageContent type definition -seoTitle: ChatDeveloperMessageContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatdevelopermessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessageContent Type | OpenRouter Go SDK -'og:description': >- - ChatDeveloperMessageContent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessageContent%20-%20Go%20SDK&description=ChatDeveloperMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Developer message content - -## Supported Types - -### - -```go lines -chatDeveloperMessageContent := components.CreateChatDeveloperMessageContentStr(string{/* values here */}) -``` - -### - -```go lines -chatDeveloperMessageContent := components.CreateChatDeveloperMessageContentArrayOfChatContentText([]components.ChatContentText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatDeveloperMessageContent.Type { - case components.ChatDeveloperMessageContentTypeStr: - // chatDeveloperMessageContent.Str is populated - case components.ChatDeveloperMessageContentTypeArrayOfChatContentText: - // chatDeveloperMessageContent.ArrayOfChatContentText is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatdevelopermessagerole.mdx b/client-sdks/go/api-reference/models/chatdevelopermessagerole.mdx deleted file mode 100644 index ee815425..00000000 --- a/client-sdks/go/api-reference/models/chatdevelopermessagerole.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatDeveloperMessageRole - Go SDK -sidebarTitle: ChatDeveloperMessageRole -description: ChatDeveloperMessageRole type definition -seoTitle: ChatDeveloperMessageRole Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatdevelopermessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessageRole Type | OpenRouter Go SDK -'og:description': >- - ChatDeveloperMessageRole type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessageRole%20-%20Go%20SDK&description=ChatDeveloperMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatDeveloperMessageRoleDeveloper -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ChatDeveloperMessageRoleDeveloper` | developer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatfinishreasonenum.mdx b/client-sdks/go/api-reference/models/chatfinishreasonenum.mdx deleted file mode 100644 index d12cc719..00000000 --- a/client-sdks/go/api-reference/models/chatfinishreasonenum.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatFinishReasonEnum - Go SDK -sidebarTitle: ChatFinishReasonEnum -description: ChatFinishReasonEnum type definition -seoTitle: ChatFinishReasonEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatfinishreasonenum' -'og:site_name': OpenRouter Documentation -'og:title': ChatFinishReasonEnum Type | OpenRouter Go SDK -'og:description': >- - ChatFinishReasonEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFinishReasonEnum%20-%20Go%20SDK&description=ChatFinishReasonEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFinishReasonEnumToolCalls - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatFinishReasonEnum("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ChatFinishReasonEnumToolCalls` | tool_calls | -| `ChatFinishReasonEnumStop` | stop | -| `ChatFinishReasonEnumLength` | length | -| `ChatFinishReasonEnumContentFilter` | content_filter | -| `ChatFinishReasonEnumError` | error | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatgrammarconfig.mdx b/client-sdks/go/api-reference/models/chatformatgrammarconfig.mdx deleted file mode 100644 index 9de3dc23..00000000 --- a/client-sdks/go/api-reference/models/chatformatgrammarconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatFormatGrammarConfig - Go SDK -sidebarTitle: ChatFormatGrammarConfig -description: ChatFormatGrammarConfig type definition -seoTitle: ChatFormatGrammarConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformatgrammarconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatGrammarConfig Type | OpenRouter Go SDK -'og:description': >- - ChatFormatGrammarConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatGrammarConfig%20-%20Go%20SDK&description=ChatFormatGrammarConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Custom grammar response format - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Grammar` | `string` | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `Type` | [components.ChatFormatGrammarConfigType](/client-sdks/go/api-reference/models/chatformatgrammarconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatgrammarconfigtype.mdx b/client-sdks/go/api-reference/models/chatformatgrammarconfigtype.mdx deleted file mode 100644 index 802e27c2..00000000 --- a/client-sdks/go/api-reference/models/chatformatgrammarconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatFormatGrammarConfigType - Go SDK -sidebarTitle: ChatFormatGrammarConfigType -description: ChatFormatGrammarConfigType type definition -seoTitle: ChatFormatGrammarConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformatgrammarconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatGrammarConfigType Type | OpenRouter Go SDK -'og:description': >- - ChatFormatGrammarConfigType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatGrammarConfigType%20-%20Go%20SDK&description=ChatFormatGrammarConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFormatGrammarConfigTypeGrammar -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `ChatFormatGrammarConfigTypeGrammar` | grammar | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatjsonschemaconfig.mdx b/client-sdks/go/api-reference/models/chatformatjsonschemaconfig.mdx deleted file mode 100644 index c22aac7e..00000000 --- a/client-sdks/go/api-reference/models/chatformatjsonschemaconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatFormatJSONSchemaConfig - Go SDK -sidebarTitle: ChatFormatJSONSchemaConfig -description: ChatFormatJSONSchemaConfig type definition -seoTitle: ChatFormatJSONSchemaConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatJSONSchemaConfig Type | OpenRouter Go SDK -'og:description': >- - ChatFormatJSONSchemaConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatJSONSchemaConfig%20-%20Go%20SDK&description=ChatFormatJSONSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -JSON Schema response format for structured outputs - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `JSONSchema` | [components.ChatJSONSchemaConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatformatjsonschemaconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatjsonschemaconfigtype.mdx b/client-sdks/go/api-reference/models/chatformatjsonschemaconfigtype.mdx deleted file mode 100644 index 19331bd8..00000000 --- a/client-sdks/go/api-reference/models/chatformatjsonschemaconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatFormatJSONSchemaConfigType - Go SDK -sidebarTitle: ChatFormatJSONSchemaConfigType -description: ChatFormatJSONSchemaConfigType type definition -seoTitle: ChatFormatJSONSchemaConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformatjsonschemaconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatJSONSchemaConfigType Type | OpenRouter Go SDK -'og:description': >- - ChatFormatJSONSchemaConfigType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatJSONSchemaConfigType%20-%20Go%20SDK&description=ChatFormatJSONSchemaConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFormatJSONSchemaConfigTypeJSONSchema -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `ChatFormatJSONSchemaConfigTypeJSONSchema` | json_schema | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatpythonconfig.mdx b/client-sdks/go/api-reference/models/chatformatpythonconfig.mdx deleted file mode 100644 index 144e3e6a..00000000 --- a/client-sdks/go/api-reference/models/chatformatpythonconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatFormatPythonConfig - Go SDK -sidebarTitle: ChatFormatPythonConfig -description: ChatFormatPythonConfig type definition -seoTitle: ChatFormatPythonConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatformatpythonconfig' -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatPythonConfig Type | OpenRouter Go SDK -'og:description': >- - ChatFormatPythonConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatPythonConfig%20-%20Go%20SDK&description=ChatFormatPythonConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Python code response format - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.ChatFormatPythonConfigType](/client-sdks/go/api-reference/models/chatformatpythonconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformatpythonconfigtype.mdx b/client-sdks/go/api-reference/models/chatformatpythonconfigtype.mdx deleted file mode 100644 index af5e516d..00000000 --- a/client-sdks/go/api-reference/models/chatformatpythonconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatFormatPythonConfigType - Go SDK -sidebarTitle: ChatFormatPythonConfigType -description: ChatFormatPythonConfigType type definition -seoTitle: ChatFormatPythonConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformatpythonconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatPythonConfigType Type | OpenRouter Go SDK -'og:description': >- - ChatFormatPythonConfigType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatPythonConfigType%20-%20Go%20SDK&description=ChatFormatPythonConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFormatPythonConfigTypePython -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ChatFormatPythonConfigTypePython` | python | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformattextconfig.mdx b/client-sdks/go/api-reference/models/chatformattextconfig.mdx deleted file mode 100644 index a630c42a..00000000 --- a/client-sdks/go/api-reference/models/chatformattextconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatFormatTextConfig - Go SDK -sidebarTitle: ChatFormatTextConfig -description: ChatFormatTextConfig type definition -seoTitle: ChatFormatTextConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatformattextconfig' -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatTextConfig Type | OpenRouter Go SDK -'og:description': >- - ChatFormatTextConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatTextConfig%20-%20Go%20SDK&description=ChatFormatTextConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Default text response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatTextConfigType](/client-sdks/go/api-reference/models/chatformattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatformattextconfigtype.mdx b/client-sdks/go/api-reference/models/chatformattextconfigtype.mdx deleted file mode 100644 index d978093b..00000000 --- a/client-sdks/go/api-reference/models/chatformattextconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatFormatTextConfigType - Go SDK -sidebarTitle: ChatFormatTextConfigType -description: ChatFormatTextConfigType type definition -seoTitle: ChatFormatTextConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatformattextconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatTextConfigType Type | OpenRouter Go SDK -'og:description': >- - ChatFormatTextConfigType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatTextConfigType%20-%20Go%20SDK&description=ChatFormatTextConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFormatTextConfigTypeText -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ChatFormatTextConfigTypeText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatfunctiontool.mdx b/client-sdks/go/api-reference/models/chatfunctiontool.mdx deleted file mode 100644 index 39ce9d7d..00000000 --- a/client-sdks/go/api-reference/models/chatfunctiontool.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: ChatFunctionTool - Go SDK -sidebarTitle: ChatFunctionTool -description: ChatFunctionTool type definition -seoTitle: ChatFunctionTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatfunctiontool' -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionTool Type | OpenRouter Go SDK -'og:description': >- - ChatFunctionTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionTool%20-%20Go%20SDK&description=ChatFunctionTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool definition for function calling (regular function or OpenRouter built-in server tool) - -## Supported Types - -### ChatFunctionToolFunction - -```go lines -chatFunctionTool := components.CreateChatFunctionToolChatFunctionToolFunction(components.ChatFunctionToolFunction{/* values here */}) -``` - -### DatetimeServerTool - -```go lines -chatFunctionTool := components.CreateChatFunctionToolDatetimeServerTool(components.DatetimeServerTool{/* values here */}) -``` - -### ImageGenerationServerToolOpenRouter - -```go lines -chatFunctionTool := components.CreateChatFunctionToolImageGenerationServerToolOpenRouter(components.ImageGenerationServerToolOpenRouter{/* values here */}) -``` - -### ChatSearchModelsServerTool - -```go lines -chatFunctionTool := components.CreateChatFunctionToolChatSearchModelsServerTool(components.ChatSearchModelsServerTool{/* values here */}) -``` - -### WebFetchServerTool - -```go lines -chatFunctionTool := components.CreateChatFunctionToolWebFetchServerTool(components.WebFetchServerTool{/* values here */}) -``` - -### OpenRouterWebSearchServerTool - -```go lines -chatFunctionTool := components.CreateChatFunctionToolOpenRouterWebSearchServerTool(components.OpenRouterWebSearchServerTool{/* values here */}) -``` - -### ChatWebSearchShorthand - -```go lines -chatFunctionTool := components.CreateChatFunctionToolChatWebSearchShorthand(components.ChatWebSearchShorthand{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatFunctionTool.Type { - case components.ChatFunctionToolUnionTypeChatFunctionToolFunction: - // chatFunctionTool.ChatFunctionToolFunction is populated - case components.ChatFunctionToolUnionTypeDatetimeServerTool: - // chatFunctionTool.DatetimeServerTool is populated - case components.ChatFunctionToolUnionTypeImageGenerationServerToolOpenRouter: - // chatFunctionTool.ImageGenerationServerToolOpenRouter is populated - case components.ChatFunctionToolUnionTypeChatSearchModelsServerTool: - // chatFunctionTool.ChatSearchModelsServerTool is populated - case components.ChatFunctionToolUnionTypeWebFetchServerTool: - // chatFunctionTool.WebFetchServerTool is populated - case components.ChatFunctionToolUnionTypeOpenRouterWebSearchServerTool: - // chatFunctionTool.OpenRouterWebSearchServerTool is populated - case components.ChatFunctionToolUnionTypeChatWebSearchShorthand: - // chatFunctionTool.ChatWebSearchShorthand is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatfunctiontoolfunction.mdx b/client-sdks/go/api-reference/models/chatfunctiontoolfunction.mdx deleted file mode 100644 index 588ea950..00000000 --- a/client-sdks/go/api-reference/models/chatfunctiontoolfunction.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatFunctionToolFunction - Go SDK -sidebarTitle: ChatFunctionToolFunction -description: ChatFunctionToolFunction type definition -seoTitle: ChatFunctionToolFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatfunctiontoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunction Type | OpenRouter Go SDK -'og:description': >- - ChatFunctionToolFunction type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunction%20-%20Go%20SDK&description=ChatFunctionToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](/client-sdks/go/api-reference/models/chatcontentcachecontrol) | :heavy_minus_sign: | Cache control for the content part | `{"ttl": "5m","type": "ephemeral"}` | -| `Function` | [components.ChatFunctionToolFunctionFunction](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatfunctiontooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatfunctiontoolfunctionfunction.mdx b/client-sdks/go/api-reference/models/chatfunctiontoolfunctionfunction.mdx deleted file mode 100644 index 4edc87be..00000000 --- a/client-sdks/go/api-reference/models/chatfunctiontoolfunctionfunction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatFunctionToolFunctionFunction - Go SDK -sidebarTitle: ChatFunctionToolFunctionFunction -description: ChatFunctionToolFunctionFunction type definition -seoTitle: ChatFunctionToolFunctionFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatfunctiontoolfunctionfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunctionFunction Type | OpenRouter Go SDK -'og:description': >- - ChatFunctionToolFunctionFunction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunctionFunction%20-%20Go%20SDK&description=ChatFunctionToolFunctionFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Function definition for tool calling - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `Description` | `*string` | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `Name` | `string` | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `Parameters` | map[string]`any` | :heavy_minus_sign: | Function parameters as JSON Schema object | `{"properties": {"location": {"description": "City name","type": "string"}`
\},
"required": [
"location"
],
"type": "object"
\} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatfunctiontooltype.mdx b/client-sdks/go/api-reference/models/chatfunctiontooltype.mdx deleted file mode 100644 index ab84f779..00000000 --- a/client-sdks/go/api-reference/models/chatfunctiontooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatFunctionToolType - Go SDK -sidebarTitle: ChatFunctionToolType -description: ChatFunctionToolType type definition -seoTitle: ChatFunctionToolType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatfunctiontooltype' -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolType Type | OpenRouter Go SDK -'og:description': >- - ChatFunctionToolType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolType%20-%20Go%20SDK&description=ChatFunctionToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatFunctionToolTypeFunction -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ChatFunctionToolTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatjsonschemaconfig.mdx b/client-sdks/go/api-reference/models/chatjsonschemaconfig.mdx deleted file mode 100644 index cb1e67ef..00000000 --- a/client-sdks/go/api-reference/models/chatjsonschemaconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatJSONSchemaConfig - Go SDK -sidebarTitle: ChatJSONSchemaConfig -description: ChatJSONSchemaConfig type definition -seoTitle: ChatJSONSchemaConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatjsonschemaconfig' -'og:site_name': OpenRouter Documentation -'og:title': ChatJSONSchemaConfig Type | OpenRouter Go SDK -'og:description': >- - ChatJSONSchemaConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatJSONSchemaConfig%20-%20Go%20SDK&description=ChatJSONSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -JSON Schema configuration object - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Description` | `*string` | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `Name` | `string` | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `Schema` | map[string]`any` | :heavy_minus_sign: | JSON Schema object | `{"properties": {"answer": {"type": "number"}`
\},
"required": [
"answer"
],
"type": "object"
\} | -| `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatmessages.mdx b/client-sdks/go/api-reference/models/chatmessages.mdx deleted file mode 100644 index e97d23f2..00000000 --- a/client-sdks/go/api-reference/models/chatmessages.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: ChatMessages - Go SDK -sidebarTitle: ChatMessages -description: ChatMessages type definition -seoTitle: ChatMessages Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatmessages' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessages Type | OpenRouter Go SDK -'og:description': >- - ChatMessages type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessages%20-%20Go%20SDK&description=ChatMessages%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Chat completion message with role-based discrimination - -## Supported Types - -### ChatAssistantMessage - -```go lines -chatMessages := components.CreateChatMessagesAssistant(components.ChatAssistantMessage{/* values here */}) -``` - -### ChatDeveloperMessage - -```go lines -chatMessages := components.CreateChatMessagesDeveloper(components.ChatDeveloperMessage{/* values here */}) -``` - -### ChatSystemMessage - -```go lines -chatMessages := components.CreateChatMessagesSystem(components.ChatSystemMessage{/* values here */}) -``` - -### ChatToolMessage - -```go lines -chatMessages := components.CreateChatMessagesTool(components.ChatToolMessage{/* values here */}) -``` - -### ChatUserMessage - -```go lines -chatMessages := components.CreateChatMessagesUser(components.ChatUserMessage{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatMessages.Type { - case components.ChatMessagesTypeAssistant: - // chatMessages.ChatAssistantMessage is populated - case components.ChatMessagesTypeDeveloper: - // chatMessages.ChatDeveloperMessage is populated - case components.ChatMessagesTypeSystem: - // chatMessages.ChatSystemMessage is populated - case components.ChatMessagesTypeTool: - // chatMessages.ChatToolMessage is populated - case components.ChatMessagesTypeUser: - // chatMessages.ChatUserMessage is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatnamedtoolchoice.mdx b/client-sdks/go/api-reference/models/chatnamedtoolchoice.mdx deleted file mode 100644 index 2a4ee6e5..00000000 --- a/client-sdks/go/api-reference/models/chatnamedtoolchoice.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatNamedToolChoice - Go SDK -sidebarTitle: ChatNamedToolChoice -description: ChatNamedToolChoice type definition -seoTitle: ChatNamedToolChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatnamedtoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoice Type | OpenRouter Go SDK -'og:description': >- - ChatNamedToolChoice type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoice%20-%20Go%20SDK&description=ChatNamedToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Named tool choice for specific function - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Function` | [components.ChatNamedToolChoiceFunction](/client-sdks/go/api-reference/models/chatnamedtoolchoicefunction) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatNamedToolChoiceType](/client-sdks/go/api-reference/models/chatnamedtoolchoicetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatnamedtoolchoicefunction.mdx b/client-sdks/go/api-reference/models/chatnamedtoolchoicefunction.mdx deleted file mode 100644 index 20f53c0f..00000000 --- a/client-sdks/go/api-reference/models/chatnamedtoolchoicefunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatNamedToolChoiceFunction - Go SDK -sidebarTitle: ChatNamedToolChoiceFunction -description: ChatNamedToolChoiceFunction type definition -seoTitle: ChatNamedToolChoiceFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatnamedtoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceFunction Type | OpenRouter Go SDK -'og:description': >- - ChatNamedToolChoiceFunction type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceFunction%20-%20Go%20SDK&description=ChatNamedToolChoiceFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `Name` | `string` | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatnamedtoolchoicetype.mdx b/client-sdks/go/api-reference/models/chatnamedtoolchoicetype.mdx deleted file mode 100644 index aab4bb5d..00000000 --- a/client-sdks/go/api-reference/models/chatnamedtoolchoicetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatNamedToolChoiceType - Go SDK -sidebarTitle: ChatNamedToolChoiceType -description: ChatNamedToolChoiceType type definition -seoTitle: ChatNamedToolChoiceType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatnamedtoolchoicetype -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceType Type | OpenRouter Go SDK -'og:description': >- - ChatNamedToolChoiceType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceType%20-%20Go%20SDK&description=ChatNamedToolChoiceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatNamedToolChoiceTypeFunction -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `ChatNamedToolChoiceTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatreasoningsummaryverbosityenum.mdx b/client-sdks/go/api-reference/models/chatreasoningsummaryverbosityenum.mdx deleted file mode 100644 index 1930ef34..00000000 --- a/client-sdks/go/api-reference/models/chatreasoningsummaryverbosityenum.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatReasoningSummaryVerbosityEnum - Go SDK -sidebarTitle: ChatReasoningSummaryVerbosityEnum -description: ChatReasoningSummaryVerbosityEnum type definition -seoTitle: ChatReasoningSummaryVerbosityEnum Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatreasoningsummaryverbosityenum -'og:site_name': OpenRouter Documentation -'og:title': ChatReasoningSummaryVerbosityEnum Type | OpenRouter Go SDK -'og:description': >- - ChatReasoningSummaryVerbosityEnum type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatReasoningSummaryVerbosityEnum%20-%20Go%20SDK&description=ChatReasoningSummaryVerbosityEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatReasoningSummaryVerbosityEnumAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatReasoningSummaryVerbosityEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `ChatReasoningSummaryVerbosityEnumAuto` | auto | -| `ChatReasoningSummaryVerbosityEnumConcise` | concise | -| `ChatReasoningSummaryVerbosityEnumDetailed` | detailed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatrequest.mdx b/client-sdks/go/api-reference/models/chatrequest.mdx deleted file mode 100644 index 003f8384..00000000 --- a/client-sdks/go/api-reference/models/chatrequest.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: ChatRequest - Go SDK -sidebarTitle: ChatRequest -description: ChatRequest type definition -seoTitle: ChatRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatrequest' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequest Type | OpenRouter Go SDK -'og:description': >- - ChatRequest type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequest%20-%20Go%20SDK&description=ChatRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Chat completion request parameters - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Debug` | [*components.ChatDebugOptions](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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"}` | -| `Modalities` | [][components.Modality](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatrequestplugin) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](/client-sdks/go/api-reference/models/providerpreferences)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `Reasoning` | [*components.ChatRequestReasoning](/client-sdks/go/api-reference/models/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | `{"effort": "medium","summary": "concise"}` | -| `ResponseFormat` | [*components.ResponseFormat](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/stop)] | :heavy_minus_sign: | Stop sequences (up to 4) | [
""
] | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](/client-sdks/go/api-reference/models/stopservertoolswhencondition) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chattoolchoice) | :heavy_minus_sign: | Tool choice configuration | auto | -| `Tools` | [][components.ChatFunctionTool](/client-sdks/go/api-reference/models/chatfunctiontool) | :heavy_minus_sign: | Available tools for function calling | [
`{"function": {"description": "Get weather","name": "get_weather"}`,
"type": "function"
\}
] | -| `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](/client-sdks/go/api-reference/models/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: | Unique user identifier | user-123 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatrequesteffort.mdx b/client-sdks/go/api-reference/models/chatrequesteffort.mdx deleted file mode 100644 index 4d02fbe5..00000000 --- a/client-sdks/go/api-reference/models/chatrequesteffort.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ChatRequestEffort - Go SDK -sidebarTitle: ChatRequestEffort -description: ChatRequestEffort type definition -seoTitle: ChatRequestEffort Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatrequesteffort' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestEffort Type | OpenRouter Go SDK -'og:description': >- - ChatRequestEffort type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestEffort%20-%20Go%20SDK&description=ChatRequestEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Constrains effort on reasoning for reasoning models - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatRequestEffortXhigh - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatRequestEffort("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `ChatRequestEffortXhigh` | xhigh | -| `ChatRequestEffortHigh` | high | -| `ChatRequestEffortMedium` | medium | -| `ChatRequestEffortLow` | low | -| `ChatRequestEffortMinimal` | minimal | -| `ChatRequestEffortNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatrequestplugin.mdx b/client-sdks/go/api-reference/models/chatrequestplugin.mdx deleted file mode 100644 index 56b9cd3a..00000000 --- a/client-sdks/go/api-reference/models/chatrequestplugin.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: ChatRequestPlugin - Go SDK -sidebarTitle: ChatRequestPlugin -description: ChatRequestPlugin type definition -seoTitle: ChatRequestPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatrequestplugin' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestPlugin Type | OpenRouter Go SDK -'og:description': >- - ChatRequestPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestPlugin%20-%20Go%20SDK&description=ChatRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AutoRouterPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginAutoRouter(components.AutoRouterPlugin{/* values here */}) -``` - -### ContextCompressionPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginContextCompression(components.ContextCompressionPlugin{/* values here */}) -``` - -### FileParserPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginFileParser(components.FileParserPlugin{/* values here */}) -``` - -### FusionPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginFusion(components.FusionPlugin{/* values here */}) -``` - -### ModerationPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginModeration(components.ModerationPlugin{/* values here */}) -``` - -### ParetoRouterPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginParetoRouter(components.ParetoRouterPlugin{/* values here */}) -``` - -### ResponseHealingPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginResponseHealing(components.ResponseHealingPlugin{/* values here */}) -``` - -### WebSearchPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginWeb(components.WebSearchPlugin{/* values here */}) -``` - -### WebFetchPlugin - -```go lines -chatRequestPlugin := components.CreateChatRequestPluginWebFetch(components.WebFetchPlugin{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatRequestPlugin.Type { - case components.ChatRequestPluginTypeAutoRouter: - // chatRequestPlugin.AutoRouterPlugin is populated - case components.ChatRequestPluginTypeContextCompression: - // chatRequestPlugin.ContextCompressionPlugin is populated - case components.ChatRequestPluginTypeFileParser: - // chatRequestPlugin.FileParserPlugin is populated - case components.ChatRequestPluginTypeFusion: - // chatRequestPlugin.FusionPlugin is populated - case components.ChatRequestPluginTypeModeration: - // chatRequestPlugin.ModerationPlugin is populated - case components.ChatRequestPluginTypeParetoRouter: - // chatRequestPlugin.ParetoRouterPlugin is populated - case components.ChatRequestPluginTypeResponseHealing: - // chatRequestPlugin.ResponseHealingPlugin is populated - case components.ChatRequestPluginTypeWeb: - // chatRequestPlugin.WebSearchPlugin is populated - case components.ChatRequestPluginTypeWebFetch: - // chatRequestPlugin.WebFetchPlugin is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatrequestreasoning.mdx b/client-sdks/go/api-reference/models/chatrequestreasoning.mdx deleted file mode 100644 index d36c895d..00000000 --- a/client-sdks/go/api-reference/models/chatrequestreasoning.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatRequestReasoning - Go SDK -sidebarTitle: ChatRequestReasoning -description: ChatRequestReasoning type definition -seoTitle: ChatRequestReasoning Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatrequestreasoning' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestReasoning Type | OpenRouter Go SDK -'og:description': >- - ChatRequestReasoning type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestReasoning%20-%20Go%20SDK&description=ChatRequestReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration options for reasoning models - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](/client-sdks/go/api-reference/models/chatrequesteffort)] | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](/client-sdks/go/api-reference/models/chatreasoningsummaryverbosityenum)] | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatrequestservicetier.mdx b/client-sdks/go/api-reference/models/chatrequestservicetier.mdx deleted file mode 100644 index 6cab15ff..00000000 --- a/client-sdks/go/api-reference/models/chatrequestservicetier.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ChatRequestServiceTier - Go SDK -sidebarTitle: ChatRequestServiceTier -description: ChatRequestServiceTier type definition -seoTitle: ChatRequestServiceTier Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatrequestservicetier' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestServiceTier Type | OpenRouter Go SDK -'og:description': >- - ChatRequestServiceTier type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestServiceTier%20-%20Go%20SDK&description=ChatRequestServiceTier%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The service tier to use for processing this request. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatRequestServiceTierAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatRequestServiceTier("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ChatRequestServiceTierAuto` | auto | -| `ChatRequestServiceTierDefault` | default | -| `ChatRequestServiceTierFlex` | flex | -| `ChatRequestServiceTierPriority` | priority | -| `ChatRequestServiceTierScale` | scale | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatresult.mdx b/client-sdks/go/api-reference/models/chatresult.mdx deleted file mode 100644 index 63155dee..00000000 --- a/client-sdks/go/api-reference/models/chatresult.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatResult - Go SDK -sidebarTitle: ChatResult -description: ChatResult type definition -seoTitle: ChatResult Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatresult' -'og:site_name': OpenRouter Documentation -'og:title': ChatResult Type | OpenRouter Go SDK -'og:description': >- - ChatResult type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResult%20-%20Go%20SDK&description=ChatResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Chat completion response - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatChoice](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatresultobject) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatresultobject.mdx b/client-sdks/go/api-reference/models/chatresultobject.mdx deleted file mode 100644 index 4a2f2ff4..00000000 --- a/client-sdks/go/api-reference/models/chatresultobject.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatResultObject - Go SDK -sidebarTitle: ChatResultObject -description: ChatResultObject type definition -seoTitle: ChatResultObject Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatresultobject' -'og:site_name': OpenRouter Documentation -'og:title': ChatResultObject Type | OpenRouter Go SDK -'og:description': >- - ChatResultObject type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResultObject%20-%20Go%20SDK&description=ChatResultObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatResultObjectChatCompletion -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ChatResultObjectChatCompletion` | chat.completion | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatsearchmodelsservertool.mdx b/client-sdks/go/api-reference/models/chatsearchmodelsservertool.mdx deleted file mode 100644 index d572cc6d..00000000 --- a/client-sdks/go/api-reference/models/chatsearchmodelsservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatSearchModelsServerTool - Go SDK -sidebarTitle: ChatSearchModelsServerTool -description: ChatSearchModelsServerTool type definition -seoTitle: ChatSearchModelsServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatsearchmodelsservertool -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerTool Type | OpenRouter Go SDK -'og:description': >- - ChatSearchModelsServerTool type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerTool%20-%20Go%20SDK&description=ChatSearchModelsServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches and filters AI models available on OpenRouter - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](/client-sdks/go/api-reference/models/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | `{"max_results": 5}` | -| `Type` | [components.ChatSearchModelsServerToolType](/client-sdks/go/api-reference/models/chatsearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatsearchmodelsservertooltype.mdx b/client-sdks/go/api-reference/models/chatsearchmodelsservertooltype.mdx deleted file mode 100644 index 118192d2..00000000 --- a/client-sdks/go/api-reference/models/chatsearchmodelsservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatSearchModelsServerToolType - Go SDK -sidebarTitle: ChatSearchModelsServerToolType -description: ChatSearchModelsServerToolType type definition -seoTitle: ChatSearchModelsServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatsearchmodelsservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerToolType Type | OpenRouter Go SDK -'og:description': >- - ChatSearchModelsServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerToolType%20-%20Go%20SDK&description=ChatSearchModelsServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatSearchModelsServerToolTypeOpenrouterExperimentalSearchModels -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ChatSearchModelsServerToolTypeOpenrouterExperimentalSearchModels` | openrouter:experimental__search_models | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatservertoolchoice.mdx b/client-sdks/go/api-reference/models/chatservertoolchoice.mdx deleted file mode 100644 index a5e784b0..00000000 --- a/client-sdks/go/api-reference/models/chatservertoolchoice.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatServerToolChoice - Go SDK -sidebarTitle: ChatServerToolChoice -description: ChatServerToolChoice type definition -seoTitle: ChatServerToolChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatservertoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatServerToolChoice Type | OpenRouter Go SDK -'og:description': >- - ChatServerToolChoice type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatServerToolChoice%20-%20Go%20SDK&description=ChatServerToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter extension: force a specific server tool by naming it directly in `tool_choice.type` instead of wrapping it in `{ type: "function", function: { name } }`. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | `string` | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamchoice.mdx b/client-sdks/go/api-reference/models/chatstreamchoice.mdx deleted file mode 100644 index 50544ccc..00000000 --- a/client-sdks/go/api-reference/models/chatstreamchoice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatStreamChoice - Go SDK -sidebarTitle: ChatStreamChoice -description: ChatStreamChoice type definition -seoTitle: ChatStreamChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChoice Type | OpenRouter Go SDK -'og:description': >- - ChatStreamChoice type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChoice%20-%20Go%20SDK&description=ChatStreamChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Streaming completion choice chunk - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Delta` | [components.ChatStreamDelta](/client-sdks/go/api-reference/models/chatstreamdelta) | :heavy_check_mark: | Delta changes in streaming response | `{"content": "Hello","role": "assistant"}` | -| `FinishReason` | [*components.ChatFinishReasonEnum](/client-sdks/go/api-reference/models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | -| `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/chatstreamchunk.mdx b/client-sdks/go/api-reference/models/chatstreamchunk.mdx deleted file mode 100644 index 338bd74d..00000000 --- a/client-sdks/go/api-reference/models/chatstreamchunk.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatStreamChunk - Go SDK -sidebarTitle: ChatStreamChunk -description: ChatStreamChunk type definition -seoTitle: ChatStreamChunk Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamchunk' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunk Type | OpenRouter Go SDK -'og:description': >- - ChatStreamChunk type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunk%20-%20Go%20SDK&description=ChatStreamChunk%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Streaming chat completion chunk - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatStreamChoice](/client-sdks/go/api-reference/models/chatstreamchoice) | :heavy_check_mark: | List of streaming chunk choices | | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `Error` | [*components.Error](/client-sdks/go/api-reference/models/error) | :heavy_minus_sign: | Error information | `{"code": 429,"message": "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](/client-sdks/go/api-reference/models/chatstreamchunkobject) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamchunkobject.mdx b/client-sdks/go/api-reference/models/chatstreamchunkobject.mdx deleted file mode 100644 index 24074806..00000000 --- a/client-sdks/go/api-reference/models/chatstreamchunkobject.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatStreamChunkObject - Go SDK -sidebarTitle: ChatStreamChunkObject -description: ChatStreamChunkObject type definition -seoTitle: ChatStreamChunkObject Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamchunkobject' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunkObject Type | OpenRouter Go SDK -'og:description': >- - ChatStreamChunkObject type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunkObject%20-%20Go%20SDK&description=ChatStreamChunkObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatStreamChunkObjectChatCompletionChunk -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `ChatStreamChunkObjectChatCompletionChunk` | chat.completion.chunk | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamdelta.mdx b/client-sdks/go/api-reference/models/chatstreamdelta.mdx deleted file mode 100644 index efb6abd1..00000000 --- a/client-sdks/go/api-reference/models/chatstreamdelta.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatStreamDelta - Go SDK -sidebarTitle: ChatStreamDelta -description: ChatStreamDelta type definition -seoTitle: ChatStreamDelta Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamdelta' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDelta Type | OpenRouter Go SDK -'og:description': >- - ChatStreamDelta type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDelta%20-%20Go%20SDK&description=ChatStreamDelta%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Delta changes in streaming response - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningdetailunion) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"text": "Let me think about this...","type": "text"}`
] | -| `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message delta | `` | -| `Role` | [*components.ChatStreamDeltaRole](/client-sdks/go/api-reference/models/chatstreamdeltarole) | :heavy_minus_sign: | The role of the message author | assistant | -| `ToolCalls` | [][components.ChatStreamToolCall](/client-sdks/go/api-reference/models/chatstreamtoolcall) | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamdeltarole.mdx b/client-sdks/go/api-reference/models/chatstreamdeltarole.mdx deleted file mode 100644 index bb5f0be8..00000000 --- a/client-sdks/go/api-reference/models/chatstreamdeltarole.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamDeltaRole - Go SDK -sidebarTitle: ChatStreamDeltaRole -description: ChatStreamDeltaRole type definition -seoTitle: ChatStreamDeltaRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamdeltarole' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDeltaRole Type | OpenRouter Go SDK -'og:description': >- - ChatStreamDeltaRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDeltaRole%20-%20Go%20SDK&description=ChatStreamDeltaRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The role of the message author - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatStreamDeltaRoleAssistant -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ChatStreamDeltaRoleAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamingresponse.mdx b/client-sdks/go/api-reference/models/chatstreamingresponse.mdx deleted file mode 100644 index 4f5264e9..00000000 --- a/client-sdks/go/api-reference/models/chatstreamingresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatStreamingResponse - Go SDK -sidebarTitle: ChatStreamingResponse -description: ChatStreamingResponse type definition -seoTitle: ChatStreamingResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamingresponse' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponse Type | OpenRouter Go SDK -'og:description': >- - ChatStreamingResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponse%20-%20Go%20SDK&description=ChatStreamingResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ChatStreamChunk](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/chatstreamoptions.mdx b/client-sdks/go/api-reference/models/chatstreamoptions.mdx deleted file mode 100644 index dc3bf560..00000000 --- a/client-sdks/go/api-reference/models/chatstreamoptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatStreamOptions - Go SDK -sidebarTitle: ChatStreamOptions -description: ChatStreamOptions type definition -seoTitle: ChatStreamOptions Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamoptions' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamOptions Type | OpenRouter Go SDK -'og:description': >- - ChatStreamOptions type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamOptions%20-%20Go%20SDK&description=ChatStreamOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Streaming configuration options - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`IncludeUsage`~~ | `*bool` | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamtoolcall.mdx b/client-sdks/go/api-reference/models/chatstreamtoolcall.mdx deleted file mode 100644 index d45349ec..00000000 --- a/client-sdks/go/api-reference/models/chatstreamtoolcall.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatStreamToolCall - Go SDK -sidebarTitle: ChatStreamToolCall -description: ChatStreamToolCall type definition -seoTitle: ChatStreamToolCall Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamtoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCall Type | OpenRouter Go SDK -'og:description': >- - ChatStreamToolCall type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCall%20-%20Go%20SDK&description=ChatStreamToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool call delta for streaming responses - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Function` | [*components.ChatStreamToolCallFunction](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/chatstreamtoolcalltype) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamtoolcallfunction.mdx b/client-sdks/go/api-reference/models/chatstreamtoolcallfunction.mdx deleted file mode 100644 index 66ca6a85..00000000 --- a/client-sdks/go/api-reference/models/chatstreamtoolcallfunction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatStreamToolCallFunction - Go SDK -sidebarTitle: ChatStreamToolCallFunction -description: ChatStreamToolCallFunction type definition -seoTitle: ChatStreamToolCallFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatstreamtoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallFunction Type | OpenRouter Go SDK -'og:description': >- - ChatStreamToolCallFunction type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallFunction%20-%20Go%20SDK&description=ChatStreamToolCallFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Function call details - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `*string` | :heavy_minus_sign: | Function arguments as JSON string | `{"location": "..."}` | -| `Name` | `*string` | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatstreamtoolcalltype.mdx b/client-sdks/go/api-reference/models/chatstreamtoolcalltype.mdx deleted file mode 100644 index fb6ef571..00000000 --- a/client-sdks/go/api-reference/models/chatstreamtoolcalltype.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamToolCallType - Go SDK -sidebarTitle: ChatStreamToolCallType -description: ChatStreamToolCallType type definition -seoTitle: ChatStreamToolCallType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatstreamtoolcalltype' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallType Type | OpenRouter Go SDK -'og:description': >- - ChatStreamToolCallType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallType%20-%20Go%20SDK&description=ChatStreamToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool call type - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatStreamToolCallTypeFunction -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ChatStreamToolCallTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatsystemmessage.mdx b/client-sdks/go/api-reference/models/chatsystemmessage.mdx deleted file mode 100644 index b3b20d8a..00000000 --- a/client-sdks/go/api-reference/models/chatsystemmessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatSystemMessage - Go SDK -sidebarTitle: ChatSystemMessage -description: ChatSystemMessage type definition -seoTitle: ChatSystemMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatsystemmessage' -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessage Type | OpenRouter Go SDK -'og:description': >- - ChatSystemMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessage%20-%20Go%20SDK&description=ChatSystemMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -System message for setting behavior - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Content` | [components.ChatSystemMessageContent](/client-sdks/go/api-reference/models/chatsystemmessagecontent) | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `Role` | [components.ChatSystemMessageRole](/client-sdks/go/api-reference/models/chatsystemmessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatsystemmessagecontent.mdx b/client-sdks/go/api-reference/models/chatsystemmessagecontent.mdx deleted file mode 100644 index d55664f4..00000000 --- a/client-sdks/go/api-reference/models/chatsystemmessagecontent.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ChatSystemMessageContent - Go SDK -sidebarTitle: ChatSystemMessageContent -description: ChatSystemMessageContent type definition -seoTitle: ChatSystemMessageContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatsystemmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessageContent Type | OpenRouter Go SDK -'og:description': >- - ChatSystemMessageContent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessageContent%20-%20Go%20SDK&description=ChatSystemMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -System message content - -## Supported Types - -### - -```go lines -chatSystemMessageContent := components.CreateChatSystemMessageContentStr(string{/* values here */}) -``` - -### - -```go lines -chatSystemMessageContent := components.CreateChatSystemMessageContentArrayOfChatContentText([]components.ChatContentText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatSystemMessageContent.Type { - case components.ChatSystemMessageContentTypeStr: - // chatSystemMessageContent.Str is populated - case components.ChatSystemMessageContentTypeArrayOfChatContentText: - // chatSystemMessageContent.ArrayOfChatContentText is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatsystemmessagerole.mdx b/client-sdks/go/api-reference/models/chatsystemmessagerole.mdx deleted file mode 100644 index e17d142b..00000000 --- a/client-sdks/go/api-reference/models/chatsystemmessagerole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatSystemMessageRole - Go SDK -sidebarTitle: ChatSystemMessageRole -description: ChatSystemMessageRole type definition -seoTitle: ChatSystemMessageRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatsystemmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessageRole Type | OpenRouter Go SDK -'og:description': >- - ChatSystemMessageRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessageRole%20-%20Go%20SDK&description=ChatSystemMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatSystemMessageRoleSystem -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `ChatSystemMessageRoleSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattokenlogprob.mdx b/client-sdks/go/api-reference/models/chattokenlogprob.mdx deleted file mode 100644 index 8db28f44..00000000 --- a/client-sdks/go/api-reference/models/chattokenlogprob.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatTokenLogprob - Go SDK -sidebarTitle: ChatTokenLogprob -description: ChatTokenLogprob type definition -seoTitle: ChatTokenLogprob Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattokenlogprob' -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprob Type | OpenRouter Go SDK -'og:description': >- - ChatTokenLogprob type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprob%20-%20Go%20SDK&description=ChatTokenLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Token log probability information - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/chattokenlogprobtoplogprob) | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattokenlogprobs.mdx b/client-sdks/go/api-reference/models/chattokenlogprobs.mdx deleted file mode 100644 index bad8cba8..00000000 --- a/client-sdks/go/api-reference/models/chattokenlogprobs.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatTokenLogprobs - Go SDK -sidebarTitle: ChatTokenLogprobs -description: ChatTokenLogprobs type definition -seoTitle: ChatTokenLogprobs Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattokenlogprobs' -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobs Type | OpenRouter Go SDK -'og:description': >- - ChatTokenLogprobs type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobs%20-%20Go%20SDK&description=ChatTokenLogprobs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Log probabilities for the completion - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ChatTokenLogprob](/client-sdks/go/api-reference/models/chattokenlogprob) | :heavy_check_mark: | Log probabilities for content tokens | -| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](/client-sdks/go/api-reference/models/chattokenlogprob)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattokenlogprobtoplogprob.mdx b/client-sdks/go/api-reference/models/chattokenlogprobtoplogprob.mdx deleted file mode 100644 index 55a91e51..00000000 --- a/client-sdks/go/api-reference/models/chattokenlogprobtoplogprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatTokenLogprobTopLogprob - Go SDK -sidebarTitle: ChatTokenLogprobTopLogprob -description: ChatTokenLogprobTopLogprob type definition -seoTitle: ChatTokenLogprobTopLogprob Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chattokenlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobTopLogprob Type | OpenRouter Go SDK -'og:description': >- - ChatTokenLogprobTopLogprob type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobTopLogprob%20-%20Go%20SDK&description=ChatTokenLogprobTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolcall.mdx b/client-sdks/go/api-reference/models/chattoolcall.mdx deleted file mode 100644 index 3a81d5a9..00000000 --- a/client-sdks/go/api-reference/models/chattoolcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatToolCall - Go SDK -sidebarTitle: ChatToolCall -description: ChatToolCall type definition -seoTitle: ChatToolCall Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCall Type | OpenRouter Go SDK -'og:description': >- - ChatToolCall type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCall%20-%20Go%20SDK&description=ChatToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool call made by the assistant - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Function` | [components.ChatToolCallFunction](/client-sdks/go/api-reference/models/chattoolcallfunction) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | Tool call identifier | -| `Type` | [components.ChatToolCallType](/client-sdks/go/api-reference/models/chattoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolcallfunction.mdx b/client-sdks/go/api-reference/models/chattoolcallfunction.mdx deleted file mode 100644 index f0990833..00000000 --- a/client-sdks/go/api-reference/models/chattoolcallfunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolCallFunction - Go SDK -sidebarTitle: ChatToolCallFunction -description: ChatToolCallFunction type definition -seoTitle: ChatToolCallFunction Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolcallfunction' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallFunction Type | OpenRouter Go SDK -'og:description': >- - ChatToolCallFunction type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallFunction%20-%20Go%20SDK&description=ChatToolCallFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | Function arguments as JSON string | -| `Name` | `string` | :heavy_check_mark: | Function name to call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolcalltype.mdx b/client-sdks/go/api-reference/models/chattoolcalltype.mdx deleted file mode 100644 index b8d6481c..00000000 --- a/client-sdks/go/api-reference/models/chattoolcalltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatToolCallType - Go SDK -sidebarTitle: ChatToolCallType -description: ChatToolCallType type definition -seoTitle: ChatToolCallType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolcalltype' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallType Type | OpenRouter Go SDK -'og:description': >- - ChatToolCallType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallType%20-%20Go%20SDK&description=ChatToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatToolCallTypeFunction -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `ChatToolCallTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolchoice.mdx b/client-sdks/go/api-reference/models/chattoolchoice.mdx deleted file mode 100644 index b7ddb274..00000000 --- a/client-sdks/go/api-reference/models/chattoolchoice.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: ChatToolChoice - Go SDK -sidebarTitle: ChatToolChoice -description: ChatToolChoice type definition -seoTitle: ChatToolChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoice Type | OpenRouter Go SDK -'og:description': >- - ChatToolChoice type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoice%20-%20Go%20SDK&description=ChatToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool choice configuration - -## Supported Types - -### ChatToolChoiceNone - -```go lines -chatToolChoice := components.CreateChatToolChoiceChatToolChoiceNone(components.ChatToolChoiceNone{/* values here */}) -``` - -### ChatToolChoiceAuto - -```go lines -chatToolChoice := components.CreateChatToolChoiceChatToolChoiceAuto(components.ChatToolChoiceAuto{/* values here */}) -``` - -### ChatToolChoiceRequired - -```go lines -chatToolChoice := components.CreateChatToolChoiceChatToolChoiceRequired(components.ChatToolChoiceRequired{/* values here */}) -``` - -### ChatNamedToolChoice - -```go lines -chatToolChoice := components.CreateChatToolChoiceChatNamedToolChoice(components.ChatNamedToolChoice{/* values here */}) -``` - -### ChatServerToolChoice - -```go lines -chatToolChoice := components.CreateChatToolChoiceChatServerToolChoice(components.ChatServerToolChoice{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatToolChoice.Type { - case components.ChatToolChoiceTypeChatToolChoiceNone: - // chatToolChoice.ChatToolChoiceNone is populated - case components.ChatToolChoiceTypeChatToolChoiceAuto: - // chatToolChoice.ChatToolChoiceAuto is populated - case components.ChatToolChoiceTypeChatToolChoiceRequired: - // chatToolChoice.ChatToolChoiceRequired is populated - case components.ChatToolChoiceTypeChatNamedToolChoice: - // chatToolChoice.ChatNamedToolChoice is populated - case components.ChatToolChoiceTypeChatServerToolChoice: - // chatToolChoice.ChatServerToolChoice is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolchoiceauto.mdx b/client-sdks/go/api-reference/models/chattoolchoiceauto.mdx deleted file mode 100644 index b1ee24eb..00000000 --- a/client-sdks/go/api-reference/models/chattoolchoiceauto.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatToolChoiceAuto - Go SDK -sidebarTitle: ChatToolChoiceAuto -description: ChatToolChoiceAuto type definition -seoTitle: ChatToolChoiceAuto Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolchoiceauto' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceAuto Type | OpenRouter Go SDK -'og:description': >- - ChatToolChoiceAuto type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceAuto%20-%20Go%20SDK&description=ChatToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatToolChoiceAutoAuto -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ChatToolChoiceAutoAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolchoicenone.mdx b/client-sdks/go/api-reference/models/chattoolchoicenone.mdx deleted file mode 100644 index dd1184f8..00000000 --- a/client-sdks/go/api-reference/models/chattoolchoicenone.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatToolChoiceNone - Go SDK -sidebarTitle: ChatToolChoiceNone -description: ChatToolChoiceNone type definition -seoTitle: ChatToolChoiceNone Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolchoicenone' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceNone Type | OpenRouter Go SDK -'og:description': >- - ChatToolChoiceNone type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceNone%20-%20Go%20SDK&description=ChatToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatToolChoiceNoneNone -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ChatToolChoiceNoneNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolchoicerequired.mdx b/client-sdks/go/api-reference/models/chattoolchoicerequired.mdx deleted file mode 100644 index 34f9e93b..00000000 --- a/client-sdks/go/api-reference/models/chattoolchoicerequired.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatToolChoiceRequired - Go SDK -sidebarTitle: ChatToolChoiceRequired -description: ChatToolChoiceRequired type definition -seoTitle: ChatToolChoiceRequired Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolchoicerequired' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceRequired Type | OpenRouter Go SDK -'og:description': >- - ChatToolChoiceRequired type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceRequired%20-%20Go%20SDK&description=ChatToolChoiceRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatToolChoiceRequiredRequired -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `ChatToolChoiceRequiredRequired` | required | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolmessage.mdx b/client-sdks/go/api-reference/models/chattoolmessage.mdx deleted file mode 100644 index 8c84c3f7..00000000 --- a/client-sdks/go/api-reference/models/chattoolmessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatToolMessage - Go SDK -sidebarTitle: ChatToolMessage -description: ChatToolMessage type definition -seoTitle: ChatToolMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolmessage' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessage Type | OpenRouter Go SDK -'og:description': >- - ChatToolMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessage%20-%20Go%20SDK&description=ChatToolMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool response message - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatToolMessageContent](/client-sdks/go/api-reference/models/chattoolmessagecontent) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `Role` | [components.ChatToolMessageRole](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/chattoolmessagecontent.mdx b/client-sdks/go/api-reference/models/chattoolmessagecontent.mdx deleted file mode 100644 index 0e905b35..00000000 --- a/client-sdks/go/api-reference/models/chattoolmessagecontent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ChatToolMessageContent - Go SDK -sidebarTitle: ChatToolMessageContent -description: ChatToolMessageContent type definition -seoTitle: ChatToolMessageContent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessageContent Type | OpenRouter Go SDK -'og:description': >- - ChatToolMessageContent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessageContent%20-%20Go%20SDK&description=ChatToolMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tool response content - -## Supported Types - -### - -```go lines -chatToolMessageContent := components.CreateChatToolMessageContentStr(string{/* values here */}) -``` - -### - -```go lines -chatToolMessageContent := components.CreateChatToolMessageContentArrayOfChatContentItems([]components.ChatContentItems{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatToolMessageContent.Type { - case components.ChatToolMessageContentTypeStr: - // chatToolMessageContent.Str is populated - case components.ChatToolMessageContentTypeArrayOfChatContentItems: - // chatToolMessageContent.ArrayOfChatContentItems is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chattoolmessagerole.mdx b/client-sdks/go/api-reference/models/chattoolmessagerole.mdx deleted file mode 100644 index 16ebbfc0..00000000 --- a/client-sdks/go/api-reference/models/chattoolmessagerole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatToolMessageRole - Go SDK -sidebarTitle: ChatToolMessageRole -description: ChatToolMessageRole type definition -seoTitle: ChatToolMessageRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chattoolmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessageRole Type | OpenRouter Go SDK -'og:description': >- - ChatToolMessageRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessageRole%20-%20Go%20SDK&description=ChatToolMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatToolMessageRoleTool -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `ChatToolMessageRoleTool` | tool | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatusage.mdx b/client-sdks/go/api-reference/models/chatusage.mdx deleted file mode 100644 index a37adb6a..00000000 --- a/client-sdks/go/api-reference/models/chatusage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatUsage - Go SDK -sidebarTitle: ChatUsage -description: ChatUsage type definition -seoTitle: ChatUsage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatusage' -'og:site_name': OpenRouter Documentation -'og:title': ChatUsage Type | OpenRouter Go SDK -'og:description': >- - ChatUsage type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUsage%20-%20Go%20SDK&description=ChatUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CompletionTokens` | `int64` | :heavy_check_mark: | Number of tokens in the completion | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.CompletionTokensDetails](/client-sdks/go/api-reference/models/completiontokensdetails)] | :heavy_minus_sign: | Detailed completion token usage | | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](/client-sdks/go/api-reference/models/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.PromptTokensDetails](/client-sdks/go/api-reference/models/prompttokensdetails)] | :heavy_minus_sign: | Detailed prompt token usage | | -| `TotalTokens` | `int64` | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatusermessage.mdx b/client-sdks/go/api-reference/models/chatusermessage.mdx deleted file mode 100644 index 2bc7fa1b..00000000 --- a/client-sdks/go/api-reference/models/chatusermessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatUserMessage - Go SDK -sidebarTitle: ChatUserMessage -description: ChatUserMessage type definition -seoTitle: ChatUserMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatusermessage' -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessage Type | OpenRouter Go SDK -'og:description': >- - ChatUserMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessage%20-%20Go%20SDK&description=ChatUserMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -User message - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatUserMessageContent](/client-sdks/go/api-reference/models/chatusermessagecontent) | :heavy_check_mark: | User message content | What is the capital of France? | -| `Name` | `*string` | :heavy_minus_sign: | Optional name for the user | User | -| `Role` | [components.ChatUserMessageRole](/client-sdks/go/api-reference/models/chatusermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatusermessagecontent.mdx b/client-sdks/go/api-reference/models/chatusermessagecontent.mdx deleted file mode 100644 index 97e780a7..00000000 --- a/client-sdks/go/api-reference/models/chatusermessagecontent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ChatUserMessageContent - Go SDK -sidebarTitle: ChatUserMessageContent -description: ChatUserMessageContent type definition -seoTitle: ChatUserMessageContent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatusermessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessageContent Type | OpenRouter Go SDK -'og:description': >- - ChatUserMessageContent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessageContent%20-%20Go%20SDK&description=ChatUserMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -User message content - -## Supported Types - -### - -```go lines -chatUserMessageContent := components.CreateChatUserMessageContentStr(string{/* values here */}) -``` - -### - -```go lines -chatUserMessageContent := components.CreateChatUserMessageContentArrayOfChatContentItems([]components.ChatContentItems{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch chatUserMessageContent.Type { - case components.ChatUserMessageContentTypeStr: - // chatUserMessageContent.Str is populated - case components.ChatUserMessageContentTypeArrayOfChatContentItems: - // chatUserMessageContent.ArrayOfChatContentItems is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatusermessagerole.mdx b/client-sdks/go/api-reference/models/chatusermessagerole.mdx deleted file mode 100644 index eec46603..00000000 --- a/client-sdks/go/api-reference/models/chatusermessagerole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatUserMessageRole - Go SDK -sidebarTitle: ChatUserMessageRole -description: ChatUserMessageRole type definition -seoTitle: ChatUserMessageRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatusermessagerole' -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessageRole Type | OpenRouter Go SDK -'og:description': >- - ChatUserMessageRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessageRole%20-%20Go%20SDK&description=ChatUserMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatUserMessageRoleUser -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `ChatUserMessageRoleUser` | user | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/chatwebsearchshorthand.mdx b/client-sdks/go/api-reference/models/chatwebsearchshorthand.mdx deleted file mode 100644 index 5ee158f1..00000000 --- a/client-sdks/go/api-reference/models/chatwebsearchshorthand.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatWebSearchShorthand - Go SDK -sidebarTitle: ChatWebSearchShorthand -description: ChatWebSearchShorthand type definition -seoTitle: ChatWebSearchShorthand Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/chatwebsearchshorthand' -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthand Type | OpenRouter Go SDK -'og:description': >- - ChatWebSearchShorthand type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthand%20-%20Go%20SDK&description=ChatWebSearchShorthand%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search tool using OpenAI Responses API syntax. Automatically converted to openrouter:web_search. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 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 | -| `Parameters` | [*components.WebSearchConfig](/client-sdks/go/api-reference/models/websearchconfig) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `SearchContextSize` | [*components.SearchQualityLevel](/client-sdks/go/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `Type` | [components.ChatWebSearchShorthandType](/client-sdks/go/api-reference/models/chatwebsearchshorthandtype) | :heavy_check_mark: | N/A | | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/chatwebsearchshorthandtype.mdx b/client-sdks/go/api-reference/models/chatwebsearchshorthandtype.mdx deleted file mode 100644 index f3943d16..00000000 --- a/client-sdks/go/api-reference/models/chatwebsearchshorthandtype.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatWebSearchShorthandType - Go SDK -sidebarTitle: ChatWebSearchShorthandType -description: ChatWebSearchShorthandType type definition -seoTitle: ChatWebSearchShorthandType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/chatwebsearchshorthandtype -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthandType Type | OpenRouter Go SDK -'og:description': >- - ChatWebSearchShorthandType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthandType%20-%20Go%20SDK&description=ChatWebSearchShorthandType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ChatWebSearchShorthandTypeWebSearch - -// Open enum: custom values can be created with a direct type cast -custom := components.ChatWebSearchShorthandType("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `ChatWebSearchShorthandTypeWebSearch` | web_search | -| `ChatWebSearchShorthandTypeWebSearchPreview` | web_search_preview | -| `ChatWebSearchShorthandTypeWebSearchPreview20250311` | web_search_preview_2025_03_11 | -| `ChatWebSearchShorthandTypeWebSearch20250826` | web_search_2025_08_26 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/citation.mdx b/client-sdks/go/api-reference/models/citation.mdx deleted file mode 100644 index 791ca5ed..00000000 --- a/client-sdks/go/api-reference/models/citation.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Citation - Go SDK -sidebarTitle: Citation -description: Citation type definition -seoTitle: Citation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/citation' -'og:site_name': OpenRouter Documentation -'og:title': Citation Type | OpenRouter Go SDK -'og:description': >- - Citation type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Citation%20-%20Go%20SDK&description=Citation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicCitationCharLocationParam - -```go lines -citation := components.CreateCitationCharLocation(components.AnthropicCitationCharLocationParam{/* values here */}) -``` - -### AnthropicCitationContentBlockLocationParam - -```go lines -citation := components.CreateCitationContentBlockLocation(components.AnthropicCitationContentBlockLocationParam{/* values here */}) -``` - -### AnthropicCitationPageLocationParam - -```go lines -citation := components.CreateCitationPageLocation(components.AnthropicCitationPageLocationParam{/* values here */}) -``` - -### AnthropicCitationSearchResultLocation - -```go lines -citation := components.CreateCitationSearchResultLocation(components.AnthropicCitationSearchResultLocation{/* values here */}) -``` - -### AnthropicCitationWebSearchResultLocation - -```go lines -citation := components.CreateCitationWebSearchResultLocation(components.AnthropicCitationWebSearchResultLocation{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch citation.Type { - case components.CitationTypeCharLocation: - // citation.AnthropicCitationCharLocationParam is populated - case components.CitationTypeContentBlockLocation: - // citation.AnthropicCitationContentBlockLocationParam is populated - case components.CitationTypePageLocation: - // citation.AnthropicCitationPageLocationParam is populated - case components.CitationTypeSearchResultLocation: - // citation.AnthropicCitationSearchResultLocation is populated - case components.CitationTypeWebSearchResultLocation: - // citation.AnthropicCitationWebSearchResultLocation is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/cleartoolinputs.mdx b/client-sdks/go/api-reference/models/cleartoolinputs.mdx deleted file mode 100644 index 82aec3bd..00000000 --- a/client-sdks/go/api-reference/models/cleartoolinputs.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ClearToolInputs - Go SDK -sidebarTitle: ClearToolInputs -description: ClearToolInputs type definition -seoTitle: ClearToolInputs Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/cleartoolinputs' -'og:site_name': OpenRouter Documentation -'og:title': ClearToolInputs Type | OpenRouter Go SDK -'og:description': >- - ClearToolInputs type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ClearToolInputs%20-%20Go%20SDK&description=ClearToolInputs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -clearToolInputs := components.CreateClearToolInputsBoolean(bool{/* values here */}) -``` - -### - -```go lines -clearToolInputs := components.CreateClearToolInputsArrayOfStr([]string{/* values here */}) -``` - -### - -```go lines -clearToolInputs := components.CreateClearToolInputsAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch clearToolInputs.Type { - case components.ClearToolInputsTypeBoolean: - // clearToolInputs.Boolean is populated - case components.ClearToolInputsTypeArrayOfStr: - // clearToolInputs.ArrayOfStr is populated - case components.ClearToolInputsTypeAny: - // clearToolInputs.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/code.mdx b/client-sdks/go/api-reference/models/code.mdx deleted file mode 100644 index bf120404..00000000 --- a/client-sdks/go/api-reference/models/code.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Code - Go SDK -sidebarTitle: Code -description: Code type definition -seoTitle: Code Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/code' -'og:site_name': OpenRouter Documentation -'og:title': Code Type | OpenRouter Go SDK -'og:description': >- - Code type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Code%20-%20Go%20SDK&description=Code%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CodeServerError - -// Open enum: custom values can be created with a direct type cast -custom := components.Code("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `CodeServerError` | server_error | -| `CodeRateLimitExceeded` | rate_limit_exceeded | -| `CodeInvalidPrompt` | invalid_prompt | -| `CodeVectorStoreTimeout` | vector_store_timeout | -| `CodeInvalidImage` | invalid_image | -| `CodeInvalidImageFormat` | invalid_image_format | -| `CodeInvalidBase64Image` | invalid_base64_image | -| `CodeInvalidImageURL` | invalid_image_url | -| `CodeImageTooLarge` | image_too_large | -| `CodeImageTooSmall` | image_too_small | -| `CodeImageParseError` | image_parse_error | -| `CodeImageContentPolicyViolation` | image_content_policy_violation | -| `CodeInvalidImageMode` | invalid_image_mode | -| `CodeImageFileTooLarge` | image_file_too_large | -| `CodeUnsupportedImageMediaType` | unsupported_image_media_type | -| `CodeEmptyImageFile` | empty_image_file | -| `CodeFailedToDownloadImage` | failed_to_download_image | -| `CodeImageFileNotFound` | image_file_not_found | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/codeinterpreterservertool.mdx b/client-sdks/go/api-reference/models/codeinterpreterservertool.mdx deleted file mode 100644 index 378d12df..00000000 --- a/client-sdks/go/api-reference/models/codeinterpreterservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CodeInterpreterServerTool - Go SDK -sidebarTitle: CodeInterpreterServerTool -description: CodeInterpreterServerTool type definition -seoTitle: CodeInterpreterServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/codeinterpreterservertool -'og:site_name': OpenRouter Documentation -'og:title': CodeInterpreterServerTool Type | OpenRouter Go SDK -'og:description': >- - CodeInterpreterServerTool type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodeInterpreterServerTool%20-%20Go%20SDK&description=CodeInterpreterServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Code interpreter tool configuration - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Container` | [components.Container](/client-sdks/go/api-reference/models/container) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeCodeInterpreter](/client-sdks/go/api-reference/models/typecodeinterpreter) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/codexlocalshelltool.mdx b/client-sdks/go/api-reference/models/codexlocalshelltool.mdx deleted file mode 100644 index f4e037c4..00000000 --- a/client-sdks/go/api-reference/models/codexlocalshelltool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CodexLocalShellTool - Go SDK -sidebarTitle: CodexLocalShellTool -description: CodexLocalShellTool type definition -seoTitle: CodexLocalShellTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/codexlocalshelltool' -'og:site_name': OpenRouter Documentation -'og:title': CodexLocalShellTool Type | OpenRouter Go SDK -'og:description': >- - CodexLocalShellTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodexLocalShellTool%20-%20Go%20SDK&description=CodexLocalShellTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Local shell tool configuration - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Type` | [components.CodexLocalShellToolType](/client-sdks/go/api-reference/models/codexlocalshelltooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/codexlocalshelltooltype.mdx b/client-sdks/go/api-reference/models/codexlocalshelltooltype.mdx deleted file mode 100644 index affbea07..00000000 --- a/client-sdks/go/api-reference/models/codexlocalshelltooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CodexLocalShellToolType - Go SDK -sidebarTitle: CodexLocalShellToolType -description: CodexLocalShellToolType type definition -seoTitle: CodexLocalShellToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/codexlocalshelltooltype -'og:site_name': OpenRouter Documentation -'og:title': CodexLocalShellToolType Type | OpenRouter Go SDK -'og:description': >- - CodexLocalShellToolType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodexLocalShellToolType%20-%20Go%20SDK&description=CodexLocalShellToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CodexLocalShellToolTypeLocalShell -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `CodexLocalShellToolTypeLocalShell` | local_shell | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/command.mdx b/client-sdks/go/api-reference/models/command.mdx deleted file mode 100644 index f69b8992..00000000 --- a/client-sdks/go/api-reference/models/command.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Command - Go SDK -sidebarTitle: Command -description: Command type definition -seoTitle: Command Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/command' -'og:site_name': OpenRouter Documentation -'og:title': Command Type | OpenRouter Go SDK -'og:description': >- - Command type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Command%20-%20Go%20SDK&description=Command%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CommandView - -// Open enum: custom values can be created with a direct type cast -custom := components.Command("custom_value") -``` - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `CommandView` | view | -| `CommandCreate` | create | -| `CommandStrReplace` | str_replace | -| `CommandInsert` | insert | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/compactionitem.mdx b/client-sdks/go/api-reference/models/compactionitem.mdx deleted file mode 100644 index e4addcd7..00000000 --- a/client-sdks/go/api-reference/models/compactionitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CompactionItem - Go SDK -sidebarTitle: CompactionItem -description: CompactionItem type definition -seoTitle: CompactionItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/compactionitem' -'og:site_name': OpenRouter Documentation -'og:title': CompactionItem Type | OpenRouter Go SDK -'og:description': >- - CompactionItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItem%20-%20Go%20SDK&description=CompactionItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A context compaction marker with encrypted summary - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `EncryptedContent` | `string` | :heavy_check_mark: | N/A | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.CompactionItemType](/client-sdks/go/api-reference/models/compactionitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/compactionitemtype.mdx b/client-sdks/go/api-reference/models/compactionitemtype.mdx deleted file mode 100644 index f9a6b75a..00000000 --- a/client-sdks/go/api-reference/models/compactionitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CompactionItemType - Go SDK -sidebarTitle: CompactionItemType -description: CompactionItemType type definition -seoTitle: CompactionItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/compactionitemtype' -'og:site_name': OpenRouter Documentation -'og:title': CompactionItemType Type | OpenRouter Go SDK -'og:description': >- - CompactionItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItemType%20-%20Go%20SDK&description=CompactionItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CompactionItemTypeCompaction -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `CompactionItemTypeCompaction` | compaction | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/completiontokensdetails.mdx b/client-sdks/go/api-reference/models/completiontokensdetails.mdx deleted file mode 100644 index ef98de86..00000000 --- a/client-sdks/go/api-reference/models/completiontokensdetails.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CompletionTokensDetails - Go SDK -sidebarTitle: CompletionTokensDetails -description: CompletionTokensDetails type definition -seoTitle: CompletionTokensDetails Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/completiontokensdetails -'og:site_name': OpenRouter Documentation -'og:title': CompletionTokensDetails Type | OpenRouter Go SDK -'og:description': >- - CompletionTokensDetails type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionTokensDetails%20-%20Go%20SDK&description=CompletionTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Detailed completion token usage - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `AcceptedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Accepted prediction tokens | -| `AudioTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for audio output | -| `ReasoningTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Tokens used for reasoning | -| `RejectedPredictionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/compoundfilter.mdx b/client-sdks/go/api-reference/models/compoundfilter.mdx deleted file mode 100644 index 80a60579..00000000 --- a/client-sdks/go/api-reference/models/compoundfilter.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CompoundFilter - Go SDK -sidebarTitle: CompoundFilter -description: CompoundFilter type definition -seoTitle: CompoundFilter Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/compoundfilter' -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilter Type | OpenRouter Go SDK -'og:description': >- - CompoundFilter type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilter%20-%20Go%20SDK&description=CompoundFilter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A compound filter that combines multiple comparison or compound filters - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Filters` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.CompoundFilterType](/client-sdks/go/api-reference/models/compoundfiltertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/compoundfiltertype.mdx b/client-sdks/go/api-reference/models/compoundfiltertype.mdx deleted file mode 100644 index 1740b17d..00000000 --- a/client-sdks/go/api-reference/models/compoundfiltertype.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: CompoundFilterType - Go SDK -sidebarTitle: CompoundFilterType -description: CompoundFilterType type definition -seoTitle: CompoundFilterType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/compoundfiltertype' -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilterType Type | OpenRouter Go SDK -'og:description': >- - CompoundFilterType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilterType%20-%20Go%20SDK&description=CompoundFilterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CompoundFilterTypeAnd - -// Open enum: custom values can be created with a direct type cast -custom := components.CompoundFilterType("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `CompoundFilterTypeAnd` | and | -| `CompoundFilterTypeOr` | or | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/computeruseservertool.mdx b/client-sdks/go/api-reference/models/computeruseservertool.mdx deleted file mode 100644 index a4f5800b..00000000 --- a/client-sdks/go/api-reference/models/computeruseservertool.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ComputerUseServerTool - Go SDK -sidebarTitle: ComputerUseServerTool -description: ComputerUseServerTool type definition -seoTitle: ComputerUseServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/computeruseservertool' -'og:site_name': OpenRouter Documentation -'og:title': ComputerUseServerTool Type | OpenRouter Go SDK -'og:description': >- - ComputerUseServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ComputerUseServerTool%20-%20Go%20SDK&description=ComputerUseServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Computer use preview tool configuration - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `DisplayHeight` | `int64` | :heavy_check_mark: | N/A | -| `DisplayWidth` | `int64` | :heavy_check_mark: | N/A | -| `Environment` | [components.Environment](/client-sdks/go/api-reference/models/environment) | :heavy_check_mark: | N/A | -| `Type` | [components.ComputerUseServerToolType](/client-sdks/go/api-reference/models/computeruseservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/computeruseservertooltype.mdx b/client-sdks/go/api-reference/models/computeruseservertooltype.mdx deleted file mode 100644 index 547d9125..00000000 --- a/client-sdks/go/api-reference/models/computeruseservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ComputerUseServerToolType - Go SDK -sidebarTitle: ComputerUseServerToolType -description: ComputerUseServerToolType type definition -seoTitle: ComputerUseServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/computeruseservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ComputerUseServerToolType Type | OpenRouter Go SDK -'og:description': >- - ComputerUseServerToolType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ComputerUseServerToolType%20-%20Go%20SDK&description=ComputerUseServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ComputerUseServerToolTypeComputerUsePreview -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ComputerUseServerToolTypeComputerUsePreview` | computer_use_preview | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/conflictresponseerror.mdx b/client-sdks/go/api-reference/models/conflictresponseerror.mdx deleted file mode 100644 index 4ceb708b..00000000 --- a/client-sdks/go/api-reference/models/conflictresponseerror.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ConflictResponseError - Go SDK -sidebarTitle: ConflictResponseError -description: ConflictResponseError type definition -seoTitle: ConflictResponseError Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/conflictresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseError Type | OpenRouter Go SDK -'og:description': >- - ConflictResponseError type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseError%20-%20Go%20SDK&description=ConflictResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Conflict - Resource conflict or concurrent modification - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.ConflictResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/conflictresponseerrordata.mdx b/client-sdks/go/api-reference/models/conflictresponseerrordata.mdx deleted file mode 100644 index d8693f76..00000000 --- a/client-sdks/go/api-reference/models/conflictresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ConflictResponseErrorData - Go SDK -sidebarTitle: ConflictResponseErrorData -description: ConflictResponseErrorData type definition -seoTitle: ConflictResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/conflictresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - ConflictResponseErrorData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseErrorData%20-%20Go%20SDK&description=ConflictResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for ConflictResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/connectorid.mdx b/client-sdks/go/api-reference/models/connectorid.mdx deleted file mode 100644 index abcfb370..00000000 --- a/client-sdks/go/api-reference/models/connectorid.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ConnectorID - Go SDK -sidebarTitle: ConnectorID -description: ConnectorID type definition -seoTitle: ConnectorID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/connectorid' -'og:site_name': OpenRouter Documentation -'og:title': ConnectorID Type | OpenRouter Go SDK -'og:description': >- - ConnectorID type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConnectorID%20-%20Go%20SDK&description=ConnectorID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ConnectorIDConnectorDropbox - -// Open enum: custom values can be created with a direct type cast -custom := components.ConnectorID("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ConnectorIDConnectorDropbox` | connector_dropbox | -| `ConnectorIDConnectorGmail` | connector_gmail | -| `ConnectorIDConnectorGooglecalendar` | connector_googlecalendar | -| `ConnectorIDConnectorGoogledrive` | connector_googledrive | -| `ConnectorIDConnectorMicrosoftteams` | connector_microsoftteams | -| `ConnectorIDConnectorOutlookcalendar` | connector_outlookcalendar | -| `ConnectorIDConnectorOutlookemail` | connector_outlookemail | -| `ConnectorIDConnectorSharepoint` | connector_sharepoint | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/container.mdx b/client-sdks/go/api-reference/models/container.mdx deleted file mode 100644 index 23f00b6c..00000000 --- a/client-sdks/go/api-reference/models/container.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Container - Go SDK -sidebarTitle: Container -description: Container type definition -seoTitle: Container Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/container' -'og:site_name': OpenRouter Documentation -'og:title': Container Type | OpenRouter Go SDK -'og:description': >- - Container type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Container%20-%20Go%20SDK&description=Container%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -container := components.CreateContainerStr(string{/* values here */}) -``` - -### ContainerAuto - -```go lines -container := components.CreateContainerContainerAuto(components.ContainerAuto{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch container.Type { - case components.ContainerUnionTypeStr: - // container.Str is populated - case components.ContainerUnionTypeContainerAuto: - // container.ContainerAuto is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/containerauto.mdx b/client-sdks/go/api-reference/models/containerauto.mdx deleted file mode 100644 index 624f8f16..00000000 --- a/client-sdks/go/api-reference/models/containerauto.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContainerAuto - Go SDK -sidebarTitle: ContainerAuto -description: ContainerAuto type definition -seoTitle: ContainerAuto Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/containerauto' -'og:site_name': OpenRouter Documentation -'og:title': ContainerAuto Type | OpenRouter Go SDK -'og:description': >- - ContainerAuto type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerAuto%20-%20Go%20SDK&description=ContainerAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `FileIds` | []`string` | :heavy_minus_sign: | N/A | -| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](/client-sdks/go/api-reference/models/memorylimit)] | :heavy_minus_sign: | N/A | -| `Type` | [components.ContainerType](/client-sdks/go/api-reference/models/containertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/containertype.mdx b/client-sdks/go/api-reference/models/containertype.mdx deleted file mode 100644 index 48efd0a1..00000000 --- a/client-sdks/go/api-reference/models/containertype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ContainerType - Go SDK -sidebarTitle: ContainerType -description: ContainerType type definition -seoTitle: ContainerType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/containertype' -'og:site_name': OpenRouter Documentation -'og:title': ContainerType Type | OpenRouter Go SDK -'og:description': >- - ContainerType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerType%20-%20Go%20SDK&description=ContainerType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContainerTypeAuto -``` - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `ContainerTypeAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentcompaction.mdx b/client-sdks/go/api-reference/models/contentcompaction.mdx deleted file mode 100644 index e98dc899..00000000 --- a/client-sdks/go/api-reference/models/contentcompaction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentCompaction - Go SDK -sidebarTitle: ContentCompaction -description: ContentCompaction type definition -seoTitle: ContentCompaction Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentcompaction' -'og:site_name': OpenRouter Documentation -'og:title': ContentCompaction Type | OpenRouter Go SDK -'og:description': >- - ContentCompaction type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentCompaction%20-%20Go%20SDK&description=ContentCompaction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Content` | `*string` | :heavy_check_mark: | N/A | | -| `Type` | [components.MessagesMessageParamTypeCompaction](/client-sdks/go/api-reference/models/messagesmessageparamtypecompaction) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilteraction.mdx b/client-sdks/go/api-reference/models/contentfilteraction.mdx deleted file mode 100644 index 8d138abf..00000000 --- a/client-sdks/go/api-reference/models/contentfilteraction.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentFilterAction - Go SDK -sidebarTitle: ContentFilterAction -description: ContentFilterAction type definition -seoTitle: ContentFilterAction Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentfilteraction' -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterAction Type | OpenRouter Go SDK -'og:description': >- - ContentFilterAction type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterAction%20-%20Go%20SDK&description=ContentFilterAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Action taken when the pattern matches - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentFilterActionRedact - -// Open enum: custom values can be created with a direct type cast -custom := components.ContentFilterAction("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `ContentFilterActionRedact` | redact | -| `ContentFilterActionBlock` | block | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilterbuiltinaction.mdx b/client-sdks/go/api-reference/models/contentfilterbuiltinaction.mdx deleted file mode 100644 index ebb2e286..00000000 --- a/client-sdks/go/api-reference/models/contentfilterbuiltinaction.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ContentFilterBuiltinAction - Go SDK -sidebarTitle: ContentFilterBuiltinAction -description: ContentFilterBuiltinAction type definition -seoTitle: ContentFilterBuiltinAction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentfilterbuiltinaction -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinAction Type | OpenRouter Go SDK -'og:description': >- - ContentFilterBuiltinAction type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinAction%20-%20Go%20SDK&description=ContentFilterBuiltinAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Action taken when the builtin filter triggers - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentFilterBuiltinActionRedact - -// Open enum: custom values can be created with a direct type cast -custom := components.ContentFilterBuiltinAction("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ContentFilterBuiltinActionRedact` | redact | -| `ContentFilterBuiltinActionBlock` | block | -| `ContentFilterBuiltinActionFlag` | flag | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilterbuiltinentry.mdx b/client-sdks/go/api-reference/models/contentfilterbuiltinentry.mdx deleted file mode 100644 index 3247104f..00000000 --- a/client-sdks/go/api-reference/models/contentfilterbuiltinentry.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterBuiltinEntry - Go SDK -sidebarTitle: ContentFilterBuiltinEntry -description: ContentFilterBuiltinEntry type definition -seoTitle: ContentFilterBuiltinEntry Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentfilterbuiltinentry -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntry Type | OpenRouter Go SDK -'og:description': >- - ContentFilterBuiltinEntry type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntry%20-%20Go%20SDK&description=ContentFilterBuiltinEntry%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry. Builtin filters include PII detectors and the regex-based prompt injection detector. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](/client-sdks/go/api-reference/models/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] | -| `Slug` | [components.ContentFilterBuiltinSlug](/client-sdks/go/api-reference/models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilterbuiltinentryinput.mdx b/client-sdks/go/api-reference/models/contentfilterbuiltinentryinput.mdx deleted file mode 100644 index 48dc42b6..00000000 --- a/client-sdks/go/api-reference/models/contentfilterbuiltinentryinput.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterBuiltinEntryInput - Go SDK -sidebarTitle: ContentFilterBuiltinEntryInput -description: ContentFilterBuiltinEntryInput type definition -seoTitle: ContentFilterBuiltinEntryInput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentfilterbuiltinentryinput -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntryInput Type | OpenRouter Go SDK -'og:description': >- - ContentFilterBuiltinEntryInput type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntryInput%20-%20Go%20SDK&description=ContentFilterBuiltinEntryInput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry for create/update requests. Labels are system-assigned and cannot be set by the caller. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](/client-sdks/go/api-reference/models/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. | | -| `Slug` | [components.ContentFilterBuiltinSlug](/client-sdks/go/api-reference/models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilterbuiltinslug.mdx b/client-sdks/go/api-reference/models/contentfilterbuiltinslug.mdx deleted file mode 100644 index ea006bf7..00000000 --- a/client-sdks/go/api-reference/models/contentfilterbuiltinslug.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ContentFilterBuiltinSlug - Go SDK -sidebarTitle: ContentFilterBuiltinSlug -description: ContentFilterBuiltinSlug type definition -seoTitle: ContentFilterBuiltinSlug Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentfilterbuiltinslug -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinSlug Type | OpenRouter Go SDK -'og:description': >- - ContentFilterBuiltinSlug type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinSlug%20-%20Go%20SDK&description=ContentFilterBuiltinSlug%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The builtin filter identifier - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentFilterBuiltinSlugEmail - -// Open enum: custom values can be created with a direct type cast -custom := components.ContentFilterBuiltinSlug("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `ContentFilterBuiltinSlugEmail` | email | -| `ContentFilterBuiltinSlugPhone` | phone | -| `ContentFilterBuiltinSlugSsn` | ssn | -| `ContentFilterBuiltinSlugCreditCard` | credit-card | -| `ContentFilterBuiltinSlugIPAddress` | ip-address | -| `ContentFilterBuiltinSlugPersonName` | person-name | -| `ContentFilterBuiltinSlugAddress` | address | -| `ContentFilterBuiltinSlugRegexPromptInjection` | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentfilterentry.mdx b/client-sdks/go/api-reference/models/contentfilterentry.mdx deleted file mode 100644 index 170b6d8a..00000000 --- a/client-sdks/go/api-reference/models/contentfilterentry.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentFilterEntry - Go SDK -sidebarTitle: ContentFilterEntry -description: ContentFilterEntry type definition -seoTitle: ContentFilterEntry Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentfilterentry' -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterEntry Type | OpenRouter Go SDK -'og:description': >- - ContentFilterEntry type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterEntry%20-%20Go%20SDK&description=ContentFilterEntry%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A custom regex content filter that scans request messages for matching patterns. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterAction](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/contentpartaddedevent.mdx b/client-sdks/go/api-reference/models/contentpartaddedevent.mdx deleted file mode 100644 index fe8d4377..00000000 --- a/client-sdks/go/api-reference/models/contentpartaddedevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ContentPartAddedEvent - Go SDK -sidebarTitle: ContentPartAddedEvent -description: ContentPartAddedEvent type definition -seoTitle: ContentPartAddedEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartaddedevent' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEvent Type | OpenRouter Go SDK -'og:description': >- - ContentPartAddedEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEvent%20-%20Go%20SDK&description=ContentPartAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a new content part is added to an output item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartAddedEventPart](/client-sdks/go/api-reference/models/contentpartaddedeventpart) | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartAddedEventType](/client-sdks/go/api-reference/models/contentpartaddedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartaddedeventpart.mdx b/client-sdks/go/api-reference/models/contentpartaddedeventpart.mdx deleted file mode 100644 index 634e99a4..00000000 --- a/client-sdks/go/api-reference/models/contentpartaddedeventpart.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ContentPartAddedEventPart - Go SDK -sidebarTitle: ContentPartAddedEventPart -description: ContentPartAddedEventPart type definition -seoTitle: ContentPartAddedEventPart Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartaddedeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEventPart Type | OpenRouter Go SDK -'og:description': >- - ContentPartAddedEventPart type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEventPart%20-%20Go%20SDK&description=ContentPartAddedEventPart%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponseOutputText - -```go lines -contentPartAddedEventPart := components.CreateContentPartAddedEventPartOutputText(components.ResponseOutputText{/* values here */}) -``` - -### ReasoningTextContent - -```go lines -contentPartAddedEventPart := components.CreateContentPartAddedEventPartReasoningText(components.ReasoningTextContent{/* values here */}) -``` - -### OpenAIResponsesRefusalContent - -```go lines -contentPartAddedEventPart := components.CreateContentPartAddedEventPartRefusal(components.OpenAIResponsesRefusalContent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch contentPartAddedEventPart.Type { - case components.ContentPartAddedEventPartTypeOutputText: - // contentPartAddedEventPart.ResponseOutputText is populated - case components.ContentPartAddedEventPartTypeReasoningText: - // contentPartAddedEventPart.ReasoningTextContent is populated - case components.ContentPartAddedEventPartTypeRefusal: - // contentPartAddedEventPart.OpenAIResponsesRefusalContent is populated - default: - // Unknown type - use contentPartAddedEventPart.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartaddedeventtype.mdx b/client-sdks/go/api-reference/models/contentpartaddedeventtype.mdx deleted file mode 100644 index a0549ce6..00000000 --- a/client-sdks/go/api-reference/models/contentpartaddedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartAddedEventType - Go SDK -sidebarTitle: ContentPartAddedEventType -description: ContentPartAddedEventType type definition -seoTitle: ContentPartAddedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEventType Type | OpenRouter Go SDK -'og:description': >- - ContentPartAddedEventType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEventType%20-%20Go%20SDK&description=ContentPartAddedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartAddedEventTypeResponseContentPartAdded -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `ContentPartAddedEventTypeResponseContentPartAdded` | response.content_part.added | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartdoneevent.mdx b/client-sdks/go/api-reference/models/contentpartdoneevent.mdx deleted file mode 100644 index 0c39f1d1..00000000 --- a/client-sdks/go/api-reference/models/contentpartdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ContentPartDoneEvent - Go SDK -sidebarTitle: ContentPartDoneEvent -description: ContentPartDoneEvent type definition -seoTitle: ContentPartDoneEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartdoneevent' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEvent Type | OpenRouter Go SDK -'og:description': >- - ContentPartDoneEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEvent%20-%20Go%20SDK&description=ContentPartDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a content part is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartDoneEventPart](/client-sdks/go/api-reference/models/contentpartdoneeventpart) | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartDoneEventType](/client-sdks/go/api-reference/models/contentpartdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartdoneeventpart.mdx b/client-sdks/go/api-reference/models/contentpartdoneeventpart.mdx deleted file mode 100644 index bfa3a88c..00000000 --- a/client-sdks/go/api-reference/models/contentpartdoneeventpart.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ContentPartDoneEventPart - Go SDK -sidebarTitle: ContentPartDoneEventPart -description: ContentPartDoneEventPart type definition -seoTitle: ContentPartDoneEventPart Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartdoneeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEventPart Type | OpenRouter Go SDK -'og:description': >- - ContentPartDoneEventPart type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEventPart%20-%20Go%20SDK&description=ContentPartDoneEventPart%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponseOutputText - -```go lines -contentPartDoneEventPart := components.CreateContentPartDoneEventPartOutputText(components.ResponseOutputText{/* values here */}) -``` - -### ReasoningTextContent - -```go lines -contentPartDoneEventPart := components.CreateContentPartDoneEventPartReasoningText(components.ReasoningTextContent{/* values here */}) -``` - -### OpenAIResponsesRefusalContent - -```go lines -contentPartDoneEventPart := components.CreateContentPartDoneEventPartRefusal(components.OpenAIResponsesRefusalContent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch contentPartDoneEventPart.Type { - case components.ContentPartDoneEventPartTypeOutputText: - // contentPartDoneEventPart.ResponseOutputText is populated - case components.ContentPartDoneEventPartTypeReasoningText: - // contentPartDoneEventPart.ReasoningTextContent is populated - case components.ContentPartDoneEventPartTypeRefusal: - // contentPartDoneEventPart.OpenAIResponsesRefusalContent is populated - default: - // Unknown type - use contentPartDoneEventPart.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartdoneeventtype.mdx b/client-sdks/go/api-reference/models/contentpartdoneeventtype.mdx deleted file mode 100644 index 88653053..00000000 --- a/client-sdks/go/api-reference/models/contentpartdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartDoneEventType - Go SDK -sidebarTitle: ContentPartDoneEventType -description: ContentPartDoneEventType type definition -seoTitle: ContentPartDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEventType Type | OpenRouter Go SDK -'og:description': >- - ContentPartDoneEventType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEventType%20-%20Go%20SDK&description=ContentPartDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartDoneEventTypeResponseContentPartDone -``` - -## Values - -| Name | Value | -| ------------------------------------------------- | ------------------------------------------------- | -| `ContentPartDoneEventTypeResponseContentPartDone` | response.content_part.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartimage.mdx b/client-sdks/go/api-reference/models/contentpartimage.mdx deleted file mode 100644 index 5fe0fc05..00000000 --- a/client-sdks/go/api-reference/models/contentpartimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartImage - Go SDK -sidebarTitle: ContentPartImage -description: ContentPartImage type definition -seoTitle: ContentPartImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartimage' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImage Type | OpenRouter Go SDK -'og:description': >- - ContentPartImage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImage%20-%20Go%20SDK&description=ContentPartImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ContentPartImageImageURL](/client-sdks/go/api-reference/models/contentpartimageimageurl) | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartImageType](/client-sdks/go/api-reference/models/contentpartimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartimageimageurl.mdx b/client-sdks/go/api-reference/models/contentpartimageimageurl.mdx deleted file mode 100644 index 2f53ce43..00000000 --- a/client-sdks/go/api-reference/models/contentpartimageimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartImageImageURL - Go SDK -sidebarTitle: ContentPartImageImageURL -description: ContentPartImageImageURL type definition -seoTitle: ContentPartImageImageURL Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageImageURL Type | OpenRouter Go SDK -'og:description': >- - ContentPartImageImageURL type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageImageURL%20-%20Go%20SDK&description=ContentPartImageImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartimagetype.mdx b/client-sdks/go/api-reference/models/contentpartimagetype.mdx deleted file mode 100644 index a202e48d..00000000 --- a/client-sdks/go/api-reference/models/contentpartimagetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ContentPartImageType - Go SDK -sidebarTitle: ContentPartImageType -description: ContentPartImageType type definition -seoTitle: ContentPartImageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartimagetype' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageType Type | OpenRouter Go SDK -'og:description': >- - ContentPartImageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageType%20-%20Go%20SDK&description=ContentPartImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartImageTypeImageURL -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ContentPartImageTypeImageURL` | image_url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputaudio.mdx b/client-sdks/go/api-reference/models/contentpartinputaudio.mdx deleted file mode 100644 index abe0e0c7..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputaudio.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputAudio - Go SDK -sidebarTitle: ContentPartInputAudio -description: ContentPartInputAudio type definition -seoTitle: ContentPartInputAudio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputAudio Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputAudio type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputAudio%20-%20Go%20SDK&description=ContentPartInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.MultimodalMedia](/client-sdks/go/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `Type` | [components.ContentPartInputAudioType](/client-sdks/go/api-reference/models/contentpartinputaudiotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputaudiotype.mdx b/client-sdks/go/api-reference/models/contentpartinputaudiotype.mdx deleted file mode 100644 index 7db02ff1..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputaudiotype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartInputAudioType - Go SDK -sidebarTitle: ContentPartInputAudioType -description: ContentPartInputAudioType type definition -seoTitle: ContentPartInputAudioType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartinputaudiotype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputAudioType Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputAudioType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputAudioType%20-%20Go%20SDK&description=ContentPartInputAudioType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartInputAudioTypeInputAudio -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ContentPartInputAudioTypeInputAudio` | input_audio | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputfile.mdx b/client-sdks/go/api-reference/models/contentpartinputfile.mdx deleted file mode 100644 index f879eaba..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputfile.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputFile - Go SDK -sidebarTitle: ContentPartInputFile -description: ContentPartInputFile type definition -seoTitle: ContentPartInputFile Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartinputfile' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputFile Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputFile type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputFile%20-%20Go%20SDK&description=ContentPartInputFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `InputFile` | [components.MultimodalMedia](/client-sdks/go/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `Type` | [components.ContentPartInputFileType](/client-sdks/go/api-reference/models/contentpartinputfiletype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputfiletype.mdx b/client-sdks/go/api-reference/models/contentpartinputfiletype.mdx deleted file mode 100644 index 00d1d2e5..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputfiletype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartInputFileType - Go SDK -sidebarTitle: ContentPartInputFileType -description: ContentPartInputFileType type definition -seoTitle: ContentPartInputFileType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartinputfiletype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputFileType Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputFileType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputFileType%20-%20Go%20SDK&description=ContentPartInputFileType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartInputFileTypeInputFile -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ContentPartInputFileTypeInputFile` | input_file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputvideo.mdx b/client-sdks/go/api-reference/models/contentpartinputvideo.mdx deleted file mode 100644 index 575fbd69..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputvideo.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputVideo - Go SDK -sidebarTitle: ContentPartInputVideo -description: ContentPartInputVideo type definition -seoTitle: ContentPartInputVideo Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentpartinputvideo' -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputVideo Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputVideo type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputVideo%20-%20Go%20SDK&description=ContentPartInputVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputVideo` | [components.MultimodalMedia](/client-sdks/go/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `Type` | [components.ContentPartInputVideoType](/client-sdks/go/api-reference/models/contentpartinputvideotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentpartinputvideotype.mdx b/client-sdks/go/api-reference/models/contentpartinputvideotype.mdx deleted file mode 100644 index c7118b8a..00000000 --- a/client-sdks/go/api-reference/models/contentpartinputvideotype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartInputVideoType - Go SDK -sidebarTitle: ContentPartInputVideoType -description: ContentPartInputVideoType type definition -seoTitle: ContentPartInputVideoType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentpartinputvideotype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputVideoType Type | OpenRouter Go SDK -'og:description': >- - ContentPartInputVideoType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputVideoType%20-%20Go%20SDK&description=ContentPartInputVideoType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContentPartInputVideoTypeInputVideo -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ContentPartInputVideoTypeInputVideo` | input_video | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentredactedthinking.mdx b/client-sdks/go/api-reference/models/contentredactedthinking.mdx deleted file mode 100644 index 109416cd..00000000 --- a/client-sdks/go/api-reference/models/contentredactedthinking.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentRedactedThinking - Go SDK -sidebarTitle: ContentRedactedThinking -description: ContentRedactedThinking type definition -seoTitle: ContentRedactedThinking Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentredactedthinking -'og:site_name': OpenRouter Documentation -'og:title': ContentRedactedThinking Type | OpenRouter Go SDK -'og:description': >- - ContentRedactedThinking type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentRedactedThinking%20-%20Go%20SDK&description=ContentRedactedThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeRedactedThinking](/client-sdks/go/api-reference/models/typeredactedthinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentservertooluse.mdx b/client-sdks/go/api-reference/models/contentservertooluse.mdx deleted file mode 100644 index 185c8285..00000000 --- a/client-sdks/go/api-reference/models/contentservertooluse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentServerToolUse - Go SDK -sidebarTitle: ContentServerToolUse -description: ContentServerToolUse type definition -seoTitle: ContentServerToolUse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentservertooluse' -'og:site_name': OpenRouter Documentation -'og:title': ContentServerToolUse Type | OpenRouter Go SDK -'og:description': >- - ContentServerToolUse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentServerToolUse%20-%20Go%20SDK&description=ContentServerToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeServerToolUse](/client-sdks/go/api-reference/models/typeservertooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentthinking.mdx b/client-sdks/go/api-reference/models/contentthinking.mdx deleted file mode 100644 index 59317483..00000000 --- a/client-sdks/go/api-reference/models/contentthinking.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentThinking - Go SDK -sidebarTitle: ContentThinking -description: ContentThinking type definition -seoTitle: ContentThinking Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contentthinking' -'og:site_name': OpenRouter Documentation -'og:title': ContentThinking Type | OpenRouter Go SDK -'og:description': >- - ContentThinking type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentThinking%20-%20Go%20SDK&description=ContentThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Signature` | `string` | :heavy_check_mark: | N/A | -| `Thinking` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeThinking](/client-sdks/go/api-reference/models/typethinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contenttoolreference.mdx b/client-sdks/go/api-reference/models/contenttoolreference.mdx deleted file mode 100644 index 90f79fca..00000000 --- a/client-sdks/go/api-reference/models/contenttoolreference.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentToolReference - Go SDK -sidebarTitle: ContentToolReference -description: ContentToolReference type definition -seoTitle: ContentToolReference Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contenttoolreference' -'og:site_name': OpenRouter Documentation -'og:title': ContentToolReference Type | OpenRouter Go SDK -'og:description': >- - ContentToolReference type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolReference%20-%20Go%20SDK&description=ContentToolReference%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeToolReference](/client-sdks/go/api-reference/models/typetoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contenttoolresult.mdx b/client-sdks/go/api-reference/models/contenttoolresult.mdx deleted file mode 100644 index 1645d705..00000000 --- a/client-sdks/go/api-reference/models/contenttoolresult.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentToolResult - Go SDK -sidebarTitle: ContentToolResult -description: ContentToolResult type definition -seoTitle: ContentToolResult Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contenttoolresult' -'og:site_name': OpenRouter Documentation -'og:title': ContentToolResult Type | OpenRouter Go SDK -'og:description': >- - ContentToolResult type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolResult%20-%20Go%20SDK&description=ContentToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Content` | [*components.MessagesMessageParamContentUnion2](/client-sdks/go/api-reference/models/messagesmessageparamcontentunion2) | :heavy_minus_sign: | N/A | | -| `IsError` | `*bool` | :heavy_minus_sign: | N/A | | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolResult](/client-sdks/go/api-reference/models/typetoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contenttooluse.mdx b/client-sdks/go/api-reference/models/contenttooluse.mdx deleted file mode 100644 index ce0ee05a..00000000 --- a/client-sdks/go/api-reference/models/contenttooluse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentToolUse - Go SDK -sidebarTitle: ContentToolUse -description: ContentToolUse type definition -seoTitle: ContentToolUse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contenttooluse' -'og:site_name': OpenRouter Documentation -'og:title': ContentToolUse Type | OpenRouter Go SDK -'og:description': >- - ContentToolUse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolUse%20-%20Go%20SDK&description=ContentToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Input` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolUse](/client-sdks/go/api-reference/models/typetooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentwebsearchtoolresult.mdx b/client-sdks/go/api-reference/models/contentwebsearchtoolresult.mdx deleted file mode 100644 index e412749e..00000000 --- a/client-sdks/go/api-reference/models/contentwebsearchtoolresult.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentWebSearchToolResult - Go SDK -sidebarTitle: ContentWebSearchToolResult -description: ContentWebSearchToolResult type definition -seoTitle: ContentWebSearchToolResult Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentwebsearchtoolresult -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResult Type | OpenRouter Go SDK -'og:description': >- - ContentWebSearchToolResult type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResult%20-%20Go%20SDK&description=ContentWebSearchToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Content` | [components.MessagesMessageParamContentUnion3](/client-sdks/go/api-reference/models/messagesmessageparamcontentunion3) | :heavy_check_mark: | N/A | | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearchToolResult](/client-sdks/go/api-reference/models/typewebsearchtoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contentwebsearchtoolresulterror.mdx b/client-sdks/go/api-reference/models/contentwebsearchtoolresulterror.mdx deleted file mode 100644 index 8f7e6402..00000000 --- a/client-sdks/go/api-reference/models/contentwebsearchtoolresulterror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentWebSearchToolResultError - Go SDK -sidebarTitle: ContentWebSearchToolResultError -description: ContentWebSearchToolResultError type definition -seoTitle: ContentWebSearchToolResultError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contentwebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResultError Type | OpenRouter Go SDK -'og:description': >- - ContentWebSearchToolResultError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResultError%20-%20Go%20SDK&description=ContentWebSearchToolResultError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.ErrorCode](/client-sdks/go/api-reference/models/errorcode) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeWebSearchToolResultError](/client-sdks/go/api-reference/models/typewebsearchtoolresulterror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contextcompressionengine.mdx b/client-sdks/go/api-reference/models/contextcompressionengine.mdx deleted file mode 100644 index 1d23e282..00000000 --- a/client-sdks/go/api-reference/models/contextcompressionengine.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContextCompressionEngine - Go SDK -sidebarTitle: ContextCompressionEngine -description: ContextCompressionEngine type definition -seoTitle: ContextCompressionEngine Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contextcompressionengine -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionEngine Type | OpenRouter Go SDK -'og:description': >- - ContextCompressionEngine type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionEngine%20-%20Go%20SDK&description=ContextCompressionEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The compression engine to use. Defaults to "middle-out". - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContextCompressionEngineMiddleOut -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ContextCompressionEngineMiddleOut` | middle-out | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contextcompressionplugin.mdx b/client-sdks/go/api-reference/models/contextcompressionplugin.mdx deleted file mode 100644 index b61b7d9c..00000000 --- a/client-sdks/go/api-reference/models/contextcompressionplugin.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContextCompressionPlugin - Go SDK -sidebarTitle: ContextCompressionPlugin -description: ContextCompressionPlugin type definition -seoTitle: ContextCompressionPlugin Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contextcompressionplugin -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionPlugin Type | OpenRouter Go SDK -'og:description': >- - ContextCompressionPlugin type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionPlugin%20-%20Go%20SDK&description=ContextCompressionPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/contextcompressionengine) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `ID` | [components.ContextCompressionPluginID](/client-sdks/go/api-reference/models/contextcompressionpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contextcompressionpluginid.mdx b/client-sdks/go/api-reference/models/contextcompressionpluginid.mdx deleted file mode 100644 index 23362fd0..00000000 --- a/client-sdks/go/api-reference/models/contextcompressionpluginid.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContextCompressionPluginID - Go SDK -sidebarTitle: ContextCompressionPluginID -description: ContextCompressionPluginID type definition -seoTitle: ContextCompressionPluginID Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/contextcompressionpluginid -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionPluginID Type | OpenRouter Go SDK -'og:description': >- - ContextCompressionPluginID type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionPluginID%20-%20Go%20SDK&description=ContextCompressionPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ContextCompressionPluginIDContextCompression -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `ContextCompressionPluginIDContextCompression` | context-compression | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contextmanagement.mdx b/client-sdks/go/api-reference/models/contextmanagement.mdx deleted file mode 100644 index 0cef7680..00000000 --- a/client-sdks/go/api-reference/models/contextmanagement.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ContextManagement - Go SDK -sidebarTitle: ContextManagement -description: ContextManagement type definition -seoTitle: ContextManagement Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contextmanagement' -'og:site_name': OpenRouter Documentation -'og:title': ContextManagement Type | OpenRouter Go SDK -'og:description': >- - ContextManagement type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextManagement%20-%20Go%20SDK&description=ContextManagement%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `Edits` | [][components.Edit](/client-sdks/go/api-reference/models/edit) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/contradiction.mdx b/client-sdks/go/api-reference/models/contradiction.mdx deleted file mode 100644 index 16a1fbd3..00000000 --- a/client-sdks/go/api-reference/models/contradiction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Contradiction - Go SDK -sidebarTitle: Contradiction -description: Contradiction type definition -seoTitle: Contradiction Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/contradiction' -'og:site_name': OpenRouter Documentation -'og:title': Contradiction Type | OpenRouter Go SDK -'og:description': >- - Contradiction type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Contradiction%20-%20Go%20SDK&description=Contradiction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Stances` | [][components.Stance](/client-sdks/go/api-reference/models/stance) | :heavy_check_mark: | N/A | -| `Topic` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/costdetails.mdx b/client-sdks/go/api-reference/models/costdetails.mdx deleted file mode 100644 index 450b87d8..00000000 --- a/client-sdks/go/api-reference/models/costdetails.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CostDetails - Go SDK -sidebarTitle: CostDetails -description: CostDetails type definition -seoTitle: CostDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/costdetails' -'og:site_name': OpenRouter Documentation -'og:title': CostDetails Type | OpenRouter Go SDK -'og:description': >- - CostDetails type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CostDetails%20-%20Go%20SDK&description=CostDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Breakdown of upstream inference costs - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `UpstreamInferenceCompletionsCost` | `float64` | :heavy_check_mark: | N/A | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `UpstreamInferencePromptCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/createbyokkeyrequest.mdx b/client-sdks/go/api-reference/models/createbyokkeyrequest.mdx deleted file mode 100644 index 2528c070..00000000 --- a/client-sdks/go/api-reference/models/createbyokkeyrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateBYOKKeyRequest - Go SDK -sidebarTitle: CreateBYOKKeyRequest -description: CreateBYOKKeyRequest type definition -seoTitle: CreateBYOKKeyRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/createbyokkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyRequest Type | OpenRouter Go SDK -'og:description': >- - CreateBYOKKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyRequest%20-%20Go%20SDK&description=CreateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createbyokkeyresponse.mdx b/client-sdks/go/api-reference/models/createbyokkeyresponse.mdx deleted file mode 100644 index 0bc68aaf..00000000 --- a/client-sdks/go/api-reference/models/createbyokkeyresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CreateBYOKKeyResponse - Go SDK -sidebarTitle: CreateBYOKKeyResponse -description: CreateBYOKKeyResponse type definition -seoTitle: CreateBYOKKeyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/createbyokkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyResponse Type | OpenRouter Go SDK -'og:description': >- - CreateBYOKKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyResponse%20-%20Go%20SDK&description=CreateBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createguardrailrequest.mdx b/client-sdks/go/api-reference/models/createguardrailrequest.mdx deleted file mode 100644 index f8aaf839..00000000 --- a/client-sdks/go/api-reference/models/createguardrailrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateGuardrailRequest - Go SDK -sidebarTitle: CreateGuardrailRequest -description: CreateGuardrailRequest type definition -seoTitle: CreateGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/createguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - CreateGuardrailRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20Go%20SDK&description=CreateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](/client-sdks/go/api-reference/models/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 | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createguardrailresponse.mdx b/client-sdks/go/api-reference/models/createguardrailresponse.mdx deleted file mode 100644 index 97428cf1..00000000 --- a/client-sdks/go/api-reference/models/createguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateGuardrailResponse - Go SDK -sidebarTitle: CreateGuardrailResponse -description: CreateGuardrailResponse type definition -seoTitle: CreateGuardrailResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResponse Type | OpenRouter Go SDK -'og:description': >- - CreateGuardrailResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResponse%20-%20Go%20SDK&description=CreateGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](/client-sdks/go/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/go/api-reference/models/createobservabilitydestinationrequest.mdx b/client-sdks/go/api-reference/models/createobservabilitydestinationrequest.mdx deleted file mode 100644 index d0af5dda..00000000 --- a/client-sdks/go/api-reference/models/createobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateObservabilityDestinationRequest - Go SDK -sidebarTitle: CreateObservabilityDestinationRequest -description: CreateObservabilityDestinationRequest type definition -seoTitle: CreateObservabilityDestinationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequest Type | OpenRouter Go SDK -'og:description': >- - CreateObservabilityDestinationRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequest%20-%20Go%20SDK&description=CreateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | `` | -| `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.ObservabilityFilterRulesConfig](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig)] | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createobservabilitydestinationrequesttype.mdx b/client-sdks/go/api-reference/models/createobservabilitydestinationrequesttype.mdx deleted file mode 100644 index 21c0985a..00000000 --- a/client-sdks/go/api-reference/models/createobservabilitydestinationrequesttype.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: CreateObservabilityDestinationRequestType - Go SDK -sidebarTitle: CreateObservabilityDestinationRequestType -description: CreateObservabilityDestinationRequestType type definition -seoTitle: CreateObservabilityDestinationRequestType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createobservabilitydestinationrequesttype -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequestType Type | OpenRouter Go SDK -'og:description': >- - CreateObservabilityDestinationRequestType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequestType%20-%20Go%20SDK&description=CreateObservabilityDestinationRequestType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The destination type. Only stable destination types are accepted. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CreateObservabilityDestinationRequestTypeArize - -// Open enum: custom values can be created with a direct type cast -custom := components.CreateObservabilityDestinationRequestType("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `CreateObservabilityDestinationRequestTypeArize` | arize | -| `CreateObservabilityDestinationRequestTypeBraintrust` | braintrust | -| `CreateObservabilityDestinationRequestTypeClickhouse` | clickhouse | -| `CreateObservabilityDestinationRequestTypeDatadog` | datadog | -| `CreateObservabilityDestinationRequestTypeGrafana` | grafana | -| `CreateObservabilityDestinationRequestTypeLangfuse` | langfuse | -| `CreateObservabilityDestinationRequestTypeLangsmith` | langsmith | -| `CreateObservabilityDestinationRequestTypeNewrelic` | newrelic | -| `CreateObservabilityDestinationRequestTypeOpik` | opik | -| `CreateObservabilityDestinationRequestTypeOtelCollector` | otel-collector | -| `CreateObservabilityDestinationRequestTypePosthog` | posthog | -| `CreateObservabilityDestinationRequestTypeRamp` | ramp | -| `CreateObservabilityDestinationRequestTypeS3` | s3 | -| `CreateObservabilityDestinationRequestTypeSentry` | sentry | -| `CreateObservabilityDestinationRequestTypeSnowflake` | snowflake | -| `CreateObservabilityDestinationRequestTypeWeave` | weave | -| `CreateObservabilityDestinationRequestTypeWebhook` | webhook | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/createobservabilitydestinationresponse.mdx b/client-sdks/go/api-reference/models/createobservabilitydestinationresponse.mdx deleted file mode 100644 index fcbd873d..00000000 --- a/client-sdks/go/api-reference/models/createobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateObservabilityDestinationResponse - Go SDK -sidebarTitle: CreateObservabilityDestinationResponse -description: CreateObservabilityDestinationResponse type definition -seoTitle: CreateObservabilityDestinationResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationResponse Type | OpenRouter Go SDK -'og:description': >- - CreateObservabilityDestinationResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationResponse%20-%20Go%20SDK&description=CreateObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createpresetfrominferenceresponse.mdx b/client-sdks/go/api-reference/models/createpresetfrominferenceresponse.mdx deleted file mode 100644 index 22af6464..00000000 --- a/client-sdks/go/api-reference/models/createpresetfrominferenceresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreatePresetFromInferenceResponse - Go SDK -sidebarTitle: CreatePresetFromInferenceResponse -description: CreatePresetFromInferenceResponse type definition -seoTitle: CreatePresetFromInferenceResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createpresetfrominferenceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetFromInferenceResponse Type | OpenRouter Go SDK -'og:description': >- - CreatePresetFromInferenceResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetFromInferenceResponse%20-%20Go%20SDK&description=CreatePresetFromInferenceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Response containing the created preset with its designated version. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/createworkspacerequest.mdx b/client-sdks/go/api-reference/models/createworkspacerequest.mdx deleted file mode 100644 index bc231b02..00000000 --- a/client-sdks/go/api-reference/models/createworkspacerequest.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CreateWorkspaceRequest - Go SDK -sidebarTitle: CreateWorkspaceRequest -description: CreateWorkspaceRequest type definition -seoTitle: CreateWorkspaceRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/createworkspacerequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceRequest Type | OpenRouter Go SDK -'og:description': >- - CreateWorkspaceRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceRequest%20-%20Go%20SDK&description=CreateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | -| `Name` | `string` | :heavy_check_mark: | Name for the new workspace | Production | -| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/createworkspaceresponse.mdx b/client-sdks/go/api-reference/models/createworkspaceresponse.mdx deleted file mode 100644 index 4070e4ef..00000000 --- a/client-sdks/go/api-reference/models/createworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateWorkspaceResponse - Go SDK -sidebarTitle: CreateWorkspaceResponse -description: CreateWorkspaceResponse type definition -seoTitle: CreateWorkspaceResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/createworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceResponse Type | OpenRouter Go SDK -'og:description': >- - CreateWorkspaceResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceResponse%20-%20Go%20SDK&description=CreateWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](/client-sdks/go/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/go/api-reference/models/customtool.mdx b/client-sdks/go/api-reference/models/customtool.mdx deleted file mode 100644 index 601158c1..00000000 --- a/client-sdks/go/api-reference/models/customtool.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CustomTool - Go SDK -sidebarTitle: CustomTool -description: CustomTool type definition -seoTitle: CustomTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/customtool' -'og:site_name': OpenRouter Documentation -'og:title': CustomTool Type | OpenRouter Go SDK -'og:description': >- - CustomTool type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomTool%20-%20Go%20SDK&description=CustomTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Custom tool configuration - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Description` | `*string` | :heavy_minus_sign: | N/A | -| `Format` | [*components.Format](/client-sdks/go/api-reference/models/format) | :heavy_minus_sign: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolTypeCustom](/client-sdks/go/api-reference/models/customtooltypecustom) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallinputdeltaevent.mdx b/client-sdks/go/api-reference/models/customtoolcallinputdeltaevent.mdx deleted file mode 100644 index 45d0c7e1..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallinputdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomToolCallInputDeltaEvent - Go SDK -sidebarTitle: CustomToolCallInputDeltaEvent -description: CustomToolCallInputDeltaEvent type definition -seoTitle: CustomToolCallInputDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcallinputdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallInputDeltaEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDeltaEvent%20-%20Go%20SDK&description=CustomToolCallInputDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input is being streamed. Mirrors `response.function_call_arguments.delta` but for `custom` tools whose input is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | :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.CustomToolCallInputDeltaEventType](/client-sdks/go/api-reference/models/customtoolcallinputdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallinputdeltaeventtype.mdx b/client-sdks/go/api-reference/models/customtoolcallinputdeltaeventtype.mdx deleted file mode 100644 index dde5b07a..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallinputdeltaeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CustomToolCallInputDeltaEventType - Go SDK -sidebarTitle: CustomToolCallInputDeltaEventType -description: CustomToolCallInputDeltaEventType type definition -seoTitle: CustomToolCallInputDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcallinputdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallInputDeltaEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDeltaEventType%20-%20Go%20SDK&description=CustomToolCallInputDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallInputDeltaEventTypeResponseCustomToolCallInputDelta -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `CustomToolCallInputDeltaEventTypeResponseCustomToolCallInputDelta` | response.custom_tool_call_input.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallinputdoneevent.mdx b/client-sdks/go/api-reference/models/customtoolcallinputdoneevent.mdx deleted file mode 100644 index 5d3ceda4..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallinputdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomToolCallInputDoneEvent - Go SDK -sidebarTitle: CustomToolCallInputDoneEvent -description: CustomToolCallInputDoneEvent type definition -seoTitle: CustomToolCallInputDoneEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcallinputdoneevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDoneEvent Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallInputDoneEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDoneEvent%20-%20Go%20SDK&description=CustomToolCallInputDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input streaming is complete. Mirrors `response.function_call_arguments.done` but for `custom` tools. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | :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.CustomToolCallInputDoneEventType](/client-sdks/go/api-reference/models/customtoolcallinputdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallinputdoneeventtype.mdx b/client-sdks/go/api-reference/models/customtoolcallinputdoneeventtype.mdx deleted file mode 100644 index c81f1349..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallinputdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CustomToolCallInputDoneEventType - Go SDK -sidebarTitle: CustomToolCallInputDoneEventType -description: CustomToolCallInputDoneEventType type definition -seoTitle: CustomToolCallInputDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcallinputdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDoneEventType Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallInputDoneEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDoneEventType%20-%20Go%20SDK&description=CustomToolCallInputDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallInputDoneEventTypeResponseCustomToolCallInputDone -``` - -## Values - -| Name | Value | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `CustomToolCallInputDoneEventTypeResponseCustomToolCallInputDone` | response.custom_tool_call_input.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallitem.mdx b/client-sdks/go/api-reference/models/customtoolcallitem.mdx deleted file mode 100644 index 7eab27d5..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomToolCallItem - Go SDK -sidebarTitle: CustomToolCallItem -description: CustomToolCallItem type definition -seoTitle: CustomToolCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/customtoolcallitem' -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItem Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItem%20-%20Go%20SDK&description=CustomToolCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Input` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `Type` | [components.CustomToolCallItemType](/client-sdks/go/api-reference/models/customtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcallitemtype.mdx b/client-sdks/go/api-reference/models/customtoolcallitemtype.mdx deleted file mode 100644 index 32582ef0..00000000 --- a/client-sdks/go/api-reference/models/customtoolcallitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CustomToolCallItemType - Go SDK -sidebarTitle: CustomToolCallItemType -description: CustomToolCallItemType type definition -seoTitle: CustomToolCallItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/customtoolcallitemtype' -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItemType Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItemType%20-%20Go%20SDK&description=CustomToolCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallItemTypeCustomToolCall -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `CustomToolCallItemTypeCustomToolCall` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitem.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitem.mdx deleted file mode 100644 index a52d5fd1..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CustomToolCallOutputItem - Go SDK -sidebarTitle: CustomToolCallOutputItem -description: CustomToolCallOutputItem type definition -seoTitle: CustomToolCallOutputItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItem Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItem%20-%20Go%20SDK&description=CustomToolCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The output from a custom (freeform-grammar) tool call execution. Mirrors `function_call_output` but is matched to a `custom_tool_call` rather than a `function_call`. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.CustomToolCallOutputItemOutputUnion2](/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion2) | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](/client-sdks/go/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemdetail.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemdetail.mdx deleted file mode 100644 index fa113a22..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemdetail.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CustomToolCallOutputItemDetail - Go SDK -sidebarTitle: CustomToolCallOutputItemDetail -description: CustomToolCallOutputItemDetail type definition -seoTitle: CustomToolCallOutputItemDetail Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemDetail Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemDetail type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemDetail%20-%20Go%20SDK&description=CustomToolCallOutputItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallOutputItemDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.CustomToolCallOutputItemDetail("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `CustomToolCallOutputItemDetailAuto` | auto | -| `CustomToolCallOutputItemDetailHigh` | high | -| `CustomToolCallOutputItemDetailLow` | low | -| `CustomToolCallOutputItemDetailOriginal` | original | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx deleted file mode 100644 index 2f0d7cb0..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputInputImage - Go SDK -sidebarTitle: CustomToolCallOutputItemOutputInputImage -description: CustomToolCallOutputItemOutputInputImage type definition -seoTitle: CustomToolCallOutputItemOutputInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputInputImage Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemOutputInputImage type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputInputImage%20-%20Go%20SDK&description=CustomToolCallOutputItemOutputInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.CustomToolCallOutputItemDetail](/client-sdks/go/api-reference/models/customtoolcalloutputitemdetail) | :heavy_check_mark: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.CustomToolCallOutputItemOutputType](/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputtype.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputtype.mdx deleted file mode 100644 index fad546e2..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputType - Go SDK -sidebarTitle: CustomToolCallOutputItemOutputType -description: CustomToolCallOutputItemOutputType type definition -seoTitle: CustomToolCallOutputItemOutputType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemoutputtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputType Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemOutputType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputType%20-%20Go%20SDK&description=CustomToolCallOutputItemOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallOutputItemOutputTypeInputImage -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `CustomToolCallOutputItemOutputTypeInputImage` | input_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion1.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion1.mdx deleted file mode 100644 index 96d3b5ea..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion1 - Go SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion1 -description: CustomToolCallOutputItemOutputUnion1 type definition -seoTitle: CustomToolCallOutputItemOutputUnion1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion1 Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion1 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion1%20-%20Go%20SDK&description=CustomToolCallOutputItemOutputUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputText - -```go lines -customToolCallOutputItemOutputUnion1 := components.CreateCustomToolCallOutputItemOutputUnion1InputText(components.InputText{/* values here */}) -``` - -### CustomToolCallOutputItemOutputInputImage - -```go lines -customToolCallOutputItemOutputUnion1 := components.CreateCustomToolCallOutputItemOutputUnion1InputImage(components.CustomToolCallOutputItemOutputInputImage{/* values here */}) -``` - -### InputFile - -```go lines -customToolCallOutputItemOutputUnion1 := components.CreateCustomToolCallOutputItemOutputUnion1InputFile(components.InputFile{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch customToolCallOutputItemOutputUnion1.Type { - case components.CustomToolCallOutputItemOutputUnion1TypeInputText: - // customToolCallOutputItemOutputUnion1.InputText is populated - case components.CustomToolCallOutputItemOutputUnion1TypeInputImage: - // customToolCallOutputItemOutputUnion1.CustomToolCallOutputItemOutputInputImage is populated - case components.CustomToolCallOutputItemOutputUnion1TypeInputFile: - // customToolCallOutputItemOutputUnion1.InputFile is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion2.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion2.mdx deleted file mode 100644 index 4f5e900c..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion2 - Go SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion2 -description: CustomToolCallOutputItemOutputUnion2 type definition -seoTitle: CustomToolCallOutputItemOutputUnion2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion2 Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion2 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion2%20-%20Go%20SDK&description=CustomToolCallOutputItemOutputUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -customToolCallOutputItemOutputUnion2 := components.CreateCustomToolCallOutputItemOutputUnion2Str(string{/* values here */}) -``` - -### - -```go lines -customToolCallOutputItemOutputUnion2 := components.CreateCustomToolCallOutputItemOutputUnion2ArrayOfCustomToolCallOutputItemOutputUnion1([]components.CustomToolCallOutputItemOutputUnion1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch customToolCallOutputItemOutputUnion2.Type { - case components.CustomToolCallOutputItemOutputUnion2TypeStr: - // customToolCallOutputItemOutputUnion2.Str is populated - case components.CustomToolCallOutputItemOutputUnion2TypeArrayOfCustomToolCallOutputItemOutputUnion1: - // customToolCallOutputItemOutputUnion2.ArrayOfCustomToolCallOutputItemOutputUnion1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx b/client-sdks/go/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx deleted file mode 100644 index 97dc3b11..00000000 --- a/client-sdks/go/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CustomToolCallOutputItemTypeCustomToolCallOutput - Go SDK -sidebarTitle: CustomToolCallOutputItemTypeCustomToolCallOutput -description: CustomToolCallOutputItemTypeCustomToolCallOutput type definition -seoTitle: CustomToolCallOutputItemTypeCustomToolCallOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemTypeCustomToolCallOutput Type | OpenRouter Go SDK -'og:description': >- - CustomToolCallOutputItemTypeCustomToolCallOutput type reference for the - OpenRouter Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemTypeCustomToolCallOutput%20-%20Go%20SDK&description=CustomToolCallOutputItemTypeCustomToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolCallOutputItemTypeCustomToolCallOutputCustomToolCallOutput -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `CustomToolCallOutputItemTypeCustomToolCallOutputCustomToolCallOutput` | custom_tool_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/customtooltypecustom.mdx b/client-sdks/go/api-reference/models/customtooltypecustom.mdx deleted file mode 100644 index e8a21d2e..00000000 --- a/client-sdks/go/api-reference/models/customtooltypecustom.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CustomToolTypeCustom - Go SDK -sidebarTitle: CustomToolTypeCustom -description: CustomToolTypeCustom type definition -seoTitle: CustomToolTypeCustom Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/customtooltypecustom' -'og:site_name': OpenRouter Documentation -'og:title': CustomToolTypeCustom Type | OpenRouter Go SDK -'og:description': >- - CustomToolTypeCustom type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolTypeCustom%20-%20Go%20SDK&description=CustomToolTypeCustom%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.CustomToolTypeCustomCustom -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `CustomToolTypeCustomCustom` | custom | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/datacollection.mdx b/client-sdks/go/api-reference/models/datacollection.mdx deleted file mode 100644 index 5cec6008..00000000 --- a/client-sdks/go/api-reference/models/datacollection.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: DataCollection - Go SDK -sidebarTitle: DataCollection -description: DataCollection type definition -seoTitle: DataCollection Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/datacollection' -'og:site_name': OpenRouter Documentation -'og:title': DataCollection Type | OpenRouter Go SDK -'og:description': >- - DataCollection type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DataCollection%20-%20Go%20SDK&description=DataCollection%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.DataCollectionDeny - -// Open enum: custom values can be created with a direct type cast -custom := components.DataCollection("custom_value") -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `DataCollectionDeny` | deny | -| `DataCollectionAllow` | allow | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/datetimeservertool.mdx b/client-sdks/go/api-reference/models/datetimeservertool.mdx deleted file mode 100644 index 924475c7..00000000 --- a/client-sdks/go/api-reference/models/datetimeservertool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DatetimeServerTool - Go SDK -sidebarTitle: DatetimeServerTool -description: DatetimeServerTool type definition -seoTitle: DatetimeServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/datetimeservertool' -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerTool Type | OpenRouter Go SDK -'og:description': >- - DatetimeServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerTool%20-%20Go%20SDK&description=DatetimeServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: returns the current date and time - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.DatetimeServerToolConfig](/client-sdks/go/api-reference/models/datetimeservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | `{"timezone": "America/New_York"}` | -| `Type` | [components.DatetimeServerToolType](/client-sdks/go/api-reference/models/datetimeservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/datetimeservertoolconfig.mdx b/client-sdks/go/api-reference/models/datetimeservertoolconfig.mdx deleted file mode 100644 index 6a8c3ec1..00000000 --- a/client-sdks/go/api-reference/models/datetimeservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DatetimeServerToolConfig - Go SDK -sidebarTitle: DatetimeServerToolConfig -description: DatetimeServerToolConfig type definition -seoTitle: DatetimeServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/datetimeservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - DatetimeServerToolConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolConfig%20-%20Go%20SDK&description=DatetimeServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:datetime server tool - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Timezone` | `*string` | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/datetimeservertooltype.mdx b/client-sdks/go/api-reference/models/datetimeservertooltype.mdx deleted file mode 100644 index 71a5272e..00000000 --- a/client-sdks/go/api-reference/models/datetimeservertooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: DatetimeServerToolType - Go SDK -sidebarTitle: DatetimeServerToolType -description: DatetimeServerToolType type definition -seoTitle: DatetimeServerToolType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/datetimeservertooltype' -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolType Type | OpenRouter Go SDK -'og:description': >- - DatetimeServerToolType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolType%20-%20Go%20SDK&description=DatetimeServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.DatetimeServerToolTypeOpenrouterDatetime -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `DatetimeServerToolTypeOpenrouterDatetime` | openrouter:datetime | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/defaultparameters.mdx b/client-sdks/go/api-reference/models/defaultparameters.mdx deleted file mode 100644 index e050f18c..00000000 --- a/client-sdks/go/api-reference/models/defaultparameters.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: DefaultParameters - Go SDK -sidebarTitle: DefaultParameters -description: DefaultParameters type definition -seoTitle: DefaultParameters Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/defaultparameters' -'og:site_name': OpenRouter Documentation -'og:title': DefaultParameters Type | OpenRouter Go SDK -'og:description': >- - DefaultParameters type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DefaultParameters%20-%20Go%20SDK&description=DefaultParameters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Default parameters for this model - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `RepetitionPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `TopK` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/deletebyokkeyresponse.mdx b/client-sdks/go/api-reference/models/deletebyokkeyresponse.mdx deleted file mode 100644 index c92fb4cf..00000000 --- a/client-sdks/go/api-reference/models/deletebyokkeyresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: DeleteBYOKKeyResponse - Go SDK -sidebarTitle: DeleteBYOKKeyResponse -description: DeleteBYOKKeyResponse type definition -seoTitle: DeleteBYOKKeyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/deletebyokkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyResponse Type | OpenRouter Go SDK -'og:description': >- - DeleteBYOKKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyResponse%20-%20Go%20SDK&description=DeleteBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/deleteguardrailresponse.mdx b/client-sdks/go/api-reference/models/deleteguardrailresponse.mdx deleted file mode 100644 index 35b54a4e..00000000 --- a/client-sdks/go/api-reference/models/deleteguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteGuardrailResponse - Go SDK -sidebarTitle: DeleteGuardrailResponse -description: DeleteGuardrailResponse type definition -seoTitle: DeleteGuardrailResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/deleteguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailResponse Type | OpenRouter Go SDK -'og:description': >- - DeleteGuardrailResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailResponse%20-%20Go%20SDK&description=DeleteGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/deleteobservabilitydestinationresponse.mdx b/client-sdks/go/api-reference/models/deleteobservabilitydestinationresponse.mdx deleted file mode 100644 index fef9f600..00000000 --- a/client-sdks/go/api-reference/models/deleteobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteObservabilityDestinationResponse - Go SDK -sidebarTitle: DeleteObservabilityDestinationResponse -description: DeleteObservabilityDestinationResponse type definition -seoTitle: DeleteObservabilityDestinationResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/deleteobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationResponse Type | OpenRouter Go SDK -'og:description': >- - DeleteObservabilityDestinationResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationResponse%20-%20Go%20SDK&description=DeleteObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/deleteworkspaceresponse.mdx b/client-sdks/go/api-reference/models/deleteworkspaceresponse.mdx deleted file mode 100644 index 72de0771..00000000 --- a/client-sdks/go/api-reference/models/deleteworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteWorkspaceResponse - Go SDK -sidebarTitle: DeleteWorkspaceResponse -description: DeleteWorkspaceResponse type definition -seoTitle: DeleteWorkspaceResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/deleteworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceResponse Type | OpenRouter Go SDK -'og:description': >- - DeleteWorkspaceResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceResponse%20-%20Go%20SDK&description=DeleteWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessage.mdx b/client-sdks/go/api-reference/models/easyinputmessage.mdx deleted file mode 100644 index 6dd033e3..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: EasyInputMessage - Go SDK -sidebarTitle: EasyInputMessage -description: EasyInputMessage type definition -seoTitle: EasyInputMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/easyinputmessage' -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessage Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessage%20-%20Go%20SDK&description=EasyInputMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](/client-sdks/go/api-reference/models/easyinputmessagecontentunion2)] | :heavy_minus_sign: | N/A | | -| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](/client-sdks/go/api-reference/models/easyinputmessagephaseunion)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | -| `Role` | [components.EasyInputMessageRoleUnion](/client-sdks/go/api-reference/models/easyinputmessageroleunion) | :heavy_check_mark: | N/A | | -| `Type` | [*components.EasyInputMessageTypeMessage](/client-sdks/go/api-reference/models/easyinputmessagetypemessage) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagecontentinputimage.mdx b/client-sdks/go/api-reference/models/easyinputmessagecontentinputimage.mdx deleted file mode 100644 index e798ec00..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagecontentinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EasyInputMessageContentInputImage - Go SDK -sidebarTitle: EasyInputMessageContentInputImage -description: EasyInputMessageContentInputImage type definition -seoTitle: EasyInputMessageContentInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagecontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentInputImage Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageContentInputImage type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentInputImage%20-%20Go%20SDK&description=EasyInputMessageContentInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.EasyInputMessageDetail](/client-sdks/go/api-reference/models/easyinputmessagedetail) | :heavy_check_mark: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.EasyInputMessageTypeInputImage](/client-sdks/go/api-reference/models/easyinputmessagetypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagecontentunion1.mdx b/client-sdks/go/api-reference/models/easyinputmessagecontentunion1.mdx deleted file mode 100644 index 6f304855..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagecontentunion1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: EasyInputMessageContentUnion1 - Go SDK -sidebarTitle: EasyInputMessageContentUnion1 -description: EasyInputMessageContentUnion1 type definition -seoTitle: EasyInputMessageContentUnion1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagecontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion1 Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageContentUnion1 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion1%20-%20Go%20SDK&description=EasyInputMessageContentUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputText - -```go lines -easyInputMessageContentUnion1 := components.CreateEasyInputMessageContentUnion1InputText(components.InputText{/* values here */}) -``` - -### EasyInputMessageContentInputImage - -```go lines -easyInputMessageContentUnion1 := components.CreateEasyInputMessageContentUnion1InputImage(components.EasyInputMessageContentInputImage{/* values here */}) -``` - -### InputFile - -```go lines -easyInputMessageContentUnion1 := components.CreateEasyInputMessageContentUnion1InputFile(components.InputFile{/* values here */}) -``` - -### InputAudio - -```go lines -easyInputMessageContentUnion1 := components.CreateEasyInputMessageContentUnion1InputAudio(components.InputAudio{/* values here */}) -``` - -### InputVideo - -```go lines -easyInputMessageContentUnion1 := components.CreateEasyInputMessageContentUnion1InputVideo(components.InputVideo{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch easyInputMessageContentUnion1.Type { - case components.EasyInputMessageContentUnion1TypeInputText: - // easyInputMessageContentUnion1.InputText is populated - case components.EasyInputMessageContentUnion1TypeInputImage: - // easyInputMessageContentUnion1.EasyInputMessageContentInputImage is populated - case components.EasyInputMessageContentUnion1TypeInputFile: - // easyInputMessageContentUnion1.InputFile is populated - case components.EasyInputMessageContentUnion1TypeInputAudio: - // easyInputMessageContentUnion1.InputAudio is populated - case components.EasyInputMessageContentUnion1TypeInputVideo: - // easyInputMessageContentUnion1.InputVideo is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagecontentunion2.mdx b/client-sdks/go/api-reference/models/easyinputmessagecontentunion2.mdx deleted file mode 100644 index 7853bc06..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagecontentunion2.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: EasyInputMessageContentUnion2 - Go SDK -sidebarTitle: EasyInputMessageContentUnion2 -description: EasyInputMessageContentUnion2 type definition -seoTitle: EasyInputMessageContentUnion2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagecontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion2 Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageContentUnion2 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion2%20-%20Go%20SDK&description=EasyInputMessageContentUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -easyInputMessageContentUnion2 := components.CreateEasyInputMessageContentUnion2ArrayOfEasyInputMessageContentUnion1([]components.EasyInputMessageContentUnion1{/* values here */}) -``` - -### - -```go lines -easyInputMessageContentUnion2 := components.CreateEasyInputMessageContentUnion2Str(string{/* values here */}) -``` - -### - -```go lines -easyInputMessageContentUnion2 := components.CreateEasyInputMessageContentUnion2Any(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch easyInputMessageContentUnion2.Type { - case components.EasyInputMessageContentUnion2TypeArrayOfEasyInputMessageContentUnion1: - // easyInputMessageContentUnion2.ArrayOfEasyInputMessageContentUnion1 is populated - case components.EasyInputMessageContentUnion2TypeStr: - // easyInputMessageContentUnion2.Str is populated - case components.EasyInputMessageContentUnion2TypeAny: - // easyInputMessageContentUnion2.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagedetail.mdx b/client-sdks/go/api-reference/models/easyinputmessagedetail.mdx deleted file mode 100644 index 5ca8126c..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagedetail.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: EasyInputMessageDetail - Go SDK -sidebarTitle: EasyInputMessageDetail -description: EasyInputMessageDetail type definition -seoTitle: EasyInputMessageDetail Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/easyinputmessagedetail' -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageDetail Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageDetail type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageDetail%20-%20Go%20SDK&description=EasyInputMessageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.EasyInputMessageDetail("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `EasyInputMessageDetailAuto` | auto | -| `EasyInputMessageDetailHigh` | high | -| `EasyInputMessageDetailLow` | low | -| `EasyInputMessageDetailOriginal` | original | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagephasecommentary.mdx b/client-sdks/go/api-reference/models/easyinputmessagephasecommentary.mdx deleted file mode 100644 index da6a228c..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagephasecommentary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessagePhaseCommentary - Go SDK -sidebarTitle: EasyInputMessagePhaseCommentary -description: EasyInputMessagePhaseCommentary type definition -seoTitle: EasyInputMessagePhaseCommentary Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseCommentary Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessagePhaseCommentary type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseCommentary%20-%20Go%20SDK&description=EasyInputMessagePhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessagePhaseCommentaryCommentary -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `EasyInputMessagePhaseCommentaryCommentary` | commentary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagephasefinalanswer.mdx b/client-sdks/go/api-reference/models/easyinputmessagephasefinalanswer.mdx deleted file mode 100644 index 305f191f..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessagePhaseFinalAnswer - Go SDK -sidebarTitle: EasyInputMessagePhaseFinalAnswer -description: EasyInputMessagePhaseFinalAnswer type definition -seoTitle: EasyInputMessagePhaseFinalAnswer Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseFinalAnswer Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessagePhaseFinalAnswer type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseFinalAnswer%20-%20Go%20SDK&description=EasyInputMessagePhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessagePhaseFinalAnswerFinalAnswer -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `EasyInputMessagePhaseFinalAnswerFinalAnswer` | final_answer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagephaseunion.mdx b/client-sdks/go/api-reference/models/easyinputmessagephaseunion.mdx deleted file mode 100644 index 7fefc1dd..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagephaseunion.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: EasyInputMessagePhaseUnion - Go SDK -sidebarTitle: EasyInputMessagePhaseUnion -description: EasyInputMessagePhaseUnion type definition -seoTitle: EasyInputMessagePhaseUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseUnion Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessagePhaseUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseUnion%20-%20Go%20SDK&description=EasyInputMessagePhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### EasyInputMessagePhaseCommentary - -```go lines -easyInputMessagePhaseUnion := components.CreateEasyInputMessagePhaseUnionEasyInputMessagePhaseCommentary(components.EasyInputMessagePhaseCommentary{/* values here */}) -``` - -### EasyInputMessagePhaseFinalAnswer - -```go lines -easyInputMessagePhaseUnion := components.CreateEasyInputMessagePhaseUnionEasyInputMessagePhaseFinalAnswer(components.EasyInputMessagePhaseFinalAnswer{/* values here */}) -``` - -### - -```go lines -easyInputMessagePhaseUnion := components.CreateEasyInputMessagePhaseUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch easyInputMessagePhaseUnion.Type { - case components.EasyInputMessagePhaseUnionTypeEasyInputMessagePhaseCommentary: - // easyInputMessagePhaseUnion.EasyInputMessagePhaseCommentary is populated - case components.EasyInputMessagePhaseUnionTypeEasyInputMessagePhaseFinalAnswer: - // easyInputMessagePhaseUnion.EasyInputMessagePhaseFinalAnswer is populated - case components.EasyInputMessagePhaseUnionTypeAny: - // easyInputMessagePhaseUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessageroleassistant.mdx b/client-sdks/go/api-reference/models/easyinputmessageroleassistant.mdx deleted file mode 100644 index c3eb98e6..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessageroleassistant.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageRoleAssistant - Go SDK -sidebarTitle: EasyInputMessageRoleAssistant -description: EasyInputMessageRoleAssistant type definition -seoTitle: EasyInputMessageRoleAssistant Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessageroleassistant -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleAssistant Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageRoleAssistant type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleAssistant%20-%20Go%20SDK&description=EasyInputMessageRoleAssistant%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageRoleAssistantAssistant -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `EasyInputMessageRoleAssistantAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessageroledeveloper.mdx b/client-sdks/go/api-reference/models/easyinputmessageroledeveloper.mdx deleted file mode 100644 index 10b4a973..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessageroledeveloper.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageRoleDeveloper - Go SDK -sidebarTitle: EasyInputMessageRoleDeveloper -description: EasyInputMessageRoleDeveloper type definition -seoTitle: EasyInputMessageRoleDeveloper Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessageroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleDeveloper Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageRoleDeveloper type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleDeveloper%20-%20Go%20SDK&description=EasyInputMessageRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageRoleDeveloperDeveloper -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `EasyInputMessageRoleDeveloperDeveloper` | developer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagerolesystem.mdx b/client-sdks/go/api-reference/models/easyinputmessagerolesystem.mdx deleted file mode 100644 index 66868798..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagerolesystem.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageRoleSystem - Go SDK -sidebarTitle: EasyInputMessageRoleSystem -description: EasyInputMessageRoleSystem type definition -seoTitle: EasyInputMessageRoleSystem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagerolesystem -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleSystem Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageRoleSystem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleSystem%20-%20Go%20SDK&description=EasyInputMessageRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageRoleSystemSystem -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `EasyInputMessageRoleSystemSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessageroleunion.mdx b/client-sdks/go/api-reference/models/easyinputmessageroleunion.mdx deleted file mode 100644 index 5b1182e4..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessageroleunion.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: EasyInputMessageRoleUnion - Go SDK -sidebarTitle: EasyInputMessageRoleUnion -description: EasyInputMessageRoleUnion type definition -seoTitle: EasyInputMessageRoleUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessageroleunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUnion Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageRoleUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUnion%20-%20Go%20SDK&description=EasyInputMessageRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### EasyInputMessageRoleUser - -```go lines -easyInputMessageRoleUnion := components.CreateEasyInputMessageRoleUnionEasyInputMessageRoleUser(components.EasyInputMessageRoleUser{/* values here */}) -``` - -### EasyInputMessageRoleSystem - -```go lines -easyInputMessageRoleUnion := components.CreateEasyInputMessageRoleUnionEasyInputMessageRoleSystem(components.EasyInputMessageRoleSystem{/* values here */}) -``` - -### EasyInputMessageRoleAssistant - -```go lines -easyInputMessageRoleUnion := components.CreateEasyInputMessageRoleUnionEasyInputMessageRoleAssistant(components.EasyInputMessageRoleAssistant{/* values here */}) -``` - -### EasyInputMessageRoleDeveloper - -```go lines -easyInputMessageRoleUnion := components.CreateEasyInputMessageRoleUnionEasyInputMessageRoleDeveloper(components.EasyInputMessageRoleDeveloper{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch easyInputMessageRoleUnion.Type { - case components.EasyInputMessageRoleUnionTypeEasyInputMessageRoleUser: - // easyInputMessageRoleUnion.EasyInputMessageRoleUser is populated - case components.EasyInputMessageRoleUnionTypeEasyInputMessageRoleSystem: - // easyInputMessageRoleUnion.EasyInputMessageRoleSystem is populated - case components.EasyInputMessageRoleUnionTypeEasyInputMessageRoleAssistant: - // easyInputMessageRoleUnion.EasyInputMessageRoleAssistant is populated - case components.EasyInputMessageRoleUnionTypeEasyInputMessageRoleDeveloper: - // easyInputMessageRoleUnion.EasyInputMessageRoleDeveloper is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessageroleuser.mdx b/client-sdks/go/api-reference/models/easyinputmessageroleuser.mdx deleted file mode 100644 index 6f9a5be2..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessageroleuser.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageRoleUser - Go SDK -sidebarTitle: EasyInputMessageRoleUser -description: EasyInputMessageRoleUser type definition -seoTitle: EasyInputMessageRoleUser Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessageroleuser -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUser Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageRoleUser type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUser%20-%20Go%20SDK&description=EasyInputMessageRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageRoleUserUser -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `EasyInputMessageRoleUserUser` | user | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagetypeinputimage.mdx b/client-sdks/go/api-reference/models/easyinputmessagetypeinputimage.mdx deleted file mode 100644 index 027fb0b1..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagetypeinputimage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageTypeInputImage - Go SDK -sidebarTitle: EasyInputMessageTypeInputImage -description: EasyInputMessageTypeInputImage type definition -seoTitle: EasyInputMessageTypeInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagetypeinputimage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageTypeInputImage Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageTypeInputImage type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageTypeInputImage%20-%20Go%20SDK&description=EasyInputMessageTypeInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageTypeInputImageInputImage -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `EasyInputMessageTypeInputImageInputImage` | input_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/easyinputmessagetypemessage.mdx b/client-sdks/go/api-reference/models/easyinputmessagetypemessage.mdx deleted file mode 100644 index cb2b1f78..00000000 --- a/client-sdks/go/api-reference/models/easyinputmessagetypemessage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageTypeMessage - Go SDK -sidebarTitle: EasyInputMessageTypeMessage -description: EasyInputMessageTypeMessage type definition -seoTitle: EasyInputMessageTypeMessage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/easyinputmessagetypemessage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageTypeMessage Type | OpenRouter Go SDK -'og:description': >- - EasyInputMessageTypeMessage type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageTypeMessage%20-%20Go%20SDK&description=EasyInputMessageTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EasyInputMessageTypeMessageMessage -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `EasyInputMessageTypeMessageMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerror.mdx b/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerror.mdx deleted file mode 100644 index 77b4438f..00000000 --- a/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseError - Go SDK -sidebarTitle: EdgeNetworkTimeoutResponseError -description: EdgeNetworkTimeoutResponseError type definition -seoTitle: EdgeNetworkTimeoutResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/edgenetworktimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseError Type | OpenRouter Go SDK -'og:description': >- - EdgeNetworkTimeoutResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseError%20-%20Go%20SDK&description=EdgeNetworkTimeoutResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Infrastructure Timeout - Provider request timed out at edge network - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerrordata.mdx b/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerrordata.mdx deleted file mode 100644 index 0c6e950d..00000000 --- a/client-sdks/go/api-reference/models/edgenetworktimeoutresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseErrorData - Go SDK -sidebarTitle: EdgeNetworkTimeoutResponseErrorData -description: EdgeNetworkTimeoutResponseErrorData type definition -seoTitle: EdgeNetworkTimeoutResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/edgenetworktimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - EdgeNetworkTimeoutResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseErrorData%20-%20Go%20SDK&description=EdgeNetworkTimeoutResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for EdgeNetworkTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/edit.mdx b/client-sdks/go/api-reference/models/edit.mdx deleted file mode 100644 index 1374687f..00000000 --- a/client-sdks/go/api-reference/models/edit.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Edit - Go SDK -sidebarTitle: Edit -description: Edit type definition -seoTitle: Edit Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/edit' -'og:site_name': OpenRouter Documentation -'og:title': Edit Type | OpenRouter Go SDK -'og:description': >- - Edit type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Edit%20-%20Go%20SDK&description=Edit%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### EditClearToolUses20250919 - -```go lines -edit := components.CreateEditClearToolUses20250919(components.EditClearToolUses20250919{/* values here */}) -``` - -### EditClearThinking20251015 - -```go lines -edit := components.CreateEditClearThinking20251015(components.EditClearThinking20251015{/* values here */}) -``` - -### EditCompact20260112 - -```go lines -edit := components.CreateEditCompact20260112(components.EditCompact20260112{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch edit.Type { - case components.EditTypeClearToolUses20250919: - // edit.EditClearToolUses20250919 is populated - case components.EditTypeClearThinking20251015: - // edit.EditClearThinking20251015 is populated - case components.EditTypeCompact20260112: - // edit.EditCompact20260112 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/editclearthinking20251015.mdx b/client-sdks/go/api-reference/models/editclearthinking20251015.mdx deleted file mode 100644 index 8c860b0e..00000000 --- a/client-sdks/go/api-reference/models/editclearthinking20251015.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EditClearThinking20251015 - Go SDK -sidebarTitle: EditClearThinking20251015 -description: EditClearThinking20251015 type definition -seoTitle: EditClearThinking20251015 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/editclearthinking20251015 -'og:site_name': OpenRouter Documentation -'og:title': EditClearThinking20251015 Type | OpenRouter Go SDK -'og:description': >- - EditClearThinking20251015 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearThinking20251015%20-%20Go%20SDK&description=EditClearThinking20251015%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Keep` | [*components.Keep](/client-sdks/go/api-reference/models/keep) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeClearThinking20251015](/client-sdks/go/api-reference/models/typeclearthinking20251015) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/editcleartooluses20250919.mdx b/client-sdks/go/api-reference/models/editcleartooluses20250919.mdx deleted file mode 100644 index 44af3c3e..00000000 --- a/client-sdks/go/api-reference/models/editcleartooluses20250919.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: EditClearToolUses20250919 - Go SDK -sidebarTitle: EditClearToolUses20250919 -description: EditClearToolUses20250919 type definition -seoTitle: EditClearToolUses20250919 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/editcleartooluses20250919 -'og:site_name': OpenRouter Documentation -'og:title': EditClearToolUses20250919 Type | OpenRouter Go SDK -'og:description': >- - EditClearToolUses20250919 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearToolUses20250919%20-%20Go%20SDK&description=EditClearToolUses20250919%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](/client-sdks/go/api-reference/models/anthropicinputtokensclearatleast)] | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 50000}` | -| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](/client-sdks/go/api-reference/models/cleartoolinputs)] | :heavy_minus_sign: | N/A | | -| `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `Keep` | [*components.AnthropicToolUsesKeep](/client-sdks/go/api-reference/models/anthropictooluseskeep) | :heavy_minus_sign: | N/A | `{"type": "tool_uses","value": 5}` | -| `Trigger` | [*components.Trigger](/client-sdks/go/api-reference/models/trigger) | :heavy_minus_sign: | N/A | | -| `Type` | [components.TypeClearToolUses20250919](/client-sdks/go/api-reference/models/typecleartooluses20250919) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/editcompact20260112.mdx b/client-sdks/go/api-reference/models/editcompact20260112.mdx deleted file mode 100644 index 0cec20ee..00000000 --- a/client-sdks/go/api-reference/models/editcompact20260112.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: EditCompact20260112 - Go SDK -sidebarTitle: EditCompact20260112 -description: EditCompact20260112 type definition -seoTitle: EditCompact20260112 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/editcompact20260112' -'og:site_name': OpenRouter Documentation -'og:title': EditCompact20260112 Type | OpenRouter Go SDK -'og:description': >- - EditCompact20260112 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditCompact20260112%20-%20Go%20SDK&description=EditCompact20260112%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PauseAfterCompaction` | `*bool` | :heavy_minus_sign: | N/A | | -| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](/client-sdks/go/api-reference/models/triggerinputtokens)] | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 100000}` | -| `Type` | [components.TypeCompact20260112](/client-sdks/go/api-reference/models/typecompact20260112) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/edittypeinputtokens.mdx b/client-sdks/go/api-reference/models/edittypeinputtokens.mdx deleted file mode 100644 index 3044352e..00000000 --- a/client-sdks/go/api-reference/models/edittypeinputtokens.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: EditTypeInputTokens - Go SDK -sidebarTitle: EditTypeInputTokens -description: EditTypeInputTokens type definition -seoTitle: EditTypeInputTokens Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/edittypeinputtokens' -'og:site_name': OpenRouter Documentation -'og:title': EditTypeInputTokens Type | OpenRouter Go SDK -'og:description': >- - EditTypeInputTokens type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditTypeInputTokens%20-%20Go%20SDK&description=EditTypeInputTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EditTypeInputTokensInputTokens -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `EditTypeInputTokensInputTokens` | input_tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/endpointinfo.mdx b/client-sdks/go/api-reference/models/endpointinfo.mdx deleted file mode 100644 index 01b94610..00000000 --- a/client-sdks/go/api-reference/models/endpointinfo.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EndpointInfo - Go SDK -sidebarTitle: EndpointInfo -description: EndpointInfo type definition -seoTitle: EndpointInfo Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/endpointinfo' -'og:site_name': OpenRouter Documentation -'og:title': EndpointInfo Type | OpenRouter Go SDK -'og:description': >- - EndpointInfo type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointInfo%20-%20Go%20SDK&description=EndpointInfo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Provider` | `string` | :heavy_check_mark: | N/A | -| `Selected` | `bool` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/endpointsmetadata.mdx b/client-sdks/go/api-reference/models/endpointsmetadata.mdx deleted file mode 100644 index 43bba3f1..00000000 --- a/client-sdks/go/api-reference/models/endpointsmetadata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EndpointsMetadata - Go SDK -sidebarTitle: EndpointsMetadata -description: EndpointsMetadata type definition -seoTitle: EndpointsMetadata Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/endpointsmetadata' -'og:site_name': OpenRouter Documentation -'og:title': EndpointsMetadata Type | OpenRouter Go SDK -'og:description': >- - EndpointsMetadata type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointsMetadata%20-%20Go%20SDK&description=EndpointsMetadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Available` | [][components.EndpointInfo](/client-sdks/go/api-reference/models/endpointinfo) | :heavy_check_mark: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/endpointstatus.mdx b/client-sdks/go/api-reference/models/endpointstatus.mdx deleted file mode 100644 index c684d1a8..00000000 --- a/client-sdks/go/api-reference/models/endpointstatus.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: EndpointStatus - Go SDK -sidebarTitle: EndpointStatus -description: EndpointStatus type definition -seoTitle: EndpointStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/endpointstatus' -'og:site_name': OpenRouter Documentation -'og:title': EndpointStatus Type | OpenRouter Go SDK -'og:description': >- - EndpointStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointStatus%20-%20Go%20SDK&description=EndpointStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EndpointStatusZero - -// Open enum: custom values can be created with a direct type cast -custom := components.EndpointStatus(999) -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `EndpointStatusZero` | 0 | -| `EndpointStatusMinus1` | -1 | -| `EndpointStatusMinus2` | -2 | -| `EndpointStatusMinus3` | -3 | -| `EndpointStatusMinus5` | -5 | -| `EndpointStatusMinus10` | -10 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/environment.mdx b/client-sdks/go/api-reference/models/environment.mdx deleted file mode 100644 index 8bc09361..00000000 --- a/client-sdks/go/api-reference/models/environment.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Environment - Go SDK -sidebarTitle: Environment -description: Environment type definition -seoTitle: Environment Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/environment' -'og:site_name': OpenRouter Documentation -'og:title': Environment Type | OpenRouter Go SDK -'og:description': >- - Environment type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Environment%20-%20Go%20SDK&description=Environment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.EnvironmentWindows - -// Open enum: custom values can be created with a direct type cast -custom := components.Environment("custom_value") -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `EnvironmentWindows` | windows | -| `EnvironmentMac` | mac | -| `EnvironmentLinux` | linux | -| `EnvironmentUbuntu` | ubuntu | -| `EnvironmentBrowser` | browser | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/error.mdx b/client-sdks/go/api-reference/models/error.mdx deleted file mode 100644 index 55f8bb03..00000000 --- a/client-sdks/go/api-reference/models/error.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Error - Go SDK -sidebarTitle: Error -description: Error type definition -seoTitle: Error Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/error' -'og:site_name': OpenRouter Documentation -'og:title': Error Type | OpenRouter Go SDK -'og:description': >- - Error type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Error%20-%20Go%20SDK&description=Error%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `Code` | `int` | :heavy_check_mark: | Error code | 429 | -| `Message` | `string` | :heavy_check_mark: | Error message | Rate limit exceeded | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/errorcode.mdx b/client-sdks/go/api-reference/models/errorcode.mdx deleted file mode 100644 index fbe7a6c7..00000000 --- a/client-sdks/go/api-reference/models/errorcode.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ErrorCode - Go SDK -sidebarTitle: ErrorCode -description: ErrorCode type definition -seoTitle: ErrorCode Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/errorcode' -'og:site_name': OpenRouter Documentation -'og:title': ErrorCode Type | OpenRouter Go SDK -'og:description': >- - ErrorCode type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorCode%20-%20Go%20SDK&description=ErrorCode%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ErrorCodeInvalidToolInput - -// Open enum: custom values can be created with a direct type cast -custom := components.ErrorCode("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `ErrorCodeInvalidToolInput` | invalid_tool_input | -| `ErrorCodeUnavailable` | unavailable | -| `ErrorCodeMaxUsesExceeded` | max_uses_exceeded | -| `ErrorCodeTooManyRequests` | too_many_requests | -| `ErrorCodeQueryTooLong` | query_too_long | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/errorevent.mdx b/client-sdks/go/api-reference/models/errorevent.mdx deleted file mode 100644 index 32231258..00000000 --- a/client-sdks/go/api-reference/models/errorevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ErrorEvent - Go SDK -sidebarTitle: ErrorEvent -description: ErrorEvent type definition -seoTitle: ErrorEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/errorevent' -'og:site_name': OpenRouter Documentation -'og:title': ErrorEvent Type | OpenRouter Go SDK -'og:description': >- - ErrorEvent type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorEvent%20-%20Go%20SDK&description=ErrorEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when an error occurs during streaming - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Code` | `*string` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Param` | `*string` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ErrorEventType](/client-sdks/go/api-reference/models/erroreventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/erroreventtype.mdx b/client-sdks/go/api-reference/models/erroreventtype.mdx deleted file mode 100644 index 91cfdf89..00000000 --- a/client-sdks/go/api-reference/models/erroreventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ErrorEventType - Go SDK -sidebarTitle: ErrorEventType -description: ErrorEventType type definition -seoTitle: ErrorEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/erroreventtype' -'og:site_name': OpenRouter Documentation -'og:title': ErrorEventType Type | OpenRouter Go SDK -'og:description': >- - ErrorEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorEventType%20-%20Go%20SDK&description=ErrorEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ErrorEventTypeError -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `ErrorEventTypeError` | error | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/failedmodel.mdx b/client-sdks/go/api-reference/models/failedmodel.mdx deleted file mode 100644 index 79fb8c44..00000000 --- a/client-sdks/go/api-reference/models/failedmodel.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FailedModel - Go SDK -sidebarTitle: FailedModel -description: FailedModel type definition -seoTitle: FailedModel Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/failedmodel' -'og:site_name': OpenRouter Documentation -'og:title': FailedModel Type | OpenRouter Go SDK -'og:description': >- - FailedModel type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FailedModel%20-%20Go%20SDK&description=FailedModel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Error` | `string` | :heavy_check_mark: | Error message describing why the model failed. | -| `Model` | `string` | :heavy_check_mark: | Slug of the analysis model that failed. | -| `StatusCode` | `*int64` | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/field.mdx b/client-sdks/go/api-reference/models/field.mdx deleted file mode 100644 index 0b707feb..00000000 --- a/client-sdks/go/api-reference/models/field.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Field - Go SDK -sidebarTitle: Field -description: Field type definition -seoTitle: Field Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/field' -'og:site_name': OpenRouter Documentation -'og:title': Field Type | OpenRouter Go SDK -'og:description': >- - Field type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Field%20-%20Go%20SDK&description=Field%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FieldModel - -// Open enum: custom values can be created with a direct type cast -custom := components.Field("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `FieldModel` | model | -| `FieldProvider` | provider | -| `FieldSessionID` | session_id | -| `FieldUserID` | user_id | -| `FieldAPIKeyName` | api_key_name | -| `FieldFinishReason` | finish_reason | -| `FieldInput` | input | -| `FieldOutput` | output | -| `FieldTotalCost` | total_cost | -| `FieldTotalTokens` | total_tokens | -| `FieldPromptTokens` | prompt_tokens | -| `FieldCompletionTokens` | completion_tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/file.mdx b/client-sdks/go/api-reference/models/file.mdx deleted file mode 100644 index a2f71601..00000000 --- a/client-sdks/go/api-reference/models/file.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: File - Go SDK -sidebarTitle: File -description: File type definition -seoTitle: File Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/file' -'og:site_name': OpenRouter Documentation -'og:title': File Type | OpenRouter Go SDK -'og:description': >- - File type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=File%20-%20Go%20SDK&description=File%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `FileData` | `*string` | :heavy_minus_sign: | File content as base64 data URL or URL | -| `FileID` | `*string` | :heavy_minus_sign: | File ID for previously uploaded files | -| `Filename` | `*string` | :heavy_minus_sign: | Original filename | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filecitation.mdx b/client-sdks/go/api-reference/models/filecitation.mdx deleted file mode 100644 index 35ae0fe4..00000000 --- a/client-sdks/go/api-reference/models/filecitation.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FileCitation - Go SDK -sidebarTitle: FileCitation -description: FileCitation type definition -seoTitle: FileCitation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filecitation' -'og:site_name': OpenRouter Documentation -'og:title': FileCitation Type | OpenRouter Go SDK -'og:description': >- - FileCitation type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitation%20-%20Go%20SDK&description=FileCitation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Filename` | `string` | :heavy_check_mark: | N/A | -| `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FileCitationType](/client-sdks/go/api-reference/models/filecitationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filecitationtype.mdx b/client-sdks/go/api-reference/models/filecitationtype.mdx deleted file mode 100644 index 5a7ff2df..00000000 --- a/client-sdks/go/api-reference/models/filecitationtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FileCitationType - Go SDK -sidebarTitle: FileCitationType -description: FileCitationType type definition -seoTitle: FileCitationType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filecitationtype' -'og:site_name': OpenRouter Documentation -'og:title': FileCitationType Type | OpenRouter Go SDK -'og:description': >- - FileCitationType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitationType%20-%20Go%20SDK&description=FileCitationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FileCitationTypeFileCitation -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `FileCitationTypeFileCitation` | file_citation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fileparserplugin.mdx b/client-sdks/go/api-reference/models/fileparserplugin.mdx deleted file mode 100644 index f6eda594..00000000 --- a/client-sdks/go/api-reference/models/fileparserplugin.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FileParserPlugin - Go SDK -sidebarTitle: FileParserPlugin -description: FileParserPlugin type definition -seoTitle: FileParserPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/fileparserplugin' -'og:site_name': OpenRouter Documentation -'og:title': FileParserPlugin Type | OpenRouter Go SDK -'og:description': >- - FileParserPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileParserPlugin%20-%20Go%20SDK&description=FileParserPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/fileparserpluginid) | :heavy_check_mark: | N/A | | -| `Pdf` | [*components.PDFParserOptions](/client-sdks/go/api-reference/models/pdfparseroptions) | :heavy_minus_sign: | Options for PDF parsing. | `{"engine": "cloudflare-ai"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fileparserpluginid.mdx b/client-sdks/go/api-reference/models/fileparserpluginid.mdx deleted file mode 100644 index 5f53054a..00000000 --- a/client-sdks/go/api-reference/models/fileparserpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FileParserPluginID - Go SDK -sidebarTitle: FileParserPluginID -description: FileParserPluginID type definition -seoTitle: FileParserPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/fileparserpluginid' -'og:site_name': OpenRouter Documentation -'og:title': FileParserPluginID Type | OpenRouter Go SDK -'og:description': >- - FileParserPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileParserPluginID%20-%20Go%20SDK&description=FileParserPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FileParserPluginIDFileParser -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `FileParserPluginIDFileParser` | file-parser | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filepath.mdx b/client-sdks/go/api-reference/models/filepath.mdx deleted file mode 100644 index f385facd..00000000 --- a/client-sdks/go/api-reference/models/filepath.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FilePath - Go SDK -sidebarTitle: FilePath -description: FilePath type definition -seoTitle: FilePath Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filepath' -'og:site_name': OpenRouter Documentation -'og:title': FilePath Type | OpenRouter Go SDK -'og:description': >- - FilePath type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePath%20-%20Go%20SDK&description=FilePath%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FileID` | `string` | :heavy_check_mark: | N/A | -| `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FilePathType](/client-sdks/go/api-reference/models/filepathtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filepathtype.mdx b/client-sdks/go/api-reference/models/filepathtype.mdx deleted file mode 100644 index d0f25db9..00000000 --- a/client-sdks/go/api-reference/models/filepathtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FilePathType - Go SDK -sidebarTitle: FilePathType -description: FilePathType type definition -seoTitle: FilePathType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filepathtype' -'og:site_name': OpenRouter Documentation -'og:title': FilePathType Type | OpenRouter Go SDK -'og:description': >- - FilePathType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePathType%20-%20Go%20SDK&description=FilePathType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FilePathTypeFilePath -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FilePathTypeFilePath` | file_path | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filesearchservertool.mdx b/client-sdks/go/api-reference/models/filesearchservertool.mdx deleted file mode 100644 index 0de13499..00000000 --- a/client-sdks/go/api-reference/models/filesearchservertool.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: FileSearchServerTool - Go SDK -sidebarTitle: FileSearchServerTool -description: FileSearchServerTool type definition -seoTitle: FileSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filesearchservertool' -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - FileSearchServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerTool%20-%20Go%20SDK&description=FileSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -File search tool configuration - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](/client-sdks/go/api-reference/models/filtersunion)] | :heavy_minus_sign: | N/A | -| `MaxNumResults` | `*int64` | :heavy_minus_sign: | N/A | -| `RankingOptions` | [*components.RankingOptions](/client-sdks/go/api-reference/models/rankingoptions) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeFileSearch](/client-sdks/go/api-reference/models/typefilesearch) | :heavy_check_mark: | N/A | -| `VectorStoreIds` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filesearchservertoolvalue1.mdx b/client-sdks/go/api-reference/models/filesearchservertoolvalue1.mdx deleted file mode 100644 index 6d6a82b8..00000000 --- a/client-sdks/go/api-reference/models/filesearchservertoolvalue1.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: FileSearchServerToolValue1 - Go SDK -sidebarTitle: FileSearchServerToolValue1 -description: FileSearchServerToolValue1 type definition -seoTitle: FileSearchServerToolValue1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/filesearchservertoolvalue1 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue1 Type | OpenRouter Go SDK -'og:description': >- - FileSearchServerToolValue1 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue1%20-%20Go%20SDK&description=FileSearchServerToolValue1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -fileSearchServerToolValue1 := components.CreateFileSearchServerToolValue1Str(string{/* values here */}) -``` - -### - -```go lines -fileSearchServerToolValue1 := components.CreateFileSearchServerToolValue1Number(float64{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch fileSearchServerToolValue1.Type { - case components.FileSearchServerToolValue1TypeStr: - // fileSearchServerToolValue1.Str is populated - case components.FileSearchServerToolValue1TypeNumber: - // fileSearchServerToolValue1.Number is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filesearchservertoolvalue2.mdx b/client-sdks/go/api-reference/models/filesearchservertoolvalue2.mdx deleted file mode 100644 index 3a5984c4..00000000 --- a/client-sdks/go/api-reference/models/filesearchservertoolvalue2.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: FileSearchServerToolValue2 - Go SDK -sidebarTitle: FileSearchServerToolValue2 -description: FileSearchServerToolValue2 type definition -seoTitle: FileSearchServerToolValue2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/filesearchservertoolvalue2 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue2 Type | OpenRouter Go SDK -'og:description': >- - FileSearchServerToolValue2 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue2%20-%20Go%20SDK&description=FileSearchServerToolValue2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -fileSearchServerToolValue2 := components.CreateFileSearchServerToolValue2Str(string{/* values here */}) -``` - -### - -```go lines -fileSearchServerToolValue2 := components.CreateFileSearchServerToolValue2Number(float64{/* values here */}) -``` - -### - -```go lines -fileSearchServerToolValue2 := components.CreateFileSearchServerToolValue2Boolean(bool{/* values here */}) -``` - -### - -```go lines -fileSearchServerToolValue2 := components.CreateFileSearchServerToolValue2ArrayOfFileSearchServerToolValue1([]components.FileSearchServerToolValue1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch fileSearchServerToolValue2.Type { - case components.FileSearchServerToolValue2TypeStr: - // fileSearchServerToolValue2.Str is populated - case components.FileSearchServerToolValue2TypeNumber: - // fileSearchServerToolValue2.Number is populated - case components.FileSearchServerToolValue2TypeBoolean: - // fileSearchServerToolValue2.Boolean is populated - case components.FileSearchServerToolValue2TypeArrayOfFileSearchServerToolValue1: - // fileSearchServerToolValue2.ArrayOfFileSearchServerToolValue1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filters.mdx b/client-sdks/go/api-reference/models/filters.mdx deleted file mode 100644 index 562f5ce2..00000000 --- a/client-sdks/go/api-reference/models/filters.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filters - Go SDK -sidebarTitle: Filters -description: Filters type definition -seoTitle: Filters Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filters' -'og:site_name': OpenRouter Documentation -'og:title': Filters Type | OpenRouter Go SDK -'og:description': >- - Filters type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Filters%20-%20Go%20SDK&description=Filters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Key` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.FiltersType](/client-sdks/go/api-reference/models/filterstype) | :heavy_check_mark: | N/A | -| `Value` | [components.FileSearchServerToolValue2](/client-sdks/go/api-reference/models/filesearchservertoolvalue2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filterstype.mdx b/client-sdks/go/api-reference/models/filterstype.mdx deleted file mode 100644 index 3997214b..00000000 --- a/client-sdks/go/api-reference/models/filterstype.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: FiltersType - Go SDK -sidebarTitle: FiltersType -description: FiltersType type definition -seoTitle: FiltersType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filterstype' -'og:site_name': OpenRouter Documentation -'og:title': FiltersType Type | OpenRouter Go SDK -'og:description': >- - FiltersType type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersType%20-%20Go%20SDK&description=FiltersType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FiltersTypeEq - -// Open enum: custom values can be created with a direct type cast -custom := components.FiltersType("custom_value") -``` - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `FiltersTypeEq` | eq | -| `FiltersTypeNe` | ne | -| `FiltersTypeGt` | gt | -| `FiltersTypeGte` | gte | -| `FiltersTypeLt` | lt | -| `FiltersTypeLte` | lte | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/filtersunion.mdx b/client-sdks/go/api-reference/models/filtersunion.mdx deleted file mode 100644 index 2ae25b02..00000000 --- a/client-sdks/go/api-reference/models/filtersunion.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: FiltersUnion - Go SDK -sidebarTitle: FiltersUnion -description: FiltersUnion type definition -seoTitle: FiltersUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/filtersunion' -'og:site_name': OpenRouter Documentation -'og:title': FiltersUnion Type | OpenRouter Go SDK -'og:description': >- - FiltersUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersUnion%20-%20Go%20SDK&description=FiltersUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### Filters - -```go lines -filtersUnion := components.CreateFiltersUnionFilters(components.Filters{/* values here */}) -``` - -### CompoundFilter - -```go lines -filtersUnion := components.CreateFiltersUnionCompoundFilter(components.CompoundFilter{/* values here */}) -``` - -### - -```go lines -filtersUnion := components.CreateFiltersUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch filtersUnion.Type { - case components.FiltersUnionTypeFilters: - // filtersUnion.Filters is populated - case components.FiltersUnionTypeCompoundFilter: - // filtersUnion.CompoundFilter is populated - case components.FiltersUnionTypeAny: - // filtersUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/forbiddenresponseerror.mdx b/client-sdks/go/api-reference/models/forbiddenresponseerror.mdx deleted file mode 100644 index 3df479b3..00000000 --- a/client-sdks/go/api-reference/models/forbiddenresponseerror.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ForbiddenResponseError - Go SDK -sidebarTitle: ForbiddenResponseError -description: ForbiddenResponseError type definition -seoTitle: ForbiddenResponseError Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/forbiddenresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseError Type | OpenRouter Go SDK -'og:description': >- - ForbiddenResponseError type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseError%20-%20Go%20SDK&description=ForbiddenResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Forbidden - Authentication successful but insufficient permissions - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Error` | [components.ForbiddenResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/forbiddenresponseerrordata.mdx b/client-sdks/go/api-reference/models/forbiddenresponseerrordata.mdx deleted file mode 100644 index c138d40c..00000000 --- a/client-sdks/go/api-reference/models/forbiddenresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ForbiddenResponseErrorData - Go SDK -sidebarTitle: ForbiddenResponseErrorData -description: ForbiddenResponseErrorData type definition -seoTitle: ForbiddenResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/forbiddenresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - ForbiddenResponseErrorData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseErrorData%20-%20Go%20SDK&description=ForbiddenResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for ForbiddenResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/format.mdx b/client-sdks/go/api-reference/models/format.mdx deleted file mode 100644 index f8e02662..00000000 --- a/client-sdks/go/api-reference/models/format.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Format - Go SDK -sidebarTitle: Format -description: Format type definition -seoTitle: Format Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/format' -'og:site_name': OpenRouter Documentation -'og:title': Format Type | OpenRouter Go SDK -'og:description': >- - Format type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Format%20-%20Go%20SDK&description=Format%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### FormatText - -```go lines -format := components.CreateFormatText(components.FormatText{/* values here */}) -``` - -### FormatGrammar - -```go lines -format := components.CreateFormatGrammar(components.FormatGrammar{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch format.Type { - case components.FormatTypeTextValue: - // format.FormatText is populated - case components.FormatTypeGrammarValue: - // format.FormatGrammar is populated - default: - // Unknown type - use format.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatenum.mdx b/client-sdks/go/api-reference/models/formatenum.mdx deleted file mode 100644 index 83734329..00000000 --- a/client-sdks/go/api-reference/models/formatenum.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FormatEnum - Go SDK -sidebarTitle: FormatEnum -description: FormatEnum type definition -seoTitle: FormatEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formatenum' -'og:site_name': OpenRouter Documentation -'og:title': FormatEnum Type | OpenRouter Go SDK -'og:description': >- - FormatEnum type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatEnum%20-%20Go%20SDK&description=FormatEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatEnumMp3 - -// Open enum: custom values can be created with a direct type cast -custom := components.FormatEnum("custom_value") -``` - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FormatEnumMp3` | mp3 | -| `FormatEnumWav` | wav | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatgrammar.mdx b/client-sdks/go/api-reference/models/formatgrammar.mdx deleted file mode 100644 index 0d96d052..00000000 --- a/client-sdks/go/api-reference/models/formatgrammar.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FormatGrammar - Go SDK -sidebarTitle: FormatGrammar -description: FormatGrammar type definition -seoTitle: FormatGrammar Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formatgrammar' -'og:site_name': OpenRouter Documentation -'og:title': FormatGrammar Type | OpenRouter Go SDK -'og:description': >- - FormatGrammar type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatGrammar%20-%20Go%20SDK&description=FormatGrammar%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Definition` | `string` | :heavy_check_mark: | N/A | -| `Syntax` | [components.Syntax](/client-sdks/go/api-reference/models/syntax) | :heavy_check_mark: | N/A | -| `Type` | [components.FormatTypeGrammar](/client-sdks/go/api-reference/models/formattypegrammar) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatjsonobjectconfig.mdx b/client-sdks/go/api-reference/models/formatjsonobjectconfig.mdx deleted file mode 100644 index b44a84f0..00000000 --- a/client-sdks/go/api-reference/models/formatjsonobjectconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FormatJSONObjectConfig - Go SDK -sidebarTitle: FormatJSONObjectConfig -description: FormatJSONObjectConfig type definition -seoTitle: FormatJSONObjectConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formatjsonobjectconfig' -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONObjectConfig Type | OpenRouter Go SDK -'og:description': >- - FormatJSONObjectConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONObjectConfig%20-%20Go%20SDK&description=FormatJSONObjectConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -JSON object response format - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.FormatJSONObjectConfigType](/client-sdks/go/api-reference/models/formatjsonobjectconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatjsonobjectconfigtype.mdx b/client-sdks/go/api-reference/models/formatjsonobjectconfigtype.mdx deleted file mode 100644 index 9d8d8d8e..00000000 --- a/client-sdks/go/api-reference/models/formatjsonobjectconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FormatJSONObjectConfigType - Go SDK -sidebarTitle: FormatJSONObjectConfigType -description: FormatJSONObjectConfigType type definition -seoTitle: FormatJSONObjectConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/formatjsonobjectconfigtype -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONObjectConfigType Type | OpenRouter Go SDK -'og:description': >- - FormatJSONObjectConfigType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONObjectConfigType%20-%20Go%20SDK&description=FormatJSONObjectConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatJSONObjectConfigTypeJSONObject -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `FormatJSONObjectConfigTypeJSONObject` | json_object | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatjsonschemaconfig.mdx b/client-sdks/go/api-reference/models/formatjsonschemaconfig.mdx deleted file mode 100644 index 9527580d..00000000 --- a/client-sdks/go/api-reference/models/formatjsonschemaconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: FormatJSONSchemaConfig - Go SDK -sidebarTitle: FormatJSONSchemaConfig -description: FormatJSONSchemaConfig type definition -seoTitle: FormatJSONSchemaConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formatjsonschemaconfig' -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONSchemaConfig Type | OpenRouter Go SDK -'og:description': >- - FormatJSONSchemaConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONSchemaConfig%20-%20Go%20SDK&description=FormatJSONSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -JSON schema constrained response format - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Description` | `*string` | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/formatjsonschemaconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formatjsonschemaconfigtype.mdx b/client-sdks/go/api-reference/models/formatjsonschemaconfigtype.mdx deleted file mode 100644 index 553c4db4..00000000 --- a/client-sdks/go/api-reference/models/formatjsonschemaconfigtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FormatJSONSchemaConfigType - Go SDK -sidebarTitle: FormatJSONSchemaConfigType -description: FormatJSONSchemaConfigType type definition -seoTitle: FormatJSONSchemaConfigType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/formatjsonschemaconfigtype -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONSchemaConfigType Type | OpenRouter Go SDK -'og:description': >- - FormatJSONSchemaConfigType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONSchemaConfigType%20-%20Go%20SDK&description=FormatJSONSchemaConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatJSONSchemaConfigTypeJSONSchema -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `FormatJSONSchemaConfigTypeJSONSchema` | json_schema | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formats.mdx b/client-sdks/go/api-reference/models/formats.mdx deleted file mode 100644 index 9d03e0b5..00000000 --- a/client-sdks/go/api-reference/models/formats.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Formats - Go SDK -sidebarTitle: Formats -description: Formats type definition -seoTitle: Formats Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formats' -'og:site_name': OpenRouter Documentation -'og:title': Formats Type | OpenRouter Go SDK -'og:description': >- - Formats type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Formats%20-%20Go%20SDK&description=Formats%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text response format configuration - -## Supported Types - -### FormatTextConfig - -```go lines -formats := components.CreateFormatsText(components.FormatTextConfig{/* values here */}) -``` - -### FormatJSONObjectConfig - -```go lines -formats := components.CreateFormatsJSONObject(components.FormatJSONObjectConfig{/* values here */}) -``` - -### FormatJSONSchemaConfig - -```go lines -formats := components.CreateFormatsJSONSchema(components.FormatJSONSchemaConfig{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch formats.Type { - case components.FormatsTypeText: - // formats.FormatTextConfig is populated - case components.FormatsTypeJSONObject: - // formats.FormatJSONObjectConfig is populated - case components.FormatsTypeJSONSchema: - // formats.FormatJSONSchemaConfig is populated - default: - // Unknown type - use formats.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formattext.mdx b/client-sdks/go/api-reference/models/formattext.mdx deleted file mode 100644 index d4e969d0..00000000 --- a/client-sdks/go/api-reference/models/formattext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FormatText - Go SDK -sidebarTitle: FormatText -description: FormatText type definition -seoTitle: FormatText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formattext' -'og:site_name': OpenRouter Documentation -'og:title': FormatText Type | OpenRouter Go SDK -'og:description': >- - FormatText type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatText%20-%20Go%20SDK&description=FormatText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.FormatTypeText](/client-sdks/go/api-reference/models/formattypetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formattextconfig.mdx b/client-sdks/go/api-reference/models/formattextconfig.mdx deleted file mode 100644 index 8ff6b04e..00000000 --- a/client-sdks/go/api-reference/models/formattextconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FormatTextConfig - Go SDK -sidebarTitle: FormatTextConfig -description: FormatTextConfig type definition -seoTitle: FormatTextConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formattextconfig' -'og:site_name': OpenRouter Documentation -'og:title': FormatTextConfig Type | OpenRouter Go SDK -'og:description': >- - FormatTextConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTextConfig%20-%20Go%20SDK&description=FormatTextConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Plain text response format - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.FormatTextConfigType](/client-sdks/go/api-reference/models/formattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formattextconfigtype.mdx b/client-sdks/go/api-reference/models/formattextconfigtype.mdx deleted file mode 100644 index 3fd05af4..00000000 --- a/client-sdks/go/api-reference/models/formattextconfigtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormatTextConfigType - Go SDK -sidebarTitle: FormatTextConfigType -description: FormatTextConfigType type definition -seoTitle: FormatTextConfigType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formattextconfigtype' -'og:site_name': OpenRouter Documentation -'og:title': FormatTextConfigType Type | OpenRouter Go SDK -'og:description': >- - FormatTextConfigType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTextConfigType%20-%20Go%20SDK&description=FormatTextConfigType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatTextConfigTypeText -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `FormatTextConfigTypeText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formattypegrammar.mdx b/client-sdks/go/api-reference/models/formattypegrammar.mdx deleted file mode 100644 index d4824942..00000000 --- a/client-sdks/go/api-reference/models/formattypegrammar.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormatTypeGrammar - Go SDK -sidebarTitle: FormatTypeGrammar -description: FormatTypeGrammar type definition -seoTitle: FormatTypeGrammar Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formattypegrammar' -'og:site_name': OpenRouter Documentation -'og:title': FormatTypeGrammar Type | OpenRouter Go SDK -'og:description': >- - FormatTypeGrammar type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTypeGrammar%20-%20Go%20SDK&description=FormatTypeGrammar%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatTypeGrammarGrammar -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `FormatTypeGrammarGrammar` | grammar | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/formattypetext.mdx b/client-sdks/go/api-reference/models/formattypetext.mdx deleted file mode 100644 index 8b33bab3..00000000 --- a/client-sdks/go/api-reference/models/formattypetext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormatTypeText - Go SDK -sidebarTitle: FormatTypeText -description: FormatTypeText type definition -seoTitle: FormatTypeText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/formattypetext' -'og:site_name': OpenRouter Documentation -'og:title': FormatTypeText Type | OpenRouter Go SDK -'og:description': >- - FormatTypeText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTypeText%20-%20Go%20SDK&description=FormatTypeText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FormatTypeTextText -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `FormatTypeTextText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/frameimage.mdx b/client-sdks/go/api-reference/models/frameimage.mdx deleted file mode 100644 index 774f2673..00000000 --- a/client-sdks/go/api-reference/models/frameimage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FrameImage - Go SDK -sidebarTitle: FrameImage -description: FrameImage type definition -seoTitle: FrameImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/frameimage' -'og:site_name': OpenRouter Documentation -'og:title': FrameImage Type | OpenRouter Go SDK -'og:description': >- - FrameImage type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImage%20-%20Go%20SDK&description=FrameImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ImageURL` | [components.FrameImageImageURL](/client-sdks/go/api-reference/models/frameimageimageurl) | :heavy_check_mark: | N/A | | -| `Type` | [components.FrameImageType](/client-sdks/go/api-reference/models/frameimagetype) | :heavy_check_mark: | N/A | | -| `FrameType` | [components.FrameType](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/frameimageimageurl.mdx b/client-sdks/go/api-reference/models/frameimageimageurl.mdx deleted file mode 100644 index 2f609567..00000000 --- a/client-sdks/go/api-reference/models/frameimageimageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FrameImageImageURL - Go SDK -sidebarTitle: FrameImageImageURL -description: FrameImageImageURL type definition -seoTitle: FrameImageImageURL Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/frameimageimageurl' -'og:site_name': OpenRouter Documentation -'og:title': FrameImageImageURL Type | OpenRouter Go SDK -'og:description': >- - FrameImageImageURL type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageImageURL%20-%20Go%20SDK&description=FrameImageImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/frameimagetype.mdx b/client-sdks/go/api-reference/models/frameimagetype.mdx deleted file mode 100644 index 8b68c366..00000000 --- a/client-sdks/go/api-reference/models/frameimagetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FrameImageType - Go SDK -sidebarTitle: FrameImageType -description: FrameImageType type definition -seoTitle: FrameImageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/frameimagetype' -'og:site_name': OpenRouter Documentation -'og:title': FrameImageType Type | OpenRouter Go SDK -'og:description': >- - FrameImageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageType%20-%20Go%20SDK&description=FrameImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FrameImageTypeImageURL -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `FrameImageTypeImageURL` | image_url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/frametype.mdx b/client-sdks/go/api-reference/models/frametype.mdx deleted file mode 100644 index c04608ea..00000000 --- a/client-sdks/go/api-reference/models/frametype.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FrameType - Go SDK -sidebarTitle: FrameType -description: FrameType type definition -seoTitle: FrameType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/frametype' -'og:site_name': OpenRouter Documentation -'og:title': FrameType Type | OpenRouter Go SDK -'og:description': >- - FrameType type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameType%20-%20Go%20SDK&description=FrameType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Whether this image represents the first or last frame of the video - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FrameTypeFirstFrame - -// Open enum: custom values can be created with a direct type cast -custom := components.FrameType("custom_value") -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `FrameTypeFirstFrame` | first_frame | -| `FrameTypeLastFrame` | last_frame | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallargsdeltaevent.mdx b/client-sdks/go/api-reference/models/functioncallargsdeltaevent.mdx deleted file mode 100644 index b8156bf3..00000000 --- a/client-sdks/go/api-reference/models/functioncallargsdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FunctionCallArgsDeltaEvent - Go SDK -sidebarTitle: FunctionCallArgsDeltaEvent -description: FunctionCallArgsDeltaEvent type definition -seoTitle: FunctionCallArgsDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncallargsdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - FunctionCallArgsDeltaEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDeltaEvent%20-%20Go%20SDK&description=FunctionCallArgsDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments are being streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Delta` | `string` | :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.FunctionCallArgsDeltaEventType](/client-sdks/go/api-reference/models/functioncallargsdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallargsdeltaeventtype.mdx b/client-sdks/go/api-reference/models/functioncallargsdeltaeventtype.mdx deleted file mode 100644 index 3be7fa39..00000000 --- a/client-sdks/go/api-reference/models/functioncallargsdeltaeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallArgsDeltaEventType - Go SDK -sidebarTitle: FunctionCallArgsDeltaEventType -description: FunctionCallArgsDeltaEventType type definition -seoTitle: FunctionCallArgsDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncallargsdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - FunctionCallArgsDeltaEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDeltaEventType%20-%20Go%20SDK&description=FunctionCallArgsDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallArgsDeltaEventTypeResponseFunctionCallArgumentsDelta -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `FunctionCallArgsDeltaEventTypeResponseFunctionCallArgumentsDelta` | response.function_call_arguments.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallargsdoneevent.mdx b/client-sdks/go/api-reference/models/functioncallargsdoneevent.mdx deleted file mode 100644 index 3809ec55..00000000 --- a/client-sdks/go/api-reference/models/functioncallargsdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FunctionCallArgsDoneEvent - Go SDK -sidebarTitle: FunctionCallArgsDoneEvent -description: FunctionCallArgsDoneEvent type definition -seoTitle: FunctionCallArgsDoneEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncallargsdoneevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDoneEvent Type | OpenRouter Go SDK -'og:description': >- - FunctionCallArgsDoneEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDoneEvent%20-%20Go%20SDK&description=FunctionCallArgsDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FunctionCallArgsDoneEventType](/client-sdks/go/api-reference/models/functioncallargsdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallargsdoneeventtype.mdx b/client-sdks/go/api-reference/models/functioncallargsdoneeventtype.mdx deleted file mode 100644 index 7a428a18..00000000 --- a/client-sdks/go/api-reference/models/functioncallargsdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallArgsDoneEventType - Go SDK -sidebarTitle: FunctionCallArgsDoneEventType -description: FunctionCallArgsDoneEventType type definition -seoTitle: FunctionCallArgsDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncallargsdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDoneEventType Type | OpenRouter Go SDK -'og:description': >- - FunctionCallArgsDoneEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDoneEventType%20-%20Go%20SDK&description=FunctionCallArgsDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallArgsDoneEventTypeResponseFunctionCallArgumentsDone -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `FunctionCallArgsDoneEventTypeResponseFunctionCallArgumentsDone` | response.function_call_arguments.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallitem.mdx b/client-sdks/go/api-reference/models/functioncallitem.mdx deleted file mode 100644 index 784f0f7f..00000000 --- a/client-sdks/go/api-reference/models/functioncallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FunctionCallItem - Go SDK -sidebarTitle: FunctionCallItem -description: FunctionCallItem type definition -seoTitle: FunctionCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/functioncallitem' -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItem Type | OpenRouter Go SDK -'og:description': >- - FunctionCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItem%20-%20Go%20SDK&description=FunctionCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A function call initiated by the model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `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](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.FunctionCallItemType](/client-sdks/go/api-reference/models/functioncallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncallitemtype.mdx b/client-sdks/go/api-reference/models/functioncallitemtype.mdx deleted file mode 100644 index 4f54bc92..00000000 --- a/client-sdks/go/api-reference/models/functioncallitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FunctionCallItemType - Go SDK -sidebarTitle: FunctionCallItemType -description: FunctionCallItemType type definition -seoTitle: FunctionCallItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/functioncallitemtype' -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItemType Type | OpenRouter Go SDK -'og:description': >- - FunctionCallItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItemType%20-%20Go%20SDK&description=FunctionCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallItemTypeFunctionCall -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `FunctionCallItemTypeFunctionCall` | function_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitem.mdx b/client-sdks/go/api-reference/models/functioncalloutputitem.mdx deleted file mode 100644 index 0ce24e0a..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: FunctionCallOutputItem - Go SDK -sidebarTitle: FunctionCallOutputItem -description: FunctionCallOutputItem type definition -seoTitle: FunctionCallOutputItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/functioncalloutputitem' -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItem Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItem%20-%20Go%20SDK&description=FunctionCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The output from a function call execution - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.FunctionCallOutputItemOutputUnion2](/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion2) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.FunctionCallOutputItemStatus](/client-sdks/go/api-reference/models/functioncalloutputitemstatus)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](/client-sdks/go/api-reference/models/functioncalloutputitemtypefunctioncalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemdetail.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemdetail.mdx deleted file mode 100644 index 5117b87c..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemdetail.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: FunctionCallOutputItemDetail - Go SDK -sidebarTitle: FunctionCallOutputItemDetail -description: FunctionCallOutputItemDetail type definition -seoTitle: FunctionCallOutputItemDetail Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemDetail Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemDetail type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemDetail%20-%20Go%20SDK&description=FunctionCallOutputItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallOutputItemDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.FunctionCallOutputItemDetail("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `FunctionCallOutputItemDetailAuto` | auto | -| `FunctionCallOutputItemDetailHigh` | high | -| `FunctionCallOutputItemDetailLow` | low | -| `FunctionCallOutputItemDetailOriginal` | original | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemoutputinputimage.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemoutputinputimage.mdx deleted file mode 100644 index e133ac24..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: FunctionCallOutputItemOutputInputImage - Go SDK -sidebarTitle: FunctionCallOutputItemOutputInputImage -description: FunctionCallOutputItemOutputInputImage type definition -seoTitle: FunctionCallOutputItemOutputInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputInputImage Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemOutputInputImage type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputInputImage%20-%20Go%20SDK&description=FunctionCallOutputItemOutputInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.FunctionCallOutputItemDetail](/client-sdks/go/api-reference/models/functioncalloutputitemdetail) | :heavy_check_mark: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.FunctionCallOutputItemOutputType](/client-sdks/go/api-reference/models/functioncalloutputitemoutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemoutputtype.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemoutputtype.mdx deleted file mode 100644 index 1d7a569f..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemoutputtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallOutputItemOutputType - Go SDK -sidebarTitle: FunctionCallOutputItemOutputType -description: FunctionCallOutputItemOutputType type definition -seoTitle: FunctionCallOutputItemOutputType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemoutputtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputType Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemOutputType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputType%20-%20Go%20SDK&description=FunctionCallOutputItemOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallOutputItemOutputTypeInputImage -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `FunctionCallOutputItemOutputTypeInputImage` | input_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion1.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion1.mdx deleted file mode 100644 index d6727602..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion1 - Go SDK -sidebarTitle: FunctionCallOutputItemOutputUnion1 -description: FunctionCallOutputItemOutputUnion1 type definition -seoTitle: FunctionCallOutputItemOutputUnion1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion1 Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemOutputUnion1 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion1%20-%20Go%20SDK&description=FunctionCallOutputItemOutputUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputText - -```go lines -functionCallOutputItemOutputUnion1 := components.CreateFunctionCallOutputItemOutputUnion1InputText(components.InputText{/* values here */}) -``` - -### FunctionCallOutputItemOutputInputImage - -```go lines -functionCallOutputItemOutputUnion1 := components.CreateFunctionCallOutputItemOutputUnion1InputImage(components.FunctionCallOutputItemOutputInputImage{/* values here */}) -``` - -### InputFile - -```go lines -functionCallOutputItemOutputUnion1 := components.CreateFunctionCallOutputItemOutputUnion1InputFile(components.InputFile{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch functionCallOutputItemOutputUnion1.Type { - case components.FunctionCallOutputItemOutputUnion1TypeInputText: - // functionCallOutputItemOutputUnion1.InputText is populated - case components.FunctionCallOutputItemOutputUnion1TypeInputImage: - // functionCallOutputItemOutputUnion1.FunctionCallOutputItemOutputInputImage is populated - case components.FunctionCallOutputItemOutputUnion1TypeInputFile: - // functionCallOutputItemOutputUnion1.InputFile is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion2.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion2.mdx deleted file mode 100644 index f868a099..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion2 - Go SDK -sidebarTitle: FunctionCallOutputItemOutputUnion2 -description: FunctionCallOutputItemOutputUnion2 type definition -seoTitle: FunctionCallOutputItemOutputUnion2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion2 Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemOutputUnion2 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion2%20-%20Go%20SDK&description=FunctionCallOutputItemOutputUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -functionCallOutputItemOutputUnion2 := components.CreateFunctionCallOutputItemOutputUnion2Str(string{/* values here */}) -``` - -### - -```go lines -functionCallOutputItemOutputUnion2 := components.CreateFunctionCallOutputItemOutputUnion2ArrayOfFunctionCallOutputItemOutputUnion1([]components.FunctionCallOutputItemOutputUnion1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch functionCallOutputItemOutputUnion2.Type { - case components.FunctionCallOutputItemOutputUnion2TypeStr: - // functionCallOutputItemOutputUnion2.Str is populated - case components.FunctionCallOutputItemOutputUnion2TypeArrayOfFunctionCallOutputItemOutputUnion1: - // functionCallOutputItemOutputUnion2.ArrayOfFunctionCallOutputItemOutputUnion1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemstatus.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemstatus.mdx deleted file mode 100644 index 78b84fdd..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FunctionCallOutputItemStatus - Go SDK -sidebarTitle: FunctionCallOutputItemStatus -description: FunctionCallOutputItemStatus type definition -seoTitle: FunctionCallOutputItemStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemStatus Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemStatus%20-%20Go%20SDK&description=FunctionCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallOutputItemStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.FunctionCallOutputItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `FunctionCallOutputItemStatusInProgress` | in_progress | -| `FunctionCallOutputItemStatusCompleted` | completed | -| `FunctionCallOutputItemStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx b/client-sdks/go/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx deleted file mode 100644 index b23ddf78..00000000 --- a/client-sdks/go/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallOutputItemTypeFunctionCallOutput - Go SDK -sidebarTitle: FunctionCallOutputItemTypeFunctionCallOutput -description: FunctionCallOutputItemTypeFunctionCallOutput type definition -seoTitle: FunctionCallOutputItemTypeFunctionCallOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/functioncalloutputitemtypefunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemTypeFunctionCallOutput Type | OpenRouter Go SDK -'og:description': >- - FunctionCallOutputItemTypeFunctionCallOutput type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemTypeFunctionCallOutput%20-%20Go%20SDK&description=FunctionCallOutputItemTypeFunctionCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FunctionCallOutputItemTypeFunctionCallOutputFunctionCallOutput -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `FunctionCallOutputItemTypeFunctionCallOutputFunctionCallOutput` | function_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionplugin.mdx b/client-sdks/go/api-reference/models/fusionplugin.mdx deleted file mode 100644 index a337f16c..00000000 --- a/client-sdks/go/api-reference/models/fusionplugin.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionPlugin - Go SDK -sidebarTitle: FusionPlugin -description: FusionPlugin type definition -seoTitle: FusionPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/fusionplugin' -'og:site_name': OpenRouter Documentation -'og:title': FusionPlugin Type | OpenRouter Go SDK -'og:description': >- - FusionPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionPlugin%20-%20Go%20SDK&description=FusionPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AnalysisModels` | []`string` | :heavy_minus_sign: | Slugs of models to run in parallel as the "expert panel" the judge 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](/client-sdks/go/api-reference/models/fusionpluginid) | :heavy_check_mark: | N/A | | -| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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 judge 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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionpluginid.mdx b/client-sdks/go/api-reference/models/fusionpluginid.mdx deleted file mode 100644 index f9e05ab7..00000000 --- a/client-sdks/go/api-reference/models/fusionpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FusionPluginID - Go SDK -sidebarTitle: FusionPluginID -description: FusionPluginID type definition -seoTitle: FusionPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/fusionpluginid' -'og:site_name': OpenRouter Documentation -'og:title': FusionPluginID Type | OpenRouter Go SDK -'og:description': >- - FusionPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionPluginID%20-%20Go%20SDK&description=FusionPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FusionPluginIDFusion -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FusionPluginIDFusion` | fusion | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionservertoolconfig.mdx b/client-sdks/go/api-reference/models/fusionservertoolconfig.mdx deleted file mode 100644 index bee8b61b..00000000 --- a/client-sdks/go/api-reference/models/fusionservertoolconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FusionServerToolConfig - Go SDK -sidebarTitle: FusionServerToolConfig -description: FusionServerToolConfig type definition -seoTitle: FusionServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/fusionservertoolconfig' -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - FusionServerToolConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfig%20-%20Go%20SDK&description=FusionServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:fusion server tool. - -## Fields - -| 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 a judge 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"
] | -| `MaxCompletionTokens` | `*int64` | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the judge 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, the provider's default applies. | 16384 | -| `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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 judge model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `Reasoning` | [*components.FusionServerToolConfigReasoning](/client-sdks/go/api-reference/models/fusionservertoolconfigreasoning) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to panelist and judge inner calls. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionservertoolconfigeffort.mdx b/client-sdks/go/api-reference/models/fusionservertoolconfigeffort.mdx deleted file mode 100644 index ec3db665..00000000 --- a/client-sdks/go/api-reference/models/fusionservertoolconfigeffort.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: FusionServerToolConfigEffort - Go SDK -sidebarTitle: FusionServerToolConfigEffort -description: FusionServerToolConfigEffort type definition -seoTitle: FusionServerToolConfigEffort Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/fusionservertoolconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigEffort Type | OpenRouter Go SDK -'og:description': >- - FusionServerToolConfigEffort type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigEffort%20-%20Go%20SDK&description=FusionServerToolConfigEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning effort level for panelist and judge inner calls. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FusionServerToolConfigEffortXhigh - -// Open enum: custom values can be created with a direct type cast -custom := components.FusionServerToolConfigEffort("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `FusionServerToolConfigEffortXhigh` | xhigh | -| `FusionServerToolConfigEffortHigh` | high | -| `FusionServerToolConfigEffortMedium` | medium | -| `FusionServerToolConfigEffortLow` | low | -| `FusionServerToolConfigEffortMinimal` | minimal | -| `FusionServerToolConfigEffortNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionservertoolconfigreasoning.mdx b/client-sdks/go/api-reference/models/fusionservertoolconfigreasoning.mdx deleted file mode 100644 index 255d4e2a..00000000 --- a/client-sdks/go/api-reference/models/fusionservertoolconfigreasoning.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionServerToolConfigReasoning - Go SDK -sidebarTitle: FusionServerToolConfigReasoning -description: FusionServerToolConfigReasoning type definition -seoTitle: FusionServerToolConfigReasoning Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/fusionservertoolconfigreasoning -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigReasoning Type | OpenRouter Go SDK -'og:description': >- - FusionServerToolConfigReasoning type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigReasoning%20-%20Go%20SDK&description=FusionServerToolConfigReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | [*components.FusionServerToolConfigEffort](/client-sdks/go/api-reference/models/fusionservertoolconfigeffort) | :heavy_minus_sign: | Reasoning effort level for panelist and judge inner calls. | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and judge 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/client-sdks/go/api-reference/models/fusionservertoolopenrouter.mdx b/client-sdks/go/api-reference/models/fusionservertoolopenrouter.mdx deleted file mode 100644 index 2869e616..00000000 --- a/client-sdks/go/api-reference/models/fusionservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionServerToolOpenRouter - Go SDK -sidebarTitle: FusionServerToolOpenRouter -description: FusionServerToolOpenRouter type definition -seoTitle: FusionServerToolOpenRouter Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/fusionservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolOpenRouter Type | OpenRouter Go SDK -'og:description': >- - FusionServerToolOpenRouter type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolOpenRouter%20-%20Go%20SDK&description=FusionServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fans out the user prompt to a panel of analysis models, then asks a judge model to summarize their collective output as structured JSON the outer model can synthesize from. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FusionServerToolConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/fusionservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/fusionservertoolopenroutertype.mdx b/client-sdks/go/api-reference/models/fusionservertoolopenroutertype.mdx deleted file mode 100644 index f3876c5f..00000000 --- a/client-sdks/go/api-reference/models/fusionservertoolopenroutertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FusionServerToolOpenRouterType - Go SDK -sidebarTitle: FusionServerToolOpenRouterType -description: FusionServerToolOpenRouterType type definition -seoTitle: FusionServerToolOpenRouterType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/fusionservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolOpenRouterType Type | OpenRouter Go SDK -'og:description': >- - FusionServerToolOpenRouterType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolOpenRouterType%20-%20Go%20SDK&description=FusionServerToolOpenRouterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.FusionServerToolOpenRouterTypeOpenrouterFusion -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `FusionServerToolOpenRouterTypeOpenrouterFusion` | openrouter:fusion | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/generationcontentdata.mdx b/client-sdks/go/api-reference/models/generationcontentdata.mdx deleted file mode 100644 index 5e6dd1fd..00000000 --- a/client-sdks/go/api-reference/models/generationcontentdata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GenerationContentData - Go SDK -sidebarTitle: GenerationContentData -description: GenerationContentData type definition -seoTitle: GenerationContentData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/generationcontentdata' -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentData Type | OpenRouter Go SDK -'og:description': >- - GenerationContentData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentData%20-%20Go%20SDK&description=GenerationContentData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Input` | [components.InputUnion](/client-sdks/go/api-reference/models/inputunion) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | -| `Output` | [components.GenerationContentDataOutput](/client-sdks/go/api-reference/models/generationcontentdataoutput) | :heavy_check_mark: | The output from the generation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/generationcontentdataoutput.mdx b/client-sdks/go/api-reference/models/generationcontentdataoutput.mdx deleted file mode 100644 index b1d89ba3..00000000 --- a/client-sdks/go/api-reference/models/generationcontentdataoutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GenerationContentDataOutput - Go SDK -sidebarTitle: GenerationContentDataOutput -description: GenerationContentDataOutput type definition -seoTitle: GenerationContentDataOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/generationcontentdataoutput -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentDataOutput Type | OpenRouter Go SDK -'og:description': >- - GenerationContentDataOutput type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentDataOutput%20-%20Go%20SDK&description=GenerationContentDataOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The output from the generation - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Completion` | `*string` | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `Reasoning` | `*string` | :heavy_check_mark: | Reasoning/thinking output, if any | `` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/generationcontentresponse.mdx b/client-sdks/go/api-reference/models/generationcontentresponse.mdx deleted file mode 100644 index 51cb095b..00000000 --- a/client-sdks/go/api-reference/models/generationcontentresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GenerationContentResponse - Go SDK -sidebarTitle: GenerationContentResponse -description: GenerationContentResponse type definition -seoTitle: GenerationContentResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/generationcontentresponse -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentResponse Type | OpenRouter Go SDK -'og:description': >- - GenerationContentResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentResponse%20-%20Go%20SDK&description=GenerationContentResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content for a generation - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationContentData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/generationresponse.mdx b/client-sdks/go/api-reference/models/generationresponse.mdx deleted file mode 100644 index cdc31865..00000000 --- a/client-sdks/go/api-reference/models/generationresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GenerationResponse - Go SDK -sidebarTitle: GenerationResponse -description: GenerationResponse type definition -seoTitle: GenerationResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/generationresponse' -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponse Type | OpenRouter Go SDK -'og:description': >- - GenerationResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponse%20-%20Go%20SDK&description=GenerationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Generation response - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationResponseData](/client-sdks/go/api-reference/models/generationresponsedata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/generationresponsedata.mdx b/client-sdks/go/api-reference/models/generationresponsedata.mdx deleted file mode 100644 index 1b20bca4..00000000 --- a/client-sdks/go/api-reference/models/generationresponsedata.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: GenerationResponseData - Go SDK -sidebarTitle: GenerationResponseData -description: GenerationResponseData type definition -seoTitle: GenerationResponseData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/generationresponsedata' -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponseData Type | OpenRouter Go SDK -'og:description': >- - GenerationResponseData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponseData%20-%20Go%20SDK&description=GenerationResponseData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Generation data - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `APIType` | [*components.APIType](/client-sdks/go/api-reference/models/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 | -| `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 | -| `HTTPReferer` | `*string` | :heavy_check_mark: | Referer header from the request | | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `IsByok` | `bool` | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `Latency` | `*float64` | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `Model` | `string` | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `ModerationLatency` | `*float64` | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `NativeFinishReason` | `*string` | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `NativeTokensCached` | `*int64` | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `NativeTokensCompletion` | `*int64` | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `NativeTokensCompletionImages` | `*int64` | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `NativeTokensPrompt` | `*int64` | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `NativeTokensReasoning` | `*int64` | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `NumFetches` | `*int64` | :heavy_check_mark: | Number of web fetches performed | 0 | -| `NumInputAudioPrompt` | `*int64` | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `NumMediaCompletion` | `*int64` | :heavy_check_mark: | Number of media items in the completion | 0 | -| `NumMediaPrompt` | `*int64` | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `NumSearchResults` | `*int64` | :heavy_check_mark: | Number of search results included | 5 | -| `Origin` | `string` | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `PresetID` | `*string` | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `ProviderName` | `*string` | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `ProviderResponses` | [][components.ProviderResponse](/client-sdks/go/api-reference/models/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 | -| `ServiceTier` | `*string` | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `SessionID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `Streamed` | `*bool` | :heavy_check_mark: | Whether the response was streamed | true | -| `TokensCompletion` | `*int64` | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `TokensPrompt` | `*int64` | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `TotalCost` | `float64` | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `UpstreamID` | `*string` | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `UpstreamInferenceCost` | `*float64` | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `Usage` | `float64` | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `UserAgent` | `*string` | :heavy_check_mark: | User-Agent header from the request | | -| `WebSearchEngine` | `*string` | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/getbyokkeyresponse.mdx b/client-sdks/go/api-reference/models/getbyokkeyresponse.mdx deleted file mode 100644 index 11672818..00000000 --- a/client-sdks/go/api-reference/models/getbyokkeyresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetBYOKKeyResponse - Go SDK -sidebarTitle: GetBYOKKeyResponse -description: GetBYOKKeyResponse type definition -seoTitle: GetBYOKKeyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/getbyokkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyResponse Type | OpenRouter Go SDK -'og:description': >- - GetBYOKKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyResponse%20-%20Go%20SDK&description=GetBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/getguardrailresponse.mdx b/client-sdks/go/api-reference/models/getguardrailresponse.mdx deleted file mode 100644 index 04676e62..00000000 --- a/client-sdks/go/api-reference/models/getguardrailresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetGuardrailResponse - Go SDK -sidebarTitle: GetGuardrailResponse -description: GetGuardrailResponse type definition -seoTitle: GetGuardrailResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/getguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResponse Type | OpenRouter Go SDK -'og:description': >- - GetGuardrailResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResponse%20-%20Go%20SDK&description=GetGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](/client-sdks/go/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/go/api-reference/models/getobservabilitydestinationresponse.mdx b/client-sdks/go/api-reference/models/getobservabilitydestinationresponse.mdx deleted file mode 100644 index 2a6792c5..00000000 --- a/client-sdks/go/api-reference/models/getobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetObservabilityDestinationResponse - Go SDK -sidebarTitle: GetObservabilityDestinationResponse -description: GetObservabilityDestinationResponse type definition -seoTitle: GetObservabilityDestinationResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/getobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationResponse Type | OpenRouter Go SDK -'og:description': >- - GetObservabilityDestinationResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationResponse%20-%20Go%20SDK&description=GetObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/getworkspaceresponse.mdx b/client-sdks/go/api-reference/models/getworkspaceresponse.mdx deleted file mode 100644 index 61464d3e..00000000 --- a/client-sdks/go/api-reference/models/getworkspaceresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetWorkspaceResponse - Go SDK -sidebarTitle: GetWorkspaceResponse -description: GetWorkspaceResponse type definition -seoTitle: GetWorkspaceResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/getworkspaceresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceResponse Type | OpenRouter Go SDK -'og:description': >- - GetWorkspaceResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceResponse%20-%20Go%20SDK&description=GetWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](/client-sdks/go/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/go/api-reference/models/group.mdx b/client-sdks/go/api-reference/models/group.mdx deleted file mode 100644 index fd51b85c..00000000 --- a/client-sdks/go/api-reference/models/group.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Group - Go SDK -sidebarTitle: Group -description: Group type definition -seoTitle: Group Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/group' -'og:site_name': OpenRouter Documentation -'og:title': Group Type | OpenRouter Go SDK -'og:description': >- - Group type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Group%20-%20Go%20SDK&description=Group%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Logic` | [*components.Logic](/client-sdks/go/api-reference/models/logic) | :heavy_minus_sign: | N/A | -| `Rules` | [][components.Rule](/client-sdks/go/api-reference/models/rule) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/guardrail.mdx b/client-sdks/go/api-reference/models/guardrail.mdx deleted file mode 100644 index 1e9f65f9..00000000 --- a/client-sdks/go/api-reference/models/guardrail.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Guardrail - Go SDK -sidebarTitle: Guardrail -description: Guardrail type definition -seoTitle: Guardrail Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/guardrail' -'og:site_name': OpenRouter Documentation -'og:title': Guardrail Type | OpenRouter Go SDK -'og:description': >- - Guardrail type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrail%20-%20Go%20SDK&description=Guardrail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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 | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/guardrailinterval.mdx b/client-sdks/go/api-reference/models/guardrailinterval.mdx deleted file mode 100644 index 0aebc2a4..00000000 --- a/client-sdks/go/api-reference/models/guardrailinterval.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: GuardrailInterval - Go SDK -sidebarTitle: GuardrailInterval -description: GuardrailInterval type definition -seoTitle: GuardrailInterval Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/guardrailinterval' -'og:site_name': OpenRouter Documentation -'og:title': GuardrailInterval Type | OpenRouter Go SDK -'og:description': >- - GuardrailInterval type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GuardrailInterval%20-%20Go%20SDK&description=GuardrailInterval%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.GuardrailIntervalDaily - -// Open enum: custom values can be created with a direct type cast -custom := components.GuardrailInterval("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `GuardrailIntervalDaily` | daily | -| `GuardrailIntervalWeekly` | weekly | -| `GuardrailIntervalMonthly` | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/ignore.mdx b/client-sdks/go/api-reference/models/ignore.mdx deleted file mode 100644 index 14386668..00000000 --- a/client-sdks/go/api-reference/models/ignore.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Ignore - Go SDK -sidebarTitle: Ignore -description: Ignore type definition -seoTitle: Ignore Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/ignore' -'og:site_name': OpenRouter Documentation -'og:title': Ignore Type | OpenRouter Go SDK -'og:description': >- - Ignore type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ignore%20-%20Go%20SDK&description=Ignore%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ProviderName - -```go lines -ignore := components.CreateIgnoreProviderName(components.ProviderName{/* values here */}) -``` - -### - -```go lines -ignore := components.CreateIgnoreStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch ignore.Type { - case components.IgnoreTypeProviderName: - // ignore.ProviderName is populated - case components.IgnoreTypeStr: - // ignore.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imageconfig.mdx b/client-sdks/go/api-reference/models/imageconfig.mdx deleted file mode 100644 index 7667c526..00000000 --- a/client-sdks/go/api-reference/models/imageconfig.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ImageConfig - Go SDK -sidebarTitle: ImageConfig -description: ImageConfig type definition -seoTitle: ImageConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/imageconfig' -'og:site_name': OpenRouter Documentation -'og:title': ImageConfig Type | OpenRouter Go SDK -'og:description': >- - ImageConfig type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageConfig%20-%20Go%20SDK&description=ImageConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -imageConfig := components.CreateImageConfigStr(string{/* values here */}) -``` - -### - -```go lines -imageConfig := components.CreateImageConfigNumber(float64{/* values here */}) -``` - -### - -```go lines -imageConfig := components.CreateImageConfigArrayOfAny([]any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch imageConfig.Type { - case components.ImageConfigTypeStr: - // imageConfig.Str is populated - case components.ImageConfigTypeNumber: - // imageConfig.Number is populated - case components.ImageConfigTypeArrayOfAny: - // imageConfig.ArrayOfAny is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallcompletedevent.mdx b/client-sdks/go/api-reference/models/imagegencallcompletedevent.mdx deleted file mode 100644 index 42653b37..00000000 --- a/client-sdks/go/api-reference/models/imagegencallcompletedevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallCompletedEvent - Go SDK -sidebarTitle: ImageGenCallCompletedEvent -description: ImageGenCallCompletedEvent type definition -seoTitle: ImageGenCallCompletedEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallCompletedEvent Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallCompletedEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallCompletedEvent%20-%20Go%20SDK&description=ImageGenCallCompletedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image generation call completed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallCompletedEventType](/client-sdks/go/api-reference/models/imagegencallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallcompletedeventtype.mdx b/client-sdks/go/api-reference/models/imagegencallcompletedeventtype.mdx deleted file mode 100644 index 1563a54d..00000000 --- a/client-sdks/go/api-reference/models/imagegencallcompletedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenCallCompletedEventType - Go SDK -sidebarTitle: ImageGenCallCompletedEventType -description: ImageGenCallCompletedEventType type definition -seoTitle: ImageGenCallCompletedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallcompletedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallCompletedEventType Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallCompletedEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallCompletedEventType%20-%20Go%20SDK&description=ImageGenCallCompletedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenCallCompletedEventTypeResponseImageGenerationCallCompleted -``` - -## Values - -| Name | Value | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `ImageGenCallCompletedEventTypeResponseImageGenerationCallCompleted` | response.image_generation_call.completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallgeneratingevent.mdx b/client-sdks/go/api-reference/models/imagegencallgeneratingevent.mdx deleted file mode 100644 index 4ef9ab56..00000000 --- a/client-sdks/go/api-reference/models/imagegencallgeneratingevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallGeneratingEvent - Go SDK -sidebarTitle: ImageGenCallGeneratingEvent -description: ImageGenCallGeneratingEvent type definition -seoTitle: ImageGenCallGeneratingEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallgeneratingevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallGeneratingEvent Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallGeneratingEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallGeneratingEvent%20-%20Go%20SDK&description=ImageGenCallGeneratingEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image generation call is generating - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallGeneratingEventType](/client-sdks/go/api-reference/models/imagegencallgeneratingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallgeneratingeventtype.mdx b/client-sdks/go/api-reference/models/imagegencallgeneratingeventtype.mdx deleted file mode 100644 index 8357d23d..00000000 --- a/client-sdks/go/api-reference/models/imagegencallgeneratingeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenCallGeneratingEventType - Go SDK -sidebarTitle: ImageGenCallGeneratingEventType -description: ImageGenCallGeneratingEventType type definition -seoTitle: ImageGenCallGeneratingEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallgeneratingeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallGeneratingEventType Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallGeneratingEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallGeneratingEventType%20-%20Go%20SDK&description=ImageGenCallGeneratingEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenCallGeneratingEventTypeResponseImageGenerationCallGenerating -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `ImageGenCallGeneratingEventTypeResponseImageGenerationCallGenerating` | response.image_generation_call.generating | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallinprogressevent.mdx b/client-sdks/go/api-reference/models/imagegencallinprogressevent.mdx deleted file mode 100644 index 049907e0..00000000 --- a/client-sdks/go/api-reference/models/imagegencallinprogressevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallInProgressEvent - Go SDK -sidebarTitle: ImageGenCallInProgressEvent -description: ImageGenCallInProgressEvent type definition -seoTitle: ImageGenCallInProgressEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallInProgressEvent Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallInProgressEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallInProgressEvent%20-%20Go%20SDK&description=ImageGenCallInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image generation call in progress - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallInProgressEventType](/client-sdks/go/api-reference/models/imagegencallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallinprogresseventtype.mdx b/client-sdks/go/api-reference/models/imagegencallinprogresseventtype.mdx deleted file mode 100644 index 053abb09..00000000 --- a/client-sdks/go/api-reference/models/imagegencallinprogresseventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenCallInProgressEventType - Go SDK -sidebarTitle: ImageGenCallInProgressEventType -description: ImageGenCallInProgressEventType type definition -seoTitle: ImageGenCallInProgressEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallInProgressEventType Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallInProgressEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallInProgressEventType%20-%20Go%20SDK&description=ImageGenCallInProgressEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenCallInProgressEventTypeResponseImageGenerationCallInProgress -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `ImageGenCallInProgressEventTypeResponseImageGenerationCallInProgress` | response.image_generation_call.in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallpartialimageevent.mdx b/client-sdks/go/api-reference/models/imagegencallpartialimageevent.mdx deleted file mode 100644 index f2734dfb..00000000 --- a/client-sdks/go/api-reference/models/imagegencallpartialimageevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ImageGenCallPartialImageEvent - Go SDK -sidebarTitle: ImageGenCallPartialImageEvent -description: ImageGenCallPartialImageEvent type definition -seoTitle: ImageGenCallPartialImageEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallpartialimageevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallPartialImageEvent Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallPartialImageEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallPartialImageEvent%20-%20Go%20SDK&description=ImageGenCallPartialImageEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image generation call with partial image - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `PartialImageB64` | `string` | :heavy_check_mark: | N/A | -| `PartialImageIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallPartialImageEventType](/client-sdks/go/api-reference/models/imagegencallpartialimageeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegencallpartialimageeventtype.mdx b/client-sdks/go/api-reference/models/imagegencallpartialimageeventtype.mdx deleted file mode 100644 index 08ed54b9..00000000 --- a/client-sdks/go/api-reference/models/imagegencallpartialimageeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenCallPartialImageEventType - Go SDK -sidebarTitle: ImageGenCallPartialImageEventType -description: ImageGenCallPartialImageEventType type definition -seoTitle: ImageGenCallPartialImageEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegencallpartialimageeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallPartialImageEventType Type | OpenRouter Go SDK -'og:description': >- - ImageGenCallPartialImageEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallPartialImageEventType%20-%20Go%20SDK&description=ImageGenCallPartialImageEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenCallPartialImageEventTypeResponseImageGenerationCallPartialImage -``` - -## Values - -| Name | Value | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `ImageGenCallPartialImageEventTypeResponseImageGenerationCallPartialImage` | response.image_generation_call.partial_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationservertool.mdx b/client-sdks/go/api-reference/models/imagegenerationservertool.mdx deleted file mode 100644 index f99fc46a..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ImageGenerationServerTool - Go SDK -sidebarTitle: ImageGenerationServerTool -description: ImageGenerationServerTool type definition -seoTitle: ImageGenerationServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertool -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerTool Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerTool type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerTool%20-%20Go%20SDK&description=ImageGenerationServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image generation tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `Background` | [*components.Background](/client-sdks/go/api-reference/models/background) | :heavy_minus_sign: | N/A | -| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](/client-sdks/go/api-reference/models/inputfidelity)] | :heavy_minus_sign: | N/A | -| `InputImageMask` | [*components.InputImageMask](/client-sdks/go/api-reference/models/inputimagemask) | :heavy_minus_sign: | N/A | -| `Model` | [*components.ModelEnum](/client-sdks/go/api-reference/models/modelenum) | :heavy_minus_sign: | N/A | -| `Moderation` | [*components.Moderation](/client-sdks/go/api-reference/models/moderation) | :heavy_minus_sign: | N/A | -| `OutputCompression` | `*int64` | :heavy_minus_sign: | N/A | -| `OutputFormat` | [*components.OutputFormat](/client-sdks/go/api-reference/models/outputformat) | :heavy_minus_sign: | N/A | -| `PartialImages` | `*int64` | :heavy_minus_sign: | N/A | -| `Quality` | [*components.Quality](/client-sdks/go/api-reference/models/quality) | :heavy_minus_sign: | N/A | -| `Size` | [*components.Size](/client-sdks/go/api-reference/models/size) | :heavy_minus_sign: | N/A | -| `Type` | [components.ImageGenerationServerToolType](/client-sdks/go/api-reference/models/imagegenerationservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationservertoolconfig.mdx b/client-sdks/go/api-reference/models/imagegenerationservertoolconfig.mdx deleted file mode 100644 index 91018bc6..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertoolconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ImageGenerationServerToolConfig - Go SDK -sidebarTitle: ImageGenerationServerToolConfig -description: ImageGenerationServerToolConfig type definition -seoTitle: ImageGenerationServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerToolConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfig%20-%20Go%20SDK&description=ImageGenerationServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| 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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/imagegenerationservertoolconfigunion.mdx b/client-sdks/go/api-reference/models/imagegenerationservertoolconfigunion.mdx deleted file mode 100644 index bc007a66..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertoolconfigunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: ImageGenerationServerToolConfigUnion - Go SDK -sidebarTitle: ImageGenerationServerToolConfigUnion -description: ImageGenerationServerToolConfigUnion type definition -seoTitle: ImageGenerationServerToolConfigUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertoolconfigunion -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfigUnion Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerToolConfigUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfigUnion%20-%20Go%20SDK&description=ImageGenerationServerToolConfigUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -imageGenerationServerToolConfigUnion := components.CreateImageGenerationServerToolConfigUnionStr(string{/* values here */}) -``` - -### - -```go lines -imageGenerationServerToolConfigUnion := components.CreateImageGenerationServerToolConfigUnionNumber(float64{/* values here */}) -``` - -### - -```go lines -imageGenerationServerToolConfigUnion := components.CreateImageGenerationServerToolConfigUnionArrayOfAny([]any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch imageGenerationServerToolConfigUnion.Type { - case components.ImageGenerationServerToolConfigUnionTypeStr: - // imageGenerationServerToolConfigUnion.Str is populated - case components.ImageGenerationServerToolConfigUnionTypeNumber: - // imageGenerationServerToolConfigUnion.Number is populated - case components.ImageGenerationServerToolConfigUnionTypeArrayOfAny: - // imageGenerationServerToolConfigUnion.ArrayOfAny is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationservertoolopenrouter.mdx b/client-sdks/go/api-reference/models/imagegenerationservertoolopenrouter.mdx deleted file mode 100644 index a841d89e..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouter - Go SDK -sidebarTitle: ImageGenerationServerToolOpenRouter -description: ImageGenerationServerToolOpenRouter type definition -seoTitle: ImageGenerationServerToolOpenRouter Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouter Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerToolOpenRouter type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouter%20-%20Go%20SDK&description=ImageGenerationServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: generates images from text prompts using an image generation model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ImageGenerationServerToolConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/imagegenerationservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationservertoolopenroutertype.mdx b/client-sdks/go/api-reference/models/imagegenerationservertoolopenroutertype.mdx deleted file mode 100644 index bbe3c742..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertoolopenroutertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouterType - Go SDK -sidebarTitle: ImageGenerationServerToolOpenRouterType -description: ImageGenerationServerToolOpenRouterType type definition -seoTitle: ImageGenerationServerToolOpenRouterType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouterType Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerToolOpenRouterType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouterType%20-%20Go%20SDK&description=ImageGenerationServerToolOpenRouterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenerationServerToolOpenRouterTypeOpenrouterImageGeneration -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ImageGenerationServerToolOpenRouterTypeOpenrouterImageGeneration` | openrouter:image_generation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationservertooltype.mdx b/client-sdks/go/api-reference/models/imagegenerationservertooltype.mdx deleted file mode 100644 index c7278a8c..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenerationServerToolType - Go SDK -sidebarTitle: ImageGenerationServerToolType -description: ImageGenerationServerToolType type definition -seoTitle: ImageGenerationServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/imagegenerationservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolType Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolType%20-%20Go%20SDK&description=ImageGenerationServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenerationServerToolTypeImageGeneration -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `ImageGenerationServerToolTypeImageGeneration` | image_generation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/imagegenerationstatus.mdx b/client-sdks/go/api-reference/models/imagegenerationstatus.mdx deleted file mode 100644 index bd3f72e9..00000000 --- a/client-sdks/go/api-reference/models/imagegenerationstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ImageGenerationStatus - Go SDK -sidebarTitle: ImageGenerationStatus -description: ImageGenerationStatus type definition -seoTitle: ImageGenerationStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/imagegenerationstatus' -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationStatus Type | OpenRouter Go SDK -'og:description': >- - ImageGenerationStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationStatus%20-%20Go%20SDK&description=ImageGenerationStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ImageGenerationStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.ImageGenerationStatus("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `ImageGenerationStatusInProgress` | in_progress | -| `ImageGenerationStatusCompleted` | completed | -| `ImageGenerationStatusGenerating` | generating | -| `ImageGenerationStatusFailed` | failed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/incompletedetails.mdx b/client-sdks/go/api-reference/models/incompletedetails.mdx deleted file mode 100644 index 34717642..00000000 --- a/client-sdks/go/api-reference/models/incompletedetails.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: IncompleteDetails - Go SDK -sidebarTitle: IncompleteDetails -description: IncompleteDetails type definition -seoTitle: IncompleteDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/incompletedetails' -'og:site_name': OpenRouter Documentation -'og:title': IncompleteDetails Type | OpenRouter Go SDK -'og:description': >- - IncompleteDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IncompleteDetails%20-%20Go%20SDK&description=IncompleteDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Reason` | [*components.Reason](/client-sdks/go/api-reference/models/reason) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/input1.mdx b/client-sdks/go/api-reference/models/input1.mdx deleted file mode 100644 index 65037df5..00000000 --- a/client-sdks/go/api-reference/models/input1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input1 - Go SDK -sidebarTitle: Input1 -description: Input1 type definition -seoTitle: Input1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/input1' -'og:site_name': OpenRouter Documentation -'og:title': Input1 Type | OpenRouter Go SDK -'og:description': >- - Input1 type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input1%20-%20Go%20SDK&description=Input1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `Prompt` | `string` | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/input2.mdx b/client-sdks/go/api-reference/models/input2.mdx deleted file mode 100644 index 533a7dcc..00000000 --- a/client-sdks/go/api-reference/models/input2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input2 - Go SDK -sidebarTitle: Input2 -description: Input2 type definition -seoTitle: Input2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/input2' -'og:site_name': OpenRouter Documentation -'og:title': Input2 Type | OpenRouter Go SDK -'og:description': >- - Input2 type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input2%20-%20Go%20SDK&description=Input2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `Messages` | []`any` | :heavy_check_mark: | N/A | [
`{"content": "What is the meaning of life?","role": "user"}`
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputaudio.mdx b/client-sdks/go/api-reference/models/inputaudio.mdx deleted file mode 100644 index 89582706..00000000 --- a/client-sdks/go/api-reference/models/inputaudio.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputAudio - Go SDK -sidebarTitle: InputAudio -description: InputAudio type definition -seoTitle: InputAudio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputaudio' -'og:site_name': OpenRouter Documentation -'og:title': InputAudio Type | OpenRouter Go SDK -'og:description': >- - InputAudio type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudio%20-%20Go%20SDK&description=InputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Audio input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputAudio` | [components.InputAudioInputAudio](/client-sdks/go/api-reference/models/inputaudioinputaudio) | :heavy_check_mark: | N/A | -| `Type` | [components.InputAudioType](/client-sdks/go/api-reference/models/inputaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputaudioinputaudio.mdx b/client-sdks/go/api-reference/models/inputaudioinputaudio.mdx deleted file mode 100644 index 5e6b59d5..00000000 --- a/client-sdks/go/api-reference/models/inputaudioinputaudio.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputAudioInputAudio - Go SDK -sidebarTitle: InputAudioInputAudio -description: InputAudioInputAudio type definition -seoTitle: InputAudioInputAudio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputaudioinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': InputAudioInputAudio Type | OpenRouter Go SDK -'og:description': >- - InputAudioInputAudio type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudioInputAudio%20-%20Go%20SDK&description=InputAudioInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Format` | [components.FormatEnum](/client-sdks/go/api-reference/models/formatenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputaudiotype.mdx b/client-sdks/go/api-reference/models/inputaudiotype.mdx deleted file mode 100644 index 55eb1ee9..00000000 --- a/client-sdks/go/api-reference/models/inputaudiotype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputAudioType - Go SDK -sidebarTitle: InputAudioType -description: InputAudioType type definition -seoTitle: InputAudioType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputaudiotype' -'og:site_name': OpenRouter Documentation -'og:title': InputAudioType Type | OpenRouter Go SDK -'og:description': >- - InputAudioType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudioType%20-%20Go%20SDK&description=InputAudioType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputAudioTypeInputAudio -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `InputAudioTypeInputAudio` | input_audio | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputfidelity.mdx b/client-sdks/go/api-reference/models/inputfidelity.mdx deleted file mode 100644 index 1676f588..00000000 --- a/client-sdks/go/api-reference/models/inputfidelity.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputFidelity - Go SDK -sidebarTitle: InputFidelity -description: InputFidelity type definition -seoTitle: InputFidelity Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputfidelity' -'og:site_name': OpenRouter Documentation -'og:title': InputFidelity Type | OpenRouter Go SDK -'og:description': >- - InputFidelity type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFidelity%20-%20Go%20SDK&description=InputFidelity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputFidelityHigh - -// Open enum: custom values can be created with a direct type cast -custom := components.InputFidelity("custom_value") -``` - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `InputFidelityHigh` | high | -| `InputFidelityLow` | low | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputfile.mdx b/client-sdks/go/api-reference/models/inputfile.mdx deleted file mode 100644 index ba451138..00000000 --- a/client-sdks/go/api-reference/models/inputfile.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: InputFile - Go SDK -sidebarTitle: InputFile -description: InputFile type definition -seoTitle: InputFile Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputfile' -'og:site_name': OpenRouter Documentation -'og:title': InputFile Type | OpenRouter Go SDK -'og:description': >- - InputFile type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFile%20-%20Go%20SDK&description=InputFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -File input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `FileData` | `*string` | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/inputfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputfiletype.mdx b/client-sdks/go/api-reference/models/inputfiletype.mdx deleted file mode 100644 index e8fe02bc..00000000 --- a/client-sdks/go/api-reference/models/inputfiletype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputFileType - Go SDK -sidebarTitle: InputFileType -description: InputFileType type definition -seoTitle: InputFileType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputfiletype' -'og:site_name': OpenRouter Documentation -'og:title': InputFileType Type | OpenRouter Go SDK -'og:description': >- - InputFileType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFileType%20-%20Go%20SDK&description=InputFileType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputFileTypeInputFile -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `InputFileTypeInputFile` | input_file | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputimage.mdx b/client-sdks/go/api-reference/models/inputimage.mdx deleted file mode 100644 index 68b74211..00000000 --- a/client-sdks/go/api-reference/models/inputimage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputImage - Go SDK -sidebarTitle: InputImage -description: InputImage type definition -seoTitle: InputImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputimage' -'og:site_name': OpenRouter Documentation -'og:title': InputImage Type | OpenRouter Go SDK -'og:description': >- - InputImage type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImage%20-%20Go%20SDK&description=InputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Detail` | [components.InputImageDetail](/client-sdks/go/api-reference/models/inputimagedetail) | :heavy_check_mark: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputImageType](/client-sdks/go/api-reference/models/inputimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputimagedetail.mdx b/client-sdks/go/api-reference/models/inputimagedetail.mdx deleted file mode 100644 index b70350ac..00000000 --- a/client-sdks/go/api-reference/models/inputimagedetail.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InputImageDetail - Go SDK -sidebarTitle: InputImageDetail -description: InputImageDetail type definition -seoTitle: InputImageDetail Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputimagedetail' -'og:site_name': OpenRouter Documentation -'og:title': InputImageDetail Type | OpenRouter Go SDK -'og:description': >- - InputImageDetail type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageDetail%20-%20Go%20SDK&description=InputImageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputImageDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.InputImageDetail("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `InputImageDetailAuto` | auto | -| `InputImageDetailHigh` | high | -| `InputImageDetailLow` | low | -| `InputImageDetailOriginal` | original | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputimagemask.mdx b/client-sdks/go/api-reference/models/inputimagemask.mdx deleted file mode 100644 index b3d3a19a..00000000 --- a/client-sdks/go/api-reference/models/inputimagemask.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputImageMask - Go SDK -sidebarTitle: InputImageMask -description: InputImageMask type definition -seoTitle: InputImageMask Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputimagemask' -'og:site_name': OpenRouter Documentation -'og:title': InputImageMask Type | OpenRouter Go SDK -'og:description': >- - InputImageMask type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageMask%20-%20Go%20SDK&description=InputImageMask%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `FileID` | `*string` | :heavy_minus_sign: | N/A | -| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputimagetype.mdx b/client-sdks/go/api-reference/models/inputimagetype.mdx deleted file mode 100644 index bd16b42b..00000000 --- a/client-sdks/go/api-reference/models/inputimagetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputImageType - Go SDK -sidebarTitle: InputImageType -description: InputImageType type definition -seoTitle: InputImageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputimagetype' -'og:site_name': OpenRouter Documentation -'og:title': InputImageType Type | OpenRouter Go SDK -'og:description': >- - InputImageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageType%20-%20Go%20SDK&description=InputImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputImageTypeInputImage -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `InputImageTypeInputImage` | input_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitem.mdx b/client-sdks/go/api-reference/models/inputmessageitem.mdx deleted file mode 100644 index b56acaca..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitem.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputMessageItem - Go SDK -sidebarTitle: InputMessageItem -description: InputMessageItem type definition -seoTitle: InputMessageItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputmessageitem' -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItem Type | OpenRouter Go SDK -'og:description': >- - InputMessageItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItem%20-%20Go%20SDK&description=InputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](/client-sdks/go/api-reference/models/inputmessageitemcontentunion)] | :heavy_minus_sign: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Role` | [components.InputMessageItemRoleUnion](/client-sdks/go/api-reference/models/inputmessageitemroleunion) | :heavy_check_mark: | N/A | -| `Type` | [*components.InputMessageItemTypeMessage](/client-sdks/go/api-reference/models/inputmessageitemtypemessage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemcontentinputimage.mdx b/client-sdks/go/api-reference/models/inputmessageitemcontentinputimage.mdx deleted file mode 100644 index b31aa912..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemcontentinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InputMessageItemContentInputImage - Go SDK -sidebarTitle: InputMessageItemContentInputImage -description: InputMessageItemContentInputImage type definition -seoTitle: InputMessageItemContentInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemcontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentInputImage Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemContentInputImage type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentInputImage%20-%20Go%20SDK&description=InputMessageItemContentInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.InputMessageItemDetail](/client-sdks/go/api-reference/models/inputmessageitemdetail) | :heavy_check_mark: | N/A | -| `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputMessageItemTypeInputImage](/client-sdks/go/api-reference/models/inputmessageitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemcontentunion.mdx b/client-sdks/go/api-reference/models/inputmessageitemcontentunion.mdx deleted file mode 100644 index 159a82ed..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemcontentunion.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: InputMessageItemContentUnion - Go SDK -sidebarTitle: InputMessageItemContentUnion -description: InputMessageItemContentUnion type definition -seoTitle: InputMessageItemContentUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemcontentunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentUnion Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemContentUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentUnion%20-%20Go%20SDK&description=InputMessageItemContentUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputText - -```go lines -inputMessageItemContentUnion := components.CreateInputMessageItemContentUnionInputText(components.InputText{/* values here */}) -``` - -### InputMessageItemContentInputImage - -```go lines -inputMessageItemContentUnion := components.CreateInputMessageItemContentUnionInputImage(components.InputMessageItemContentInputImage{/* values here */}) -``` - -### InputFile - -```go lines -inputMessageItemContentUnion := components.CreateInputMessageItemContentUnionInputFile(components.InputFile{/* values here */}) -``` - -### InputAudio - -```go lines -inputMessageItemContentUnion := components.CreateInputMessageItemContentUnionInputAudio(components.InputAudio{/* values here */}) -``` - -### InputVideo - -```go lines -inputMessageItemContentUnion := components.CreateInputMessageItemContentUnionInputVideo(components.InputVideo{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputMessageItemContentUnion.Type { - case components.InputMessageItemContentUnionTypeInputText: - // inputMessageItemContentUnion.InputText is populated - case components.InputMessageItemContentUnionTypeInputImage: - // inputMessageItemContentUnion.InputMessageItemContentInputImage is populated - case components.InputMessageItemContentUnionTypeInputFile: - // inputMessageItemContentUnion.InputFile is populated - case components.InputMessageItemContentUnionTypeInputAudio: - // inputMessageItemContentUnion.InputAudio is populated - case components.InputMessageItemContentUnionTypeInputVideo: - // inputMessageItemContentUnion.InputVideo is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemdetail.mdx b/client-sdks/go/api-reference/models/inputmessageitemdetail.mdx deleted file mode 100644 index 083b3a15..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemdetail.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InputMessageItemDetail - Go SDK -sidebarTitle: InputMessageItemDetail -description: InputMessageItemDetail type definition -seoTitle: InputMessageItemDetail Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputmessageitemdetail' -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemDetail Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemDetail type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemDetail%20-%20Go%20SDK&description=InputMessageItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemDetailAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.InputMessageItemDetail("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `InputMessageItemDetailAuto` | auto | -| `InputMessageItemDetailHigh` | high | -| `InputMessageItemDetailLow` | low | -| `InputMessageItemDetailOriginal` | original | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemroledeveloper.mdx b/client-sdks/go/api-reference/models/inputmessageitemroledeveloper.mdx deleted file mode 100644 index 4161ec3f..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemRoleDeveloper - Go SDK -sidebarTitle: InputMessageItemRoleDeveloper -description: InputMessageItemRoleDeveloper type definition -seoTitle: InputMessageItemRoleDeveloper Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleDeveloper Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemRoleDeveloper type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleDeveloper%20-%20Go%20SDK&description=InputMessageItemRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemRoleDeveloperDeveloper -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `InputMessageItemRoleDeveloperDeveloper` | developer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemrolesystem.mdx b/client-sdks/go/api-reference/models/inputmessageitemrolesystem.mdx deleted file mode 100644 index f9f506b2..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemrolesystem.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemRoleSystem - Go SDK -sidebarTitle: InputMessageItemRoleSystem -description: InputMessageItemRoleSystem type definition -seoTitle: InputMessageItemRoleSystem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleSystem Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemRoleSystem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleSystem%20-%20Go%20SDK&description=InputMessageItemRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemRoleSystemSystem -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `InputMessageItemRoleSystemSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemroleunion.mdx b/client-sdks/go/api-reference/models/inputmessageitemroleunion.mdx deleted file mode 100644 index acce0986..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemroleunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: InputMessageItemRoleUnion - Go SDK -sidebarTitle: InputMessageItemRoleUnion -description: InputMessageItemRoleUnion type definition -seoTitle: InputMessageItemRoleUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUnion Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemRoleUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUnion%20-%20Go%20SDK&description=InputMessageItemRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputMessageItemRoleUser - -```go lines -inputMessageItemRoleUnion := components.CreateInputMessageItemRoleUnionInputMessageItemRoleUser(components.InputMessageItemRoleUser{/* values here */}) -``` - -### InputMessageItemRoleSystem - -```go lines -inputMessageItemRoleUnion := components.CreateInputMessageItemRoleUnionInputMessageItemRoleSystem(components.InputMessageItemRoleSystem{/* values here */}) -``` - -### InputMessageItemRoleDeveloper - -```go lines -inputMessageItemRoleUnion := components.CreateInputMessageItemRoleUnionInputMessageItemRoleDeveloper(components.InputMessageItemRoleDeveloper{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputMessageItemRoleUnion.Type { - case components.InputMessageItemRoleUnionTypeInputMessageItemRoleUser: - // inputMessageItemRoleUnion.InputMessageItemRoleUser is populated - case components.InputMessageItemRoleUnionTypeInputMessageItemRoleSystem: - // inputMessageItemRoleUnion.InputMessageItemRoleSystem is populated - case components.InputMessageItemRoleUnionTypeInputMessageItemRoleDeveloper: - // inputMessageItemRoleUnion.InputMessageItemRoleDeveloper is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemroleuser.mdx b/client-sdks/go/api-reference/models/inputmessageitemroleuser.mdx deleted file mode 100644 index 2b760e08..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemroleuser.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemRoleUser - Go SDK -sidebarTitle: InputMessageItemRoleUser -description: InputMessageItemRoleUser type definition -seoTitle: InputMessageItemRoleUser Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUser Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemRoleUser type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUser%20-%20Go%20SDK&description=InputMessageItemRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemRoleUserUser -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `InputMessageItemRoleUserUser` | user | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemtypeinputimage.mdx b/client-sdks/go/api-reference/models/inputmessageitemtypeinputimage.mdx deleted file mode 100644 index 58f48adc..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemtypeinputimage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemTypeInputImage - Go SDK -sidebarTitle: InputMessageItemTypeInputImage -description: InputMessageItemTypeInputImage type definition -seoTitle: InputMessageItemTypeInputImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemtypeinputimage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemTypeInputImage Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemTypeInputImage type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemTypeInputImage%20-%20Go%20SDK&description=InputMessageItemTypeInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemTypeInputImageInputImage -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `InputMessageItemTypeInputImageInputImage` | input_image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmessageitemtypemessage.mdx b/client-sdks/go/api-reference/models/inputmessageitemtypemessage.mdx deleted file mode 100644 index 671697c1..00000000 --- a/client-sdks/go/api-reference/models/inputmessageitemtypemessage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemTypeMessage - Go SDK -sidebarTitle: InputMessageItemTypeMessage -description: InputMessageItemTypeMessage type definition -seoTitle: InputMessageItemTypeMessage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputmessageitemtypemessage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemTypeMessage Type | OpenRouter Go SDK -'og:description': >- - InputMessageItemTypeMessage type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemTypeMessage%20-%20Go%20SDK&description=InputMessageItemTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputMessageItemTypeMessageMessage -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `InputMessageItemTypeMessageMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputmodality.mdx b/client-sdks/go/api-reference/models/inputmodality.mdx deleted file mode 100644 index 0678ecd7..00000000 --- a/client-sdks/go/api-reference/models/inputmodality.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: InputModality - Go SDK -sidebarTitle: InputModality -description: InputModality type definition -seoTitle: InputModality Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputmodality' -'og:site_name': OpenRouter Documentation -'og:title': InputModality Type | OpenRouter Go SDK -'og:description': >- - InputModality type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputModality%20-%20Go%20SDK&description=InputModality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputModalityText - -// Open enum: custom values can be created with a direct type cast -custom := components.InputModality("custom_value") -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `InputModalityText` | text | -| `InputModalityImage` | image | -| `InputModalityFile` | file | -| `InputModalityAudio` | audio | -| `InputModalityVideo` | video | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputschema.mdx b/client-sdks/go/api-reference/models/inputschema.mdx deleted file mode 100644 index 5dfeb3ff..00000000 --- a/client-sdks/go/api-reference/models/inputschema.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputSchema - Go SDK -sidebarTitle: InputSchema -description: InputSchema type definition -seoTitle: InputSchema Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputschema' -'og:site_name': OpenRouter Documentation -'og:title': InputSchema Type | OpenRouter Go SDK -'og:description': >- - InputSchema type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputSchema%20-%20Go%20SDK&description=InputSchema%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `Properties` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | -| `Required` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | -| `Type` | `*string` | :heavy_minus_sign: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputscontent1.mdx b/client-sdks/go/api-reference/models/inputscontent1.mdx deleted file mode 100644 index 0a121eab..00000000 --- a/client-sdks/go/api-reference/models/inputscontent1.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: InputsContent1 - Go SDK -sidebarTitle: InputsContent1 -description: InputsContent1 type definition -seoTitle: InputsContent1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputscontent1' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent1 Type | OpenRouter Go SDK -'og:description': >- - InputsContent1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent1%20-%20Go%20SDK&description=InputsContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponseOutputText - -```go lines -inputsContent1 := components.CreateInputsContent1OutputText(components.ResponseOutputText{/* values here */}) -``` - -### OpenAIResponsesRefusalContent - -```go lines -inputsContent1 := components.CreateInputsContent1Refusal(components.OpenAIResponsesRefusalContent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsContent1.Type { - case components.InputsContent1TypeOutputText: - // inputsContent1.ResponseOutputText is populated - case components.InputsContent1TypeRefusal: - // inputsContent1.OpenAIResponsesRefusalContent is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputscontent2.mdx b/client-sdks/go/api-reference/models/inputscontent2.mdx deleted file mode 100644 index 9f1a038c..00000000 --- a/client-sdks/go/api-reference/models/inputscontent2.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: InputsContent2 - Go SDK -sidebarTitle: InputsContent2 -description: InputsContent2 type definition -seoTitle: InputsContent2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputscontent2' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent2 Type | OpenRouter Go SDK -'og:description': >- - InputsContent2 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent2%20-%20Go%20SDK&description=InputsContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -inputsContent2 := components.CreateInputsContent2ArrayOfInputsContent1([]components.InputsContent1{/* values here */}) -``` - -### - -```go lines -inputsContent2 := components.CreateInputsContent2Str(string{/* values here */}) -``` - -### - -```go lines -inputsContent2 := components.CreateInputsContent2Any(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsContent2.Type { - case components.InputsContent2TypeArrayOfInputsContent1: - // inputsContent2.ArrayOfInputsContent1 is populated - case components.InputsContent2TypeStr: - // inputsContent2.Str is populated - case components.InputsContent2TypeAny: - // inputsContent2.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsmessage.mdx b/client-sdks/go/api-reference/models/inputsmessage.mdx deleted file mode 100644 index 190daca2..00000000 --- a/client-sdks/go/api-reference/models/inputsmessage.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: InputsMessage - Go SDK -sidebarTitle: InputsMessage -description: InputsMessage type definition -seoTitle: InputsMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsmessage' -'og:site_name': OpenRouter Documentation -'og:title': InputsMessage Type | OpenRouter Go SDK -'og:description': >- - InputsMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsMessage%20-%20Go%20SDK&description=InputsMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An output message item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InputsContent2](/client-sdks/go/api-reference/models/inputscontent2) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](/client-sdks/go/api-reference/models/inputsphaseunion)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.InputsRole](/client-sdks/go/api-reference/models/inputsrole) | :heavy_check_mark: | N/A | -| `Status` | [*components.InputsStatusUnion1](/client-sdks/go/api-reference/models/inputsstatusunion1) | :heavy_minus_sign: | N/A | -| `Type` | [components.InputsTypeMessage](/client-sdks/go/api-reference/models/inputstypemessage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsphasecommentary.mdx b/client-sdks/go/api-reference/models/inputsphasecommentary.mdx deleted file mode 100644 index 7cdaa3b0..00000000 --- a/client-sdks/go/api-reference/models/inputsphasecommentary.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsPhaseCommentary - Go SDK -sidebarTitle: InputsPhaseCommentary -description: InputsPhaseCommentary type definition -seoTitle: InputsPhaseCommentary Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsphasecommentary' -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseCommentary Type | OpenRouter Go SDK -'og:description': >- - InputsPhaseCommentary type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseCommentary%20-%20Go%20SDK&description=InputsPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsPhaseCommentaryCommentary -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `InputsPhaseCommentaryCommentary` | commentary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsphasefinalanswer.mdx b/client-sdks/go/api-reference/models/inputsphasefinalanswer.mdx deleted file mode 100644 index a4389fea..00000000 --- a/client-sdks/go/api-reference/models/inputsphasefinalanswer.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsPhaseFinalAnswer - Go SDK -sidebarTitle: InputsPhaseFinalAnswer -description: InputsPhaseFinalAnswer type definition -seoTitle: InputsPhaseFinalAnswer Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsphasefinalanswer' -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseFinalAnswer Type | OpenRouter Go SDK -'og:description': >- - InputsPhaseFinalAnswer type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseFinalAnswer%20-%20Go%20SDK&description=InputsPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsPhaseFinalAnswerFinalAnswer -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `InputsPhaseFinalAnswerFinalAnswer` | final_answer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsphaseunion.mdx b/client-sdks/go/api-reference/models/inputsphaseunion.mdx deleted file mode 100644 index b0134458..00000000 --- a/client-sdks/go/api-reference/models/inputsphaseunion.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: InputsPhaseUnion - Go SDK -sidebarTitle: InputsPhaseUnion -description: InputsPhaseUnion type definition -seoTitle: InputsPhaseUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsphaseunion' -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseUnion Type | OpenRouter Go SDK -'og:description': >- - InputsPhaseUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseUnion%20-%20Go%20SDK&description=InputsPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### InputsPhaseCommentary - -```go lines -inputsPhaseUnion := components.CreateInputsPhaseUnionInputsPhaseCommentary(components.InputsPhaseCommentary{/* values here */}) -``` - -### InputsPhaseFinalAnswer - -```go lines -inputsPhaseUnion := components.CreateInputsPhaseUnionInputsPhaseFinalAnswer(components.InputsPhaseFinalAnswer{/* values here */}) -``` - -### - -```go lines -inputsPhaseUnion := components.CreateInputsPhaseUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsPhaseUnion.Type { - case components.InputsPhaseUnionTypeInputsPhaseCommentary: - // inputsPhaseUnion.InputsPhaseCommentary is populated - case components.InputsPhaseUnionTypeInputsPhaseFinalAnswer: - // inputsPhaseUnion.InputsPhaseFinalAnswer is populated - case components.InputsPhaseUnionTypeAny: - // inputsPhaseUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsreasoning.mdx b/client-sdks/go/api-reference/models/inputsreasoning.mdx deleted file mode 100644 index 509a8dba..00000000 --- a/client-sdks/go/api-reference/models/inputsreasoning.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsReasoning - Go SDK -sidebarTitle: InputsReasoning -description: InputsReasoning type definition -seoTitle: InputsReasoning Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsreasoning' -'og:site_name': OpenRouter Documentation -'og:title': InputsReasoning Type | OpenRouter Go SDK -'og:description': >- - InputsReasoning type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsReasoning%20-%20Go%20SDK&description=InputsReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/inputsstatusunion2) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](/client-sdks/go/api-reference/models/reasoningsummarytext) | :heavy_check_mark: | N/A | | -| `Type` | [components.InputsTypeReasoning](/client-sdks/go/api-reference/models/inputstypereasoning) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/inputsrole.mdx b/client-sdks/go/api-reference/models/inputsrole.mdx deleted file mode 100644 index 0455609d..00000000 --- a/client-sdks/go/api-reference/models/inputsrole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsRole - Go SDK -sidebarTitle: InputsRole -description: InputsRole type definition -seoTitle: InputsRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsrole' -'og:site_name': OpenRouter Documentation -'og:title': InputsRole Type | OpenRouter Go SDK -'og:description': >- - InputsRole type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsRole%20-%20Go%20SDK&description=InputsRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsRoleAssistant -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `InputsRoleAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatuscompleted1.mdx b/client-sdks/go/api-reference/models/inputsstatuscompleted1.mdx deleted file mode 100644 index f14dcc9e..00000000 --- a/client-sdks/go/api-reference/models/inputsstatuscompleted1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsStatusCompleted1 - Go SDK -sidebarTitle: InputsStatusCompleted1 -description: InputsStatusCompleted1 type definition -seoTitle: InputsStatusCompleted1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsstatuscompleted1' -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted1 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusCompleted1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted1%20-%20Go%20SDK&description=InputsStatusCompleted1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusCompleted1Completed -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `InputsStatusCompleted1Completed` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatuscompleted2.mdx b/client-sdks/go/api-reference/models/inputsstatuscompleted2.mdx deleted file mode 100644 index b8c9e2b7..00000000 --- a/client-sdks/go/api-reference/models/inputsstatuscompleted2.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsStatusCompleted2 - Go SDK -sidebarTitle: InputsStatusCompleted2 -description: InputsStatusCompleted2 type definition -seoTitle: InputsStatusCompleted2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsstatuscompleted2' -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted2 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusCompleted2 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted2%20-%20Go%20SDK&description=InputsStatusCompleted2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusCompleted2Completed -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `InputsStatusCompleted2Completed` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusincomplete1.mdx b/client-sdks/go/api-reference/models/inputsstatusincomplete1.mdx deleted file mode 100644 index 838a953e..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusincomplete1.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputsStatusIncomplete1 - Go SDK -sidebarTitle: InputsStatusIncomplete1 -description: InputsStatusIncomplete1 type definition -seoTitle: InputsStatusIncomplete1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputsstatusincomplete1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete1 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusIncomplete1 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete1%20-%20Go%20SDK&description=InputsStatusIncomplete1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusIncomplete1Incomplete -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `InputsStatusIncomplete1Incomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusincomplete2.mdx b/client-sdks/go/api-reference/models/inputsstatusincomplete2.mdx deleted file mode 100644 index db822bef..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusincomplete2.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputsStatusIncomplete2 - Go SDK -sidebarTitle: InputsStatusIncomplete2 -description: InputsStatusIncomplete2 type definition -seoTitle: InputsStatusIncomplete2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputsstatusincomplete2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete2 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusIncomplete2 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete2%20-%20Go%20SDK&description=InputsStatusIncomplete2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusIncomplete2Incomplete -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `InputsStatusIncomplete2Incomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusinprogress1.mdx b/client-sdks/go/api-reference/models/inputsstatusinprogress1.mdx deleted file mode 100644 index 22fcb32e..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusinprogress1.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputsStatusInProgress1 - Go SDK -sidebarTitle: InputsStatusInProgress1 -description: InputsStatusInProgress1 type definition -seoTitle: InputsStatusInProgress1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputsstatusinprogress1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress1 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusInProgress1 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress1%20-%20Go%20SDK&description=InputsStatusInProgress1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusInProgress1InProgress -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `InputsStatusInProgress1InProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusinprogress2.mdx b/client-sdks/go/api-reference/models/inputsstatusinprogress2.mdx deleted file mode 100644 index 12c19c46..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusinprogress2.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputsStatusInProgress2 - Go SDK -sidebarTitle: InputsStatusInProgress2 -description: InputsStatusInProgress2 type definition -seoTitle: InputsStatusInProgress2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/inputsstatusinprogress2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress2 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusInProgress2 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress2%20-%20Go%20SDK&description=InputsStatusInProgress2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsStatusInProgress2InProgress -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `InputsStatusInProgress2InProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusunion1.mdx b/client-sdks/go/api-reference/models/inputsstatusunion1.mdx deleted file mode 100644 index 93b5c014..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusunion1.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: InputsStatusUnion1 - Go SDK -sidebarTitle: InputsStatusUnion1 -description: InputsStatusUnion1 type definition -seoTitle: InputsStatusUnion1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsstatusunion1' -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion1 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusUnion1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion1%20-%20Go%20SDK&description=InputsStatusUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputsStatusCompleted1 - -```go lines -inputsStatusUnion1 := components.CreateInputsStatusUnion1InputsStatusCompleted1(components.InputsStatusCompleted1{/* values here */}) -``` - -### InputsStatusIncomplete1 - -```go lines -inputsStatusUnion1 := components.CreateInputsStatusUnion1InputsStatusIncomplete1(components.InputsStatusIncomplete1{/* values here */}) -``` - -### InputsStatusInProgress1 - -```go lines -inputsStatusUnion1 := components.CreateInputsStatusUnion1InputsStatusInProgress1(components.InputsStatusInProgress1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsStatusUnion1.Type { - case components.InputsStatusUnion1TypeInputsStatusCompleted1: - // inputsStatusUnion1.InputsStatusCompleted1 is populated - case components.InputsStatusUnion1TypeInputsStatusIncomplete1: - // inputsStatusUnion1.InputsStatusIncomplete1 is populated - case components.InputsStatusUnion1TypeInputsStatusInProgress1: - // inputsStatusUnion1.InputsStatusInProgress1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsstatusunion2.mdx b/client-sdks/go/api-reference/models/inputsstatusunion2.mdx deleted file mode 100644 index 34141717..00000000 --- a/client-sdks/go/api-reference/models/inputsstatusunion2.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: InputsStatusUnion2 - Go SDK -sidebarTitle: InputsStatusUnion2 -description: InputsStatusUnion2 type definition -seoTitle: InputsStatusUnion2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsstatusunion2' -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion2 Type | OpenRouter Go SDK -'og:description': >- - InputsStatusUnion2 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion2%20-%20Go%20SDK&description=InputsStatusUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputsStatusCompleted2 - -```go lines -inputsStatusUnion2 := components.CreateInputsStatusUnion2InputsStatusCompleted2(components.InputsStatusCompleted2{/* values here */}) -``` - -### InputsStatusIncomplete2 - -```go lines -inputsStatusUnion2 := components.CreateInputsStatusUnion2InputsStatusIncomplete2(components.InputsStatusIncomplete2{/* values here */}) -``` - -### InputsStatusInProgress2 - -```go lines -inputsStatusUnion2 := components.CreateInputsStatusUnion2InputsStatusInProgress2(components.InputsStatusInProgress2{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsStatusUnion2.Type { - case components.InputsStatusUnion2TypeInputsStatusCompleted2: - // inputsStatusUnion2.InputsStatusCompleted2 is populated - case components.InputsStatusUnion2TypeInputsStatusIncomplete2: - // inputsStatusUnion2.InputsStatusIncomplete2 is populated - case components.InputsStatusUnion2TypeInputsStatusInProgress2: - // inputsStatusUnion2.InputsStatusInProgress2 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputstypemessage.mdx b/client-sdks/go/api-reference/models/inputstypemessage.mdx deleted file mode 100644 index 39012e12..00000000 --- a/client-sdks/go/api-reference/models/inputstypemessage.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsTypeMessage - Go SDK -sidebarTitle: InputsTypeMessage -description: InputsTypeMessage type definition -seoTitle: InputsTypeMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputstypemessage' -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeMessage Type | OpenRouter Go SDK -'og:description': >- - InputsTypeMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeMessage%20-%20Go%20SDK&description=InputsTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsTypeMessageMessage -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `InputsTypeMessageMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputstypereasoning.mdx b/client-sdks/go/api-reference/models/inputstypereasoning.mdx deleted file mode 100644 index 8dd44e86..00000000 --- a/client-sdks/go/api-reference/models/inputstypereasoning.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsTypeReasoning - Go SDK -sidebarTitle: InputsTypeReasoning -description: InputsTypeReasoning type definition -seoTitle: InputsTypeReasoning Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputstypereasoning' -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeReasoning Type | OpenRouter Go SDK -'og:description': >- - InputsTypeReasoning type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeReasoning%20-%20Go%20SDK&description=InputsTypeReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputsTypeReasoningReasoning -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `InputsTypeReasoningReasoning` | reasoning | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsunion.mdx b/client-sdks/go/api-reference/models/inputsunion.mdx deleted file mode 100644 index 027da85c..00000000 --- a/client-sdks/go/api-reference/models/inputsunion.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: InputsUnion - Go SDK -sidebarTitle: InputsUnion -description: InputsUnion type definition -seoTitle: InputsUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsunion' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion Type | OpenRouter Go SDK -'og:description': >- - InputsUnion type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion%20-%20Go%20SDK&description=InputsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Input for a response request - can be a string or array of items - -## Supported Types - -### - -```go lines -inputsUnion := components.CreateInputsUnionStr(string{/* values here */}) -``` - -### - -```go lines -inputsUnion := components.CreateInputsUnionArrayOfInputsUnion1([]components.InputsUnion1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputsUnion.Type { - case components.InputsUnionTypeStr: - // inputsUnion.Str is populated - case components.InputsUnionTypeArrayOfInputsUnion1: - // inputsUnion.ArrayOfInputsUnion1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputsunion1.mdx b/client-sdks/go/api-reference/models/inputsunion1.mdx deleted file mode 100644 index b5d4a2fa..00000000 --- a/client-sdks/go/api-reference/models/inputsunion1.mdx +++ /dev/null @@ -1,374 +0,0 @@ ---- -title: InputsUnion1 - Go SDK -sidebarTitle: InputsUnion1 -description: InputsUnion1 type definition -seoTitle: InputsUnion1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputsunion1' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion1 Type | OpenRouter Go SDK -'og:description': >- - InputsUnion1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion1%20-%20Go%20SDK&description=InputsUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ReasoningItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ReasoningItem(components.ReasoningItem{/* values here */}) -``` - -### EasyInputMessage - -```go lines -inputsUnion1 := components.CreateInputsUnion1EasyInputMessage(components.EasyInputMessage{/* values here */}) -``` - -### InputMessageItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1InputMessageItem(components.InputMessageItem{/* values here */}) -``` - -### FunctionCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1FunctionCallItem(components.FunctionCallItem{/* values here */}) -``` - -### FunctionCallOutputItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1FunctionCallOutputItem(components.FunctionCallOutputItem{/* values here */}) -``` - -### ApplyPatchCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ApplyPatchCallItem(components.ApplyPatchCallItem{/* values here */}) -``` - -### ApplyPatchCallOutputItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ApplyPatchCallOutputItem(components.ApplyPatchCallOutputItem{/* values here */}) -``` - -### InputsMessage - -```go lines -inputsUnion1 := components.CreateInputsUnion1InputsMessage(components.InputsMessage{/* values here */}) -``` - -### InputsReasoning - -```go lines -inputsUnion1 := components.CreateInputsUnion1InputsReasoning(components.InputsReasoning{/* values here */}) -``` - -### OutputFunctionCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputFunctionCallItem(components.OutputFunctionCallItem{/* values here */}) -``` - -### OutputCustomToolCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputCustomToolCallItem(components.OutputCustomToolCallItem{/* values here */}) -``` - -### OutputWebSearchCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputWebSearchCallItem(components.OutputWebSearchCallItem{/* values here */}) -``` - -### OutputFileSearchCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputFileSearchCallItem(components.OutputFileSearchCallItem{/* values here */}) -``` - -### OutputImageGenerationCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputImageGenerationCallItem(components.OutputImageGenerationCallItem{/* values here */}) -``` - -### OutputCodeInterpreterCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputCodeInterpreterCallItem(components.OutputCodeInterpreterCallItem{/* values here */}) -``` - -### OutputComputerCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputComputerCallItem(components.OutputComputerCallItem{/* values here */}) -``` - -### OutputDatetimeItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputDatetimeItem(components.OutputDatetimeItem{/* values here */}) -``` - -### OutputWebSearchServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputWebSearchServerToolItem(components.OutputWebSearchServerToolItem{/* values here */}) -``` - -### OutputCodeInterpreterServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputCodeInterpreterServerToolItem(components.OutputCodeInterpreterServerToolItem{/* values here */}) -``` - -### OutputFileSearchServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputFileSearchServerToolItem(components.OutputFileSearchServerToolItem{/* values here */}) -``` - -### OutputImageGenerationServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputImageGenerationServerToolItem(components.OutputImageGenerationServerToolItem{/* values here */}) -``` - -### OutputBrowserUseServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputBrowserUseServerToolItem(components.OutputBrowserUseServerToolItem{/* values here */}) -``` - -### OutputBashServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputBashServerToolItem(components.OutputBashServerToolItem{/* values here */}) -``` - -### OutputTextEditorServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputTextEditorServerToolItem(components.OutputTextEditorServerToolItem{/* values here */}) -``` - -### OutputApplyPatchServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputApplyPatchServerToolItem(components.OutputApplyPatchServerToolItem{/* values here */}) -``` - -### OutputWebFetchServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputWebFetchServerToolItem(components.OutputWebFetchServerToolItem{/* values here */}) -``` - -### OutputToolSearchServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputToolSearchServerToolItem(components.OutputToolSearchServerToolItem{/* values here */}) -``` - -### OutputMemoryServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputMemoryServerToolItem(components.OutputMemoryServerToolItem{/* values here */}) -``` - -### OutputMcpServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputMcpServerToolItem(components.OutputMcpServerToolItem{/* values here */}) -``` - -### OutputSearchModelsServerToolItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1OutputSearchModelsServerToolItem(components.OutputSearchModelsServerToolItem{/* values here */}) -``` - -### LocalShellCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1LocalShellCallItem(components.LocalShellCallItem{/* values here */}) -``` - -### LocalShellCallOutputItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1LocalShellCallOutputItem(components.LocalShellCallOutputItem{/* values here */}) -``` - -### ShellCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ShellCallItem(components.ShellCallItem{/* values here */}) -``` - -### ShellCallOutputItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ShellCallOutputItem(components.ShellCallOutputItem{/* values here */}) -``` - -### McpListToolsItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1McpListToolsItem(components.McpListToolsItem{/* values here */}) -``` - -### McpApprovalRequestItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1McpApprovalRequestItem(components.McpApprovalRequestItem{/* values here */}) -``` - -### McpApprovalResponseItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1McpApprovalResponseItem(components.McpApprovalResponseItem{/* values here */}) -``` - -### McpCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1McpCallItem(components.McpCallItem{/* values here */}) -``` - -### CustomToolCallItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1CustomToolCallItem(components.CustomToolCallItem{/* values here */}) -``` - -### CustomToolCallOutputItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1CustomToolCallOutputItem(components.CustomToolCallOutputItem{/* values here */}) -``` - -### CompactionItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1CompactionItem(components.CompactionItem{/* values here */}) -``` - -### ItemReferenceItem - -```go lines -inputsUnion1 := components.CreateInputsUnion1ItemReferenceItem(components.ItemReferenceItem{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch inputsUnion1.Type { - case components.InputsUnion1TypeReasoningItem: - // inputsUnion1.ReasoningItem is populated - case components.InputsUnion1TypeEasyInputMessage: - // inputsUnion1.EasyInputMessage is populated - case components.InputsUnion1TypeInputMessageItem: - // inputsUnion1.InputMessageItem is populated - case components.InputsUnion1TypeFunctionCallItem: - // inputsUnion1.FunctionCallItem is populated - case components.InputsUnion1TypeFunctionCallOutputItem: - // inputsUnion1.FunctionCallOutputItem is populated - case components.InputsUnion1TypeApplyPatchCallItem: - // inputsUnion1.ApplyPatchCallItem is populated - case components.InputsUnion1TypeApplyPatchCallOutputItem: - // inputsUnion1.ApplyPatchCallOutputItem is populated - case components.InputsUnion1TypeInputsMessage: - // inputsUnion1.InputsMessage is populated - case components.InputsUnion1TypeInputsReasoning: - // inputsUnion1.InputsReasoning is populated - case components.InputsUnion1TypeOutputFunctionCallItem: - // inputsUnion1.OutputFunctionCallItem is populated - case components.InputsUnion1TypeOutputCustomToolCallItem: - // inputsUnion1.OutputCustomToolCallItem is populated - case components.InputsUnion1TypeOutputWebSearchCallItem: - // inputsUnion1.OutputWebSearchCallItem is populated - case components.InputsUnion1TypeOutputFileSearchCallItem: - // inputsUnion1.OutputFileSearchCallItem is populated - case components.InputsUnion1TypeOutputImageGenerationCallItem: - // inputsUnion1.OutputImageGenerationCallItem is populated - case components.InputsUnion1TypeOutputCodeInterpreterCallItem: - // inputsUnion1.OutputCodeInterpreterCallItem is populated - case components.InputsUnion1TypeOutputComputerCallItem: - // inputsUnion1.OutputComputerCallItem is populated - case components.InputsUnion1TypeOutputDatetimeItem: - // inputsUnion1.OutputDatetimeItem is populated - case components.InputsUnion1TypeOutputWebSearchServerToolItem: - // inputsUnion1.OutputWebSearchServerToolItem is populated - case components.InputsUnion1TypeOutputCodeInterpreterServerToolItem: - // inputsUnion1.OutputCodeInterpreterServerToolItem is populated - case components.InputsUnion1TypeOutputFileSearchServerToolItem: - // inputsUnion1.OutputFileSearchServerToolItem is populated - case components.InputsUnion1TypeOutputImageGenerationServerToolItem: - // inputsUnion1.OutputImageGenerationServerToolItem is populated - case components.InputsUnion1TypeOutputBrowserUseServerToolItem: - // inputsUnion1.OutputBrowserUseServerToolItem is populated - case components.InputsUnion1TypeOutputBashServerToolItem: - // inputsUnion1.OutputBashServerToolItem is populated - case components.InputsUnion1TypeOutputTextEditorServerToolItem: - // inputsUnion1.OutputTextEditorServerToolItem is populated - case components.InputsUnion1TypeOutputApplyPatchServerToolItem: - // inputsUnion1.OutputApplyPatchServerToolItem is populated - case components.InputsUnion1TypeOutputWebFetchServerToolItem: - // inputsUnion1.OutputWebFetchServerToolItem is populated - case components.InputsUnion1TypeOutputToolSearchServerToolItem: - // inputsUnion1.OutputToolSearchServerToolItem is populated - case components.InputsUnion1TypeOutputMemoryServerToolItem: - // inputsUnion1.OutputMemoryServerToolItem is populated - case components.InputsUnion1TypeOutputMcpServerToolItem: - // inputsUnion1.OutputMcpServerToolItem is populated - case components.InputsUnion1TypeOutputSearchModelsServerToolItem: - // inputsUnion1.OutputSearchModelsServerToolItem is populated - case components.InputsUnion1TypeLocalShellCallItem: - // inputsUnion1.LocalShellCallItem is populated - case components.InputsUnion1TypeLocalShellCallOutputItem: - // inputsUnion1.LocalShellCallOutputItem is populated - case components.InputsUnion1TypeShellCallItem: - // inputsUnion1.ShellCallItem is populated - case components.InputsUnion1TypeShellCallOutputItem: - // inputsUnion1.ShellCallOutputItem is populated - case components.InputsUnion1TypeMcpListToolsItem: - // inputsUnion1.McpListToolsItem is populated - case components.InputsUnion1TypeMcpApprovalRequestItem: - // inputsUnion1.McpApprovalRequestItem is populated - case components.InputsUnion1TypeMcpApprovalResponseItem: - // inputsUnion1.McpApprovalResponseItem is populated - case components.InputsUnion1TypeMcpCallItem: - // inputsUnion1.McpCallItem is populated - case components.InputsUnion1TypeCustomToolCallItem: - // inputsUnion1.CustomToolCallItem is populated - case components.InputsUnion1TypeCustomToolCallOutputItem: - // inputsUnion1.CustomToolCallOutputItem is populated - case components.InputsUnion1TypeCompactionItem: - // inputsUnion1.CompactionItem is populated - case components.InputsUnion1TypeItemReferenceItem: - // inputsUnion1.ItemReferenceItem is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputtext.mdx b/client-sdks/go/api-reference/models/inputtext.mdx deleted file mode 100644 index fe2b4a55..00000000 --- a/client-sdks/go/api-reference/models/inputtext.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputText - Go SDK -sidebarTitle: InputText -description: InputText type definition -seoTitle: InputText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputtext' -'og:site_name': OpenRouter Documentation -'og:title': InputText Type | OpenRouter Go SDK -'og:description': >- - InputText type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputText%20-%20Go%20SDK&description=InputText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.InputTextType](/client-sdks/go/api-reference/models/inputtexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputtexttype.mdx b/client-sdks/go/api-reference/models/inputtexttype.mdx deleted file mode 100644 index 8053b246..00000000 --- a/client-sdks/go/api-reference/models/inputtexttype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputTextType - Go SDK -sidebarTitle: InputTextType -description: InputTextType type definition -seoTitle: InputTextType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputtexttype' -'og:site_name': OpenRouter Documentation -'og:title': InputTextType Type | OpenRouter Go SDK -'og:description': >- - InputTextType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTextType%20-%20Go%20SDK&description=InputTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputTextTypeInputText -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `InputTextTypeInputText` | input_text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputtokensdetails.mdx b/client-sdks/go/api-reference/models/inputtokensdetails.mdx deleted file mode 100644 index 195d6c69..00000000 --- a/client-sdks/go/api-reference/models/inputtokensdetails.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputTokensDetails - Go SDK -sidebarTitle: InputTokensDetails -description: InputTokensDetails type definition -seoTitle: InputTokensDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': InputTokensDetails Type | OpenRouter Go SDK -'og:description': >- - InputTokensDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTokensDetails%20-%20Go%20SDK&description=InputTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `CachedTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputunion.mdx b/client-sdks/go/api-reference/models/inputunion.mdx deleted file mode 100644 index 45cd29da..00000000 --- a/client-sdks/go/api-reference/models/inputunion.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: InputUnion - Go SDK -sidebarTitle: InputUnion -description: InputUnion type definition -seoTitle: InputUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion Type | OpenRouter Go SDK -'og:description': >- - InputUnion type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20Go%20SDK&description=InputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The input to the generation — either a prompt string or an array of messages - -## Supported Types - -### Input1 - -```go lines -inputUnion := components.CreateInputUnionInput1(components.Input1{/* values here */}) -``` - -### Input2 - -```go lines -inputUnion := components.CreateInputUnionInput2(components.Input2{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputUnion.Type { - case components.InputUnionTypeInput1: - // inputUnion.Input1 is populated - case components.InputUnionTypeInput2: - // inputUnion.Input2 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/inputvideo.mdx b/client-sdks/go/api-reference/models/inputvideo.mdx deleted file mode 100644 index 355e9744..00000000 --- a/client-sdks/go/api-reference/models/inputvideo.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputVideo - Go SDK -sidebarTitle: InputVideo -description: InputVideo type definition -seoTitle: InputVideo Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputvideo' -'og:site_name': OpenRouter Documentation -'og:title': InputVideo Type | OpenRouter Go SDK -'og:description': >- - InputVideo type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputVideo%20-%20Go%20SDK&description=InputVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Video input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.InputVideoType](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/inputvideotype.mdx b/client-sdks/go/api-reference/models/inputvideotype.mdx deleted file mode 100644 index f8cd1682..00000000 --- a/client-sdks/go/api-reference/models/inputvideotype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputVideoType - Go SDK -sidebarTitle: InputVideoType -description: InputVideoType type definition -seoTitle: InputVideoType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/inputvideotype' -'og:site_name': OpenRouter Documentation -'og:title': InputVideoType Type | OpenRouter Go SDK -'og:description': >- - InputVideoType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputVideoType%20-%20Go%20SDK&description=InputVideoType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InputVideoTypeInputVideo -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `InputVideoTypeInputVideo` | input_video | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/instructtype.mdx b/client-sdks/go/api-reference/models/instructtype.mdx deleted file mode 100644 index 50680e50..00000000 --- a/client-sdks/go/api-reference/models/instructtype.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: InstructType - Go SDK -sidebarTitle: InstructType -description: InstructType type definition -seoTitle: InstructType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/instructtype' -'og:site_name': OpenRouter Documentation -'og:title': InstructType Type | OpenRouter Go SDK -'og:description': >- - InstructType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InstructType%20-%20Go%20SDK&description=InstructType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.InstructTypeNone - -// Open enum: custom values can be created with a direct type cast -custom := components.InstructType("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `InstructTypeNone` | none | -| `InstructTypeAiroboros` | airoboros | -| `InstructTypeAlpaca` | alpaca | -| `InstructTypeAlpacaModif` | alpaca-modif | -| `InstructTypeChatml` | chatml | -| `InstructTypeClaude` | claude | -| `InstructTypeCodeLlama` | code-llama | -| `InstructTypeGemma` | gemma | -| `InstructTypeLlama2` | llama2 | -| `InstructTypeLlama3` | llama3 | -| `InstructTypeMistral` | mistral | -| `InstructTypeNemotron` | nemotron | -| `InstructTypeNeural` | neural | -| `InstructTypeOpenchat` | openchat | -| `InstructTypePhi3` | phi3 | -| `InstructTypeRwkv` | rwkv | -| `InstructTypeVicuna` | vicuna | -| `InstructTypeZephyr` | zephyr | -| `InstructTypeDeepseekR1` | deepseek-r1 | -| `InstructTypeDeepseekV31` | deepseek-v3.1 | -| `InstructTypeQwq` | qwq | -| `InstructTypeQwen3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/internalserverresponseerror.mdx b/client-sdks/go/api-reference/models/internalserverresponseerror.mdx deleted file mode 100644 index 6124fcaf..00000000 --- a/client-sdks/go/api-reference/models/internalserverresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InternalServerResponseError - Go SDK -sidebarTitle: InternalServerResponseError -description: InternalServerResponseError type definition -seoTitle: InternalServerResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/internalserverresponseerror -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseError Type | OpenRouter Go SDK -'og:description': >- - InternalServerResponseError type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseError%20-%20Go%20SDK&description=InternalServerResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Internal Server Error - Unexpected server error - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternalServerResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/internalserverresponseerrordata.mdx b/client-sdks/go/api-reference/models/internalserverresponseerrordata.mdx deleted file mode 100644 index 6c3524a0..00000000 --- a/client-sdks/go/api-reference/models/internalserverresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InternalServerResponseErrorData - Go SDK -sidebarTitle: InternalServerResponseErrorData -description: InternalServerResponseErrorData type definition -seoTitle: InternalServerResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/internalserverresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - InternalServerResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseErrorData%20-%20Go%20SDK&description=InternalServerResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for InternalServerResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/itemreferenceitem.mdx b/client-sdks/go/api-reference/models/itemreferenceitem.mdx deleted file mode 100644 index 87955071..00000000 --- a/client-sdks/go/api-reference/models/itemreferenceitem.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ItemReferenceItem - Go SDK -sidebarTitle: ItemReferenceItem -description: ItemReferenceItem type definition -seoTitle: ItemReferenceItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/itemreferenceitem' -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItem Type | OpenRouter Go SDK -'og:description': >- - ItemReferenceItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItem%20-%20Go%20SDK&description=ItemReferenceItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A reference to a previous response item by ID - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ItemReferenceItemType](/client-sdks/go/api-reference/models/itemreferenceitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/itemreferenceitemtype.mdx b/client-sdks/go/api-reference/models/itemreferenceitemtype.mdx deleted file mode 100644 index 11de7374..00000000 --- a/client-sdks/go/api-reference/models/itemreferenceitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ItemReferenceItemType - Go SDK -sidebarTitle: ItemReferenceItemType -description: ItemReferenceItemType type definition -seoTitle: ItemReferenceItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/itemreferenceitemtype' -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItemType Type | OpenRouter Go SDK -'og:description': >- - ItemReferenceItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItemType%20-%20Go%20SDK&description=ItemReferenceItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ItemReferenceItemTypeItemReference -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `ItemReferenceItemTypeItemReference` | item_reference | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/keep.mdx b/client-sdks/go/api-reference/models/keep.mdx deleted file mode 100644 index 78f7449a..00000000 --- a/client-sdks/go/api-reference/models/keep.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Keep - Go SDK -sidebarTitle: Keep -description: Keep type definition -seoTitle: Keep Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/keep' -'og:site_name': OpenRouter Documentation -'og:title': Keep Type | OpenRouter Go SDK -'og:description': >- - Keep type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Keep%20-%20Go%20SDK&description=Keep%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicThinkingTurns - -```go lines -keep := components.CreateKeepAnthropicThinkingTurns(components.AnthropicThinkingTurns{/* values here */}) -``` - -### KeepAll - -```go lines -keep := components.CreateKeepKeepAll(components.KeepAll{/* values here */}) -``` - -### KeepEnum - -```go lines -keep := components.CreateKeepKeepEnum(components.KeepEnum{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch keep.Type { - case components.KeepUnionTypeAnthropicThinkingTurns: - // keep.AnthropicThinkingTurns is populated - case components.KeepUnionTypeKeepAll: - // keep.KeepAll is populated - case components.KeepUnionTypeKeepEnum: - // keep.KeepEnum is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/keepall.mdx b/client-sdks/go/api-reference/models/keepall.mdx deleted file mode 100644 index 094dfa72..00000000 --- a/client-sdks/go/api-reference/models/keepall.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: KeepAll - Go SDK -sidebarTitle: KeepAll -description: KeepAll type definition -seoTitle: KeepAll Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/keepall' -'og:site_name': OpenRouter Documentation -'og:title': KeepAll Type | OpenRouter Go SDK -'og:description': >- - KeepAll type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepAll%20-%20Go%20SDK&description=KeepAll%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.KeepType](/client-sdks/go/api-reference/models/keeptype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/keepenum.mdx b/client-sdks/go/api-reference/models/keepenum.mdx deleted file mode 100644 index e578b074..00000000 --- a/client-sdks/go/api-reference/models/keepenum.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: KeepEnum - Go SDK -sidebarTitle: KeepEnum -description: KeepEnum type definition -seoTitle: KeepEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/keepenum' -'og:site_name': OpenRouter Documentation -'og:title': KeepEnum Type | OpenRouter Go SDK -'og:description': >- - KeepEnum type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepEnum%20-%20Go%20SDK&description=KeepEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.KeepEnumAll -``` - -## Values - -| Name | Value | -| ------------- | ------------- | -| `KeepEnumAll` | all | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/keeptype.mdx b/client-sdks/go/api-reference/models/keeptype.mdx deleted file mode 100644 index 72aed297..00000000 --- a/client-sdks/go/api-reference/models/keeptype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: KeepType - Go SDK -sidebarTitle: KeepType -description: KeepType type definition -seoTitle: KeepType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/keeptype' -'og:site_name': OpenRouter Documentation -'og:title': KeepType Type | OpenRouter Go SDK -'og:description': >- - KeepType type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepType%20-%20Go%20SDK&description=KeepType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.KeepTypeAll -``` - -## Values - -| Name | Value | -| ------------- | ------------- | -| `KeepTypeAll` | all | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/keyassignment.mdx b/client-sdks/go/api-reference/models/keyassignment.mdx deleted file mode 100644 index e2b7aaee..00000000 --- a/client-sdks/go/api-reference/models/keyassignment.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: KeyAssignment - Go SDK -sidebarTitle: KeyAssignment -description: KeyAssignment type definition -seoTitle: KeyAssignment Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/keyassignment' -'og:site_name': OpenRouter Documentation -'og:title': KeyAssignment Type | OpenRouter Go SDK -'og:description': >- - KeyAssignment type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeyAssignment%20-%20Go%20SDK&description=KeyAssignment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `KeyHash` | `string` | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `KeyLabel` | `string` | :heavy_check_mark: | Label of the API key | prod-key | -| `KeyName` | `string` | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/legacychatcontentvideo.mdx b/client-sdks/go/api-reference/models/legacychatcontentvideo.mdx deleted file mode 100644 index 3cad96de..00000000 --- a/client-sdks/go/api-reference/models/legacychatcontentvideo.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ~~LegacyChatContentVideo~~ - Go SDK -sidebarTitle: ~~LegacyChatContentVideo~~ -description: ~~LegacyChatContentVideo~~ type definition -seoTitle: ~~LegacyChatContentVideo~~ Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/legacychatcontentvideo' -'og:site_name': OpenRouter Documentation -'og:title': ~~LegacyChatContentVideo~~ Type | OpenRouter Go SDK -'og:description': >- - ~~LegacyChatContentVideo~~ type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~LegacyChatContentVideo~~%20-%20Go%20SDK&description=~~LegacyChatContentVideo~~%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Video input content part (legacy format - deprecated) - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.LegacyChatContentVideoType](/client-sdks/go/api-reference/models/legacychatcontentvideotype) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.ChatContentVideoInput](/client-sdks/go/api-reference/models/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/legacychatcontentvideotype.mdx b/client-sdks/go/api-reference/models/legacychatcontentvideotype.mdx deleted file mode 100644 index 882b5733..00000000 --- a/client-sdks/go/api-reference/models/legacychatcontentvideotype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: LegacyChatContentVideoType - Go SDK -sidebarTitle: LegacyChatContentVideoType -description: LegacyChatContentVideoType type definition -seoTitle: LegacyChatContentVideoType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/legacychatcontentvideotype -'og:site_name': OpenRouter Documentation -'og:title': LegacyChatContentVideoType Type | OpenRouter Go SDK -'og:description': >- - LegacyChatContentVideoType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyChatContentVideoType%20-%20Go%20SDK&description=LegacyChatContentVideoType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.LegacyChatContentVideoTypeInputVideo -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `LegacyChatContentVideoTypeInputVideo` | input_video | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/legacywebsearchservertool.mdx b/client-sdks/go/api-reference/models/legacywebsearchservertool.mdx deleted file mode 100644 index b5204b70..00000000 --- a/client-sdks/go/api-reference/models/legacywebsearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: LegacyWebSearchServerTool - Go SDK -sidebarTitle: LegacyWebSearchServerTool -description: LegacyWebSearchServerTool type definition -seoTitle: LegacyWebSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/legacywebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': LegacyWebSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - LegacyWebSearchServerTool type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyWebSearchServerTool%20-%20Go%20SDK&description=LegacyWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](/client-sdks/go/api-reference/models/websearchdomainfilter)] | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.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, and Parallel engines; ignored with native provider search. | 5 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](/client-sdks/go/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.LegacyWebSearchServerToolType](/client-sdks/go/api-reference/models/legacywebsearchservertooltype) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/legacywebsearchservertooltype.mdx b/client-sdks/go/api-reference/models/legacywebsearchservertooltype.mdx deleted file mode 100644 index 50721116..00000000 --- a/client-sdks/go/api-reference/models/legacywebsearchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: LegacyWebSearchServerToolType - Go SDK -sidebarTitle: LegacyWebSearchServerToolType -description: LegacyWebSearchServerToolType type definition -seoTitle: LegacyWebSearchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/legacywebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': LegacyWebSearchServerToolType Type | OpenRouter Go SDK -'og:description': >- - LegacyWebSearchServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyWebSearchServerToolType%20-%20Go%20SDK&description=LegacyWebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.LegacyWebSearchServerToolTypeWebSearch -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `LegacyWebSearchServerToolTypeWebSearch` | web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/listbyokkeysresponse.mdx b/client-sdks/go/api-reference/models/listbyokkeysresponse.mdx deleted file mode 100644 index b8b7325d..00000000 --- a/client-sdks/go/api-reference/models/listbyokkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListBYOKKeysResponse - Go SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse type definition -seoTitle: ListBYOKKeysResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/listbyokkeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse Type | OpenRouter Go SDK -'og:description': >- - ListBYOKKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20Go%20SDK&description=ListBYOKKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Data` | [][components.BYOKKey](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listendpointsresponse.mdx b/client-sdks/go/api-reference/models/listendpointsresponse.mdx deleted file mode 100644 index 95e3bbc5..00000000 --- a/client-sdks/go/api-reference/models/listendpointsresponse.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ListEndpointsResponse - Go SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse type definition -seoTitle: ListEndpointsResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/listendpointsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse Type | OpenRouter Go SDK -'og:description': >- - ListEndpointsResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Go%20SDK&description=ListEndpointsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -List of available endpoints for a model - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Architecture` | [components.Architecture](/client-sdks/go/api-reference/models/architecture) | :heavy_check_mark: | N/A | `{"instruct_type": "chatml","modality": "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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listguardrailsresponse.mdx b/client-sdks/go/api-reference/models/listguardrailsresponse.mdx deleted file mode 100644 index bc044da5..00000000 --- a/client-sdks/go/api-reference/models/listguardrailsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailsResponse - Go SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse type definition -seoTitle: ListGuardrailsResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/listguardrailsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailsResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20Go%20SDK&description=ListGuardrailsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Guardrail](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listkeyassignmentsresponse.mdx b/client-sdks/go/api-reference/models/listkeyassignmentsresponse.mdx deleted file mode 100644 index fcd9a944..00000000 --- a/client-sdks/go/api-reference/models/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - Go SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse type definition -seoTitle: ListKeyAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListKeyAssignmentsResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20Go%20SDK&description=ListKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [][components.KeyAssignment](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listmemberassignmentsresponse.mdx b/client-sdks/go/api-reference/models/listmemberassignmentsresponse.mdx deleted file mode 100644 index 8e9b5cbe..00000000 --- a/client-sdks/go/api-reference/models/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - Go SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse type definition -seoTitle: ListMemberAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListMemberAssignmentsResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20Go%20SDK&description=ListMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.MemberAssignment](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listobservabilitydestinationsresponse.mdx b/client-sdks/go/api-reference/models/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index 8c3f879a..00000000 --- a/client-sdks/go/api-reference/models/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - Go SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse type definition -seoTitle: ListObservabilityDestinationsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse Type | OpenRouter Go SDK -'og:description': >- - ListObservabilityDestinationsResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20Go%20SDK&description=ListObservabilityDestinationsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [][components.ObservabilityDestination](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/listworkspacesresponse.mdx b/client-sdks/go/api-reference/models/listworkspacesresponse.mdx deleted file mode 100644 index d0692ce4..00000000 --- a/client-sdks/go/api-reference/models/listworkspacesresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListWorkspacesResponse - Go SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse type definition -seoTitle: ListWorkspacesResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/listworkspacesresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse Type | OpenRouter Go SDK -'og:description': >- - ListWorkspacesResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20Go%20SDK&description=ListWorkspacesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Workspace](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/localshellcallitem.mdx b/client-sdks/go/api-reference/models/localshellcallitem.mdx deleted file mode 100644 index 9547a63c..00000000 --- a/client-sdks/go/api-reference/models/localshellcallitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: LocalShellCallItem - Go SDK -sidebarTitle: LocalShellCallItem -description: LocalShellCallItem type definition -seoTitle: LocalShellCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/localshellcallitem' -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItem Type | OpenRouter Go SDK -'og:description': >- - LocalShellCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItem%20-%20Go%20SDK&description=LocalShellCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A local shell command execution call - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Action` | [components.LocalShellCallItemAction](/client-sdks/go/api-reference/models/localshellcallitemaction) | :heavy_check_mark: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeLocalShellCall](/client-sdks/go/api-reference/models/typelocalshellcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/localshellcallitemaction.mdx b/client-sdks/go/api-reference/models/localshellcallitemaction.mdx deleted file mode 100644 index eb63aa8d..00000000 --- a/client-sdks/go/api-reference/models/localshellcallitemaction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: LocalShellCallItemAction - Go SDK -sidebarTitle: LocalShellCallItemAction -description: LocalShellCallItemAction type definition -seoTitle: LocalShellCallItemAction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/localshellcallitemaction -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItemAction Type | OpenRouter Go SDK -'og:description': >- - LocalShellCallItemAction type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItemAction%20-%20Go%20SDK&description=LocalShellCallItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/localshellcalloutputitem.mdx b/client-sdks/go/api-reference/models/localshellcalloutputitem.mdx deleted file mode 100644 index 99e77d5a..00000000 --- a/client-sdks/go/api-reference/models/localshellcalloutputitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: LocalShellCallOutputItem - Go SDK -sidebarTitle: LocalShellCallOutputItem -description: LocalShellCallOutputItem type definition -seoTitle: LocalShellCallOutputItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/localshellcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItem Type | OpenRouter Go SDK -'og:description': >- - LocalShellCallOutputItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItem%20-%20Go%20SDK&description=LocalShellCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Output from a local shell command execution - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Output` | `string` | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.LocalShellCallOutputItemStatus](/client-sdks/go/api-reference/models/localshellcalloutputitemstatus)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.LocalShellCallOutputItemType](/client-sdks/go/api-reference/models/localshellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/localshellcalloutputitemstatus.mdx b/client-sdks/go/api-reference/models/localshellcalloutputitemstatus.mdx deleted file mode 100644 index 917596b3..00000000 --- a/client-sdks/go/api-reference/models/localshellcalloutputitemstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: LocalShellCallOutputItemStatus - Go SDK -sidebarTitle: LocalShellCallOutputItemStatus -description: LocalShellCallOutputItemStatus type definition -seoTitle: LocalShellCallOutputItemStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/localshellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemStatus Type | OpenRouter Go SDK -'og:description': >- - LocalShellCallOutputItemStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemStatus%20-%20Go%20SDK&description=LocalShellCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.LocalShellCallOutputItemStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.LocalShellCallOutputItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `LocalShellCallOutputItemStatusInProgress` | in_progress | -| `LocalShellCallOutputItemStatusCompleted` | completed | -| `LocalShellCallOutputItemStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/localshellcalloutputitemtype.mdx b/client-sdks/go/api-reference/models/localshellcalloutputitemtype.mdx deleted file mode 100644 index 6ecf2cfd..00000000 --- a/client-sdks/go/api-reference/models/localshellcalloutputitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: LocalShellCallOutputItemType - Go SDK -sidebarTitle: LocalShellCallOutputItemType -description: LocalShellCallOutputItemType type definition -seoTitle: LocalShellCallOutputItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/localshellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemType Type | OpenRouter Go SDK -'og:description': >- - LocalShellCallOutputItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemType%20-%20Go%20SDK&description=LocalShellCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.LocalShellCallOutputItemTypeLocalShellCallOutput -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `LocalShellCallOutputItemTypeLocalShellCallOutput` | local_shell_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/logic.mdx b/client-sdks/go/api-reference/models/logic.mdx deleted file mode 100644 index 261dba89..00000000 --- a/client-sdks/go/api-reference/models/logic.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Logic - Go SDK -sidebarTitle: Logic -description: Logic type definition -seoTitle: Logic Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/logic' -'og:site_name': OpenRouter Documentation -'og:title': Logic Type | OpenRouter Go SDK -'og:description': >- - Logic type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logic%20-%20Go%20SDK&description=Logic%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.LogicAnd - -// Open enum: custom values can be created with a direct type cast -custom := components.Logic("custom_value") -``` - -## Values - -| Name | Value | -| ---------- | ---------- | -| `LogicAnd` | and | -| `LogicOr` | or | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/logprob.mdx b/client-sdks/go/api-reference/models/logprob.mdx deleted file mode 100644 index da1f73c9..00000000 --- a/client-sdks/go/api-reference/models/logprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Logprob - Go SDK -sidebarTitle: Logprob -description: Logprob type definition -seoTitle: Logprob Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/logprob' -'og:site_name': OpenRouter Documentation -'og:title': Logprob Type | OpenRouter Go SDK -'og:description': >- - Logprob type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logprob%20-%20Go%20SDK&description=Logprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](/client-sdks/go/api-reference/models/responseoutputtexttoplogprob) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/maxprice.mdx b/client-sdks/go/api-reference/models/maxprice.mdx deleted file mode 100644 index 94faf9f1..00000000 --- a/client-sdks/go/api-reference/models/maxprice.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: MaxPrice - Go SDK -sidebarTitle: MaxPrice -description: MaxPrice type definition -seoTitle: MaxPrice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/maxprice' -'og:site_name': OpenRouter Documentation -'og:title': MaxPrice Type | OpenRouter Go SDK -'og:description': >- - MaxPrice type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MaxPrice%20-%20Go%20SDK&description=MaxPrice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Completion` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Image` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Prompt` | `*string` | :heavy_minus_sign: | Price per million prompt tokens | 1000 | -| `Request` | `*string` | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpapprovalrequestitem.mdx b/client-sdks/go/api-reference/models/mcpapprovalrequestitem.mdx deleted file mode 100644 index 91abebd1..00000000 --- a/client-sdks/go/api-reference/models/mcpapprovalrequestitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: McpApprovalRequestItem - Go SDK -sidebarTitle: McpApprovalRequestItem -description: McpApprovalRequestItem type definition -seoTitle: McpApprovalRequestItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcpapprovalrequestitem' -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItem Type | OpenRouter Go SDK -'og:description': >- - McpApprovalRequestItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItem%20-%20Go%20SDK&description=McpApprovalRequestItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Request for approval to execute an MCP tool - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpApprovalRequestItemType](/client-sdks/go/api-reference/models/mcpapprovalrequestitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpapprovalrequestitemtype.mdx b/client-sdks/go/api-reference/models/mcpapprovalrequestitemtype.mdx deleted file mode 100644 index 0a1aaa24..00000000 --- a/client-sdks/go/api-reference/models/mcpapprovalrequestitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: McpApprovalRequestItemType - Go SDK -sidebarTitle: McpApprovalRequestItemType -description: McpApprovalRequestItemType type definition -seoTitle: McpApprovalRequestItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/mcpapprovalrequestitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItemType Type | OpenRouter Go SDK -'og:description': >- - McpApprovalRequestItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItemType%20-%20Go%20SDK&description=McpApprovalRequestItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.McpApprovalRequestItemTypeMcpApprovalRequest -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `McpApprovalRequestItemTypeMcpApprovalRequest` | mcp_approval_request | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpapprovalresponseitem.mdx b/client-sdks/go/api-reference/models/mcpapprovalresponseitem.mdx deleted file mode 100644 index 1c70b960..00000000 --- a/client-sdks/go/api-reference/models/mcpapprovalresponseitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: McpApprovalResponseItem - Go SDK -sidebarTitle: McpApprovalResponseItem -description: McpApprovalResponseItem type definition -seoTitle: McpApprovalResponseItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/mcpapprovalresponseitem -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItem Type | OpenRouter Go SDK -'og:description': >- - McpApprovalResponseItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItem%20-%20Go%20SDK&description=McpApprovalResponseItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -User response to an MCP tool approval request - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ApprovalRequestID` | `string` | :heavy_check_mark: | N/A | -| `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](/client-sdks/go/api-reference/models/mcpapprovalresponseitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpapprovalresponseitemtype.mdx b/client-sdks/go/api-reference/models/mcpapprovalresponseitemtype.mdx deleted file mode 100644 index 0393c37a..00000000 --- a/client-sdks/go/api-reference/models/mcpapprovalresponseitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: McpApprovalResponseItemType - Go SDK -sidebarTitle: McpApprovalResponseItemType -description: McpApprovalResponseItemType type definition -seoTitle: McpApprovalResponseItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/mcpapprovalresponseitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItemType Type | OpenRouter Go SDK -'og:description': >- - McpApprovalResponseItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItemType%20-%20Go%20SDK&description=McpApprovalResponseItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.McpApprovalResponseItemTypeMcpApprovalResponse -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `McpApprovalResponseItemTypeMcpApprovalResponse` | mcp_approval_response | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpcallitem.mdx b/client-sdks/go/api-reference/models/mcpcallitem.mdx deleted file mode 100644 index 53497a99..00000000 --- a/client-sdks/go/api-reference/models/mcpcallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: McpCallItem - Go SDK -sidebarTitle: McpCallItem -description: McpCallItem type definition -seoTitle: McpCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcpcallitem' -'og:site_name': OpenRouter Documentation -'og:title': McpCallItem Type | OpenRouter Go SDK -'og:description': >- - McpCallItem type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItem%20-%20Go%20SDK&description=McpCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An MCP tool call with its output or error - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `Error` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `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](/client-sdks/go/api-reference/models/mcpcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpcallitemtype.mdx b/client-sdks/go/api-reference/models/mcpcallitemtype.mdx deleted file mode 100644 index 92a603a1..00000000 --- a/client-sdks/go/api-reference/models/mcpcallitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: McpCallItemType - Go SDK -sidebarTitle: McpCallItemType -description: McpCallItemType type definition -seoTitle: McpCallItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcpcallitemtype' -'og:site_name': OpenRouter Documentation -'og:title': McpCallItemType Type | OpenRouter Go SDK -'og:description': >- - McpCallItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItemType%20-%20Go%20SDK&description=McpCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.McpCallItemTypeMcpCall -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `McpCallItemTypeMcpCall` | mcp_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcplisttoolsitem.mdx b/client-sdks/go/api-reference/models/mcplisttoolsitem.mdx deleted file mode 100644 index a2167159..00000000 --- a/client-sdks/go/api-reference/models/mcplisttoolsitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: McpListToolsItem - Go SDK -sidebarTitle: McpListToolsItem -description: McpListToolsItem type definition -seoTitle: McpListToolsItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcplisttoolsitem' -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItem Type | OpenRouter Go SDK -'og:description': >- - McpListToolsItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItem%20-%20Go%20SDK&description=McpListToolsItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -List of available MCP tools from a server - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/mcplisttoolsitemtool) | :heavy_check_mark: | N/A | -| `Type` | [components.McpListToolsItemType](/client-sdks/go/api-reference/models/mcplisttoolsitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcplisttoolsitemtool.mdx b/client-sdks/go/api-reference/models/mcplisttoolsitemtool.mdx deleted file mode 100644 index 3dff5d75..00000000 --- a/client-sdks/go/api-reference/models/mcplisttoolsitemtool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: McpListToolsItemTool - Go SDK -sidebarTitle: McpListToolsItemTool -description: McpListToolsItemTool type definition -seoTitle: McpListToolsItemTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcplisttoolsitemtool' -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemTool Type | OpenRouter Go SDK -'og:description': >- - McpListToolsItemTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemTool%20-%20Go%20SDK&description=McpListToolsItemTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Annotations` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `InputSchema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcplisttoolsitemtype.mdx b/client-sdks/go/api-reference/models/mcplisttoolsitemtype.mdx deleted file mode 100644 index e6b2d283..00000000 --- a/client-sdks/go/api-reference/models/mcplisttoolsitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: McpListToolsItemType - Go SDK -sidebarTitle: McpListToolsItemType -description: McpListToolsItemType type definition -seoTitle: McpListToolsItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcplisttoolsitemtype' -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemType Type | OpenRouter Go SDK -'og:description': >- - McpListToolsItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemType%20-%20Go%20SDK&description=McpListToolsItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.McpListToolsItemTypeMcpListTools -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `McpListToolsItemTypeMcpListTools` | mcp_list_tools | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpservertool.mdx b/client-sdks/go/api-reference/models/mcpservertool.mdx deleted file mode 100644 index 3d025e4d..00000000 --- a/client-sdks/go/api-reference/models/mcpservertool.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: McpServerTool - Go SDK -sidebarTitle: McpServerTool -description: McpServerTool type definition -seoTitle: McpServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcpservertool' -'og:site_name': OpenRouter Documentation -'og:title': McpServerTool Type | OpenRouter Go SDK -'og:description': >- - McpServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpServerTool%20-%20Go%20SDK&description=McpServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -MCP (Model Context Protocol) tool configuration - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](/client-sdks/go/api-reference/models/allowedtoolsunion)] | :heavy_minus_sign: | N/A | -| `Authorization` | `*string` | :heavy_minus_sign: | N/A | -| `ConnectorID` | [*components.ConnectorID](/client-sdks/go/api-reference/models/connectorid) | :heavy_minus_sign: | N/A | -| `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | N/A | -| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](/client-sdks/go/api-reference/models/requireapprovalunion)] | :heavy_minus_sign: | N/A | -| `ServerDescription` | `*string` | :heavy_minus_sign: | N/A | -| `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `ServerURL` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.McpServerToolType](/client-sdks/go/api-reference/models/mcpservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mcpservertooltype.mdx b/client-sdks/go/api-reference/models/mcpservertooltype.mdx deleted file mode 100644 index abc8057b..00000000 --- a/client-sdks/go/api-reference/models/mcpservertooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: McpServerToolType - Go SDK -sidebarTitle: McpServerToolType -description: McpServerToolType type definition -seoTitle: McpServerToolType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mcpservertooltype' -'og:site_name': OpenRouter Documentation -'og:title': McpServerToolType Type | OpenRouter Go SDK -'og:description': >- - McpServerToolType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpServerToolType%20-%20Go%20SDK&description=McpServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.McpServerToolTypeMcp -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `McpServerToolTypeMcp` | mcp | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/memberassignment.mdx b/client-sdks/go/api-reference/models/memberassignment.mdx deleted file mode 100644 index a264c830..00000000 --- a/client-sdks/go/api-reference/models/memberassignment.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: MemberAssignment - Go SDK -sidebarTitle: MemberAssignment -description: MemberAssignment type definition -seoTitle: MemberAssignment Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/memberassignment' -'og:site_name': OpenRouter Documentation -'og:title': MemberAssignment Type | OpenRouter Go SDK -'og:description': >- - MemberAssignment type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemberAssignment%20-%20Go%20SDK&description=MemberAssignment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `AssignedBy` | `*string` | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `GuardrailID` | `string` | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `OrganizationID` | `string` | :heavy_check_mark: | Organization ID | org_xyz789 | -| `UserID` | `string` | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/memorylimit.mdx b/client-sdks/go/api-reference/models/memorylimit.mdx deleted file mode 100644 index 364bf034..00000000 --- a/client-sdks/go/api-reference/models/memorylimit.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: MemoryLimit - Go SDK -sidebarTitle: MemoryLimit -description: MemoryLimit type definition -seoTitle: MemoryLimit Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/memorylimit' -'og:site_name': OpenRouter Documentation -'og:title': MemoryLimit Type | OpenRouter Go SDK -'og:description': >- - MemoryLimit type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemoryLimit%20-%20Go%20SDK&description=MemoryLimit%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MemoryLimitOneg - -// Open enum: custom values can be created with a direct type cast -custom := components.MemoryLimit("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `MemoryLimitOneg` | 1g | -| `MemoryLimitFourg` | 4g | -| `MemoryLimitSixteeng` | 16g | -| `MemoryLimitSixtyFourg` | 64g | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesadvisortoolresultblock.mdx b/client-sdks/go/api-reference/models/messagesadvisortoolresultblock.mdx deleted file mode 100644 index fd8cfe9e..00000000 --- a/client-sdks/go/api-reference/models/messagesadvisortoolresultblock.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: MessagesAdvisorToolResultBlock - Go SDK -sidebarTitle: MessagesAdvisorToolResultBlock -description: MessagesAdvisorToolResultBlock type definition -seoTitle: MessagesAdvisorToolResultBlock Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesadvisortoolresultblock -'og:site_name': OpenRouter Documentation -'og:title': MessagesAdvisorToolResultBlock Type | OpenRouter Go SDK -'og:description': >- - MessagesAdvisorToolResultBlock type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesAdvisorToolResultBlock%20-%20Go%20SDK&description=MessagesAdvisorToolResultBlock%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Advisor tool result from a prior assistant turn, replayed back to the model on the next turn. Mirrors the block Anthropic returns in assistant content when the `advisor_20260301` tool runs. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Content` | map[string]`any` | :heavy_check_mark: | N/A | -| `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesAdvisorToolResultBlockType](/client-sdks/go/api-reference/models/messagesadvisortoolresultblocktype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesadvisortoolresultblocktype.mdx b/client-sdks/go/api-reference/models/messagesadvisortoolresultblocktype.mdx deleted file mode 100644 index 0b7c40c7..00000000 --- a/client-sdks/go/api-reference/models/messagesadvisortoolresultblocktype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: MessagesAdvisorToolResultBlockType - Go SDK -sidebarTitle: MessagesAdvisorToolResultBlockType -description: MessagesAdvisorToolResultBlockType type definition -seoTitle: MessagesAdvisorToolResultBlockType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesadvisortoolresultblocktype -'og:site_name': OpenRouter Documentation -'og:title': MessagesAdvisorToolResultBlockType Type | OpenRouter Go SDK -'og:description': >- - MessagesAdvisorToolResultBlockType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesAdvisorToolResultBlockType%20-%20Go%20SDK&description=MessagesAdvisorToolResultBlockType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MessagesAdvisorToolResultBlockTypeAdvisorToolResult -``` - -## Values - -| Name | Value | -| ----------------------------------------------------- | ----------------------------------------------------- | -| `MessagesAdvisorToolResultBlockTypeAdvisorToolResult` | advisor_tool_result | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparam.mdx b/client-sdks/go/api-reference/models/messagesmessageparam.mdx deleted file mode 100644 index f183d1e5..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparam.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: MessagesMessageParam - Go SDK -sidebarTitle: MessagesMessageParam -description: MessagesMessageParam type definition -seoTitle: MessagesMessageParam Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/messagesmessageparam' -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParam Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParam type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParam%20-%20Go%20SDK&description=MessagesMessageParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Anthropic message with OpenRouter extensions - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Content` | [components.MessagesMessageParamContentUnion5](/client-sdks/go/api-reference/models/messagesmessageparamcontentunion5) | :heavy_check_mark: | N/A | -| `Role` | [components.MessagesMessageParamRole](/client-sdks/go/api-reference/models/messagesmessageparamrole) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion1.mdx b/client-sdks/go/api-reference/models/messagesmessageparamcontentunion1.mdx deleted file mode 100644 index 2edac9b7..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion1.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: MessagesMessageParamContentUnion1 - Go SDK -sidebarTitle: MessagesMessageParamContentUnion1 -description: MessagesMessageParamContentUnion1 type definition -seoTitle: MessagesMessageParamContentUnion1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamcontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion1 Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamContentUnion1 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion1%20-%20Go%20SDK&description=MessagesMessageParamContentUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicTextBlockParam - -```go lines -messagesMessageParamContentUnion1 := components.CreateMessagesMessageParamContentUnion1Text(components.AnthropicTextBlockParam{/* values here */}) -``` - -### AnthropicImageBlockParam - -```go lines -messagesMessageParamContentUnion1 := components.CreateMessagesMessageParamContentUnion1Image(components.AnthropicImageBlockParam{/* values here */}) -``` - -### ContentToolReference - -```go lines -messagesMessageParamContentUnion1 := components.CreateMessagesMessageParamContentUnion1ToolReference(components.ContentToolReference{/* values here */}) -``` - -### AnthropicSearchResultBlockParam - -```go lines -messagesMessageParamContentUnion1 := components.CreateMessagesMessageParamContentUnion1SearchResult(components.AnthropicSearchResultBlockParam{/* values here */}) -``` - -### AnthropicDocumentBlockParam - -```go lines -messagesMessageParamContentUnion1 := components.CreateMessagesMessageParamContentUnion1Document(components.AnthropicDocumentBlockParam{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch messagesMessageParamContentUnion1.Type { - case components.MessagesMessageParamContentUnion1TypeText: - // messagesMessageParamContentUnion1.AnthropicTextBlockParam is populated - case components.MessagesMessageParamContentUnion1TypeImage: - // messagesMessageParamContentUnion1.AnthropicImageBlockParam is populated - case components.MessagesMessageParamContentUnion1TypeToolReference: - // messagesMessageParamContentUnion1.ContentToolReference is populated - case components.MessagesMessageParamContentUnion1TypeSearchResult: - // messagesMessageParamContentUnion1.AnthropicSearchResultBlockParam is populated - case components.MessagesMessageParamContentUnion1TypeDocument: - // messagesMessageParamContentUnion1.AnthropicDocumentBlockParam is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion2.mdx b/client-sdks/go/api-reference/models/messagesmessageparamcontentunion2.mdx deleted file mode 100644 index e4e65701..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: MessagesMessageParamContentUnion2 - Go SDK -sidebarTitle: MessagesMessageParamContentUnion2 -description: MessagesMessageParamContentUnion2 type definition -seoTitle: MessagesMessageParamContentUnion2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamcontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion2 Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamContentUnion2 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion2%20-%20Go%20SDK&description=MessagesMessageParamContentUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -messagesMessageParamContentUnion2 := components.CreateMessagesMessageParamContentUnion2Str(string{/* values here */}) -``` - -### - -```go lines -messagesMessageParamContentUnion2 := components.CreateMessagesMessageParamContentUnion2ArrayOfMessagesMessageParamContentUnion1([]components.MessagesMessageParamContentUnion1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch messagesMessageParamContentUnion2.Type { - case components.MessagesMessageParamContentUnion2TypeStr: - // messagesMessageParamContentUnion2.Str is populated - case components.MessagesMessageParamContentUnion2TypeArrayOfMessagesMessageParamContentUnion1: - // messagesMessageParamContentUnion2.ArrayOfMessagesMessageParamContentUnion1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion3.mdx b/client-sdks/go/api-reference/models/messagesmessageparamcontentunion3.mdx deleted file mode 100644 index 0b2afe2e..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion3.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: MessagesMessageParamContentUnion3 - Go SDK -sidebarTitle: MessagesMessageParamContentUnion3 -description: MessagesMessageParamContentUnion3 type definition -seoTitle: MessagesMessageParamContentUnion3 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamcontentunion3 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion3 Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamContentUnion3 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion3%20-%20Go%20SDK&description=MessagesMessageParamContentUnion3%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -messagesMessageParamContentUnion3 := components.CreateMessagesMessageParamContentUnion3ArrayOfAnthropicWebSearchResultBlockParam([]components.AnthropicWebSearchResultBlockParam{/* values here */}) -``` - -### ContentWebSearchToolResultError - -```go lines -messagesMessageParamContentUnion3 := components.CreateMessagesMessageParamContentUnion3ContentWebSearchToolResultError(components.ContentWebSearchToolResultError{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch messagesMessageParamContentUnion3.Type { - case components.MessagesMessageParamContentUnion3TypeArrayOfAnthropicWebSearchResultBlockParam: - // messagesMessageParamContentUnion3.ArrayOfAnthropicWebSearchResultBlockParam is populated - case components.MessagesMessageParamContentUnion3TypeContentWebSearchToolResultError: - // messagesMessageParamContentUnion3.ContentWebSearchToolResultError is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion4.mdx b/client-sdks/go/api-reference/models/messagesmessageparamcontentunion4.mdx deleted file mode 100644 index 6bcc5ae9..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion4.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: MessagesMessageParamContentUnion4 - Go SDK -sidebarTitle: MessagesMessageParamContentUnion4 -description: MessagesMessageParamContentUnion4 type definition -seoTitle: MessagesMessageParamContentUnion4 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamcontentunion4 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion4 Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamContentUnion4 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion4%20-%20Go%20SDK&description=MessagesMessageParamContentUnion4%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicTextBlockParam - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4Text(components.AnthropicTextBlockParam{/* values here */}) -``` - -### AnthropicImageBlockParam - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4Image(components.AnthropicImageBlockParam{/* values here */}) -``` - -### AnthropicDocumentBlockParam - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4Document(components.AnthropicDocumentBlockParam{/* values here */}) -``` - -### ContentToolUse - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4ToolUse(components.ContentToolUse{/* values here */}) -``` - -### ContentToolResult - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4ToolResult(components.ContentToolResult{/* values here */}) -``` - -### ContentThinking - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4Thinking(components.ContentThinking{/* values here */}) -``` - -### ContentRedactedThinking - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4RedactedThinking(components.ContentRedactedThinking{/* values here */}) -``` - -### ContentServerToolUse - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4ServerToolUse(components.ContentServerToolUse{/* values here */}) -``` - -### ContentWebSearchToolResult - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4WebSearchToolResult(components.ContentWebSearchToolResult{/* values here */}) -``` - -### AnthropicSearchResultBlockParam - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4SearchResult(components.AnthropicSearchResultBlockParam{/* values here */}) -``` - -### ContentCompaction - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4Compaction(components.ContentCompaction{/* values here */}) -``` - -### MessagesAdvisorToolResultBlock - -```go lines -messagesMessageParamContentUnion4 := components.CreateMessagesMessageParamContentUnion4AdvisorToolResult(components.MessagesAdvisorToolResultBlock{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch messagesMessageParamContentUnion4.Type { - case components.MessagesMessageParamContentUnion4TypeText: - // messagesMessageParamContentUnion4.AnthropicTextBlockParam is populated - case components.MessagesMessageParamContentUnion4TypeImage: - // messagesMessageParamContentUnion4.AnthropicImageBlockParam is populated - case components.MessagesMessageParamContentUnion4TypeDocument: - // messagesMessageParamContentUnion4.AnthropicDocumentBlockParam is populated - case components.MessagesMessageParamContentUnion4TypeToolUse: - // messagesMessageParamContentUnion4.ContentToolUse is populated - case components.MessagesMessageParamContentUnion4TypeToolResult: - // messagesMessageParamContentUnion4.ContentToolResult is populated - case components.MessagesMessageParamContentUnion4TypeThinking: - // messagesMessageParamContentUnion4.ContentThinking is populated - case components.MessagesMessageParamContentUnion4TypeRedactedThinking: - // messagesMessageParamContentUnion4.ContentRedactedThinking is populated - case components.MessagesMessageParamContentUnion4TypeServerToolUse: - // messagesMessageParamContentUnion4.ContentServerToolUse is populated - case components.MessagesMessageParamContentUnion4TypeWebSearchToolResult: - // messagesMessageParamContentUnion4.ContentWebSearchToolResult is populated - case components.MessagesMessageParamContentUnion4TypeSearchResult: - // messagesMessageParamContentUnion4.AnthropicSearchResultBlockParam is populated - case components.MessagesMessageParamContentUnion4TypeCompaction: - // messagesMessageParamContentUnion4.ContentCompaction is populated - case components.MessagesMessageParamContentUnion4TypeAdvisorToolResult: - // messagesMessageParamContentUnion4.MessagesAdvisorToolResultBlock is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion5.mdx b/client-sdks/go/api-reference/models/messagesmessageparamcontentunion5.mdx deleted file mode 100644 index 5ddc252f..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamcontentunion5.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: MessagesMessageParamContentUnion5 - Go SDK -sidebarTitle: MessagesMessageParamContentUnion5 -description: MessagesMessageParamContentUnion5 type definition -seoTitle: MessagesMessageParamContentUnion5 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamcontentunion5 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion5 Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamContentUnion5 type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion5%20-%20Go%20SDK&description=MessagesMessageParamContentUnion5%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -messagesMessageParamContentUnion5 := components.CreateMessagesMessageParamContentUnion5Str(string{/* values here */}) -``` - -### - -```go lines -messagesMessageParamContentUnion5 := components.CreateMessagesMessageParamContentUnion5ArrayOfMessagesMessageParamContentUnion4([]components.MessagesMessageParamContentUnion4{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch messagesMessageParamContentUnion5.Type { - case components.MessagesMessageParamContentUnion5TypeStr: - // messagesMessageParamContentUnion5.Str is populated - case components.MessagesMessageParamContentUnion5TypeArrayOfMessagesMessageParamContentUnion4: - // messagesMessageParamContentUnion5.ArrayOfMessagesMessageParamContentUnion4 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamrole.mdx b/client-sdks/go/api-reference/models/messagesmessageparamrole.mdx deleted file mode 100644 index 967d1799..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamrole.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: MessagesMessageParamRole - Go SDK -sidebarTitle: MessagesMessageParamRole -description: MessagesMessageParamRole type definition -seoTitle: MessagesMessageParamRole Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamrole -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamRole Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamRole type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamRole%20-%20Go%20SDK&description=MessagesMessageParamRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MessagesMessageParamRoleUser - -// Open enum: custom values can be created with a direct type cast -custom := components.MessagesMessageParamRole("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `MessagesMessageParamRoleUser` | user | -| `MessagesMessageParamRoleAssistant` | assistant | -| `MessagesMessageParamRoleSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesmessageparamtypecompaction.mdx b/client-sdks/go/api-reference/models/messagesmessageparamtypecompaction.mdx deleted file mode 100644 index aecf6eef..00000000 --- a/client-sdks/go/api-reference/models/messagesmessageparamtypecompaction.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: MessagesMessageParamTypeCompaction - Go SDK -sidebarTitle: MessagesMessageParamTypeCompaction -description: MessagesMessageParamTypeCompaction type definition -seoTitle: MessagesMessageParamTypeCompaction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesmessageparamtypecompaction -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamTypeCompaction Type | OpenRouter Go SDK -'og:description': >- - MessagesMessageParamTypeCompaction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamTypeCompaction%20-%20Go%20SDK&description=MessagesMessageParamTypeCompaction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MessagesMessageParamTypeCompactionCompaction -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `MessagesMessageParamTypeCompactionCompaction` | compaction | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesoutputconfig.mdx b/client-sdks/go/api-reference/models/messagesoutputconfig.mdx deleted file mode 100644 index 13d6657b..00000000 --- a/client-sdks/go/api-reference/models/messagesoutputconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MessagesOutputConfig - Go SDK -sidebarTitle: MessagesOutputConfig -description: MessagesOutputConfig type definition -seoTitle: MessagesOutputConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/messagesoutputconfig' -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfig Type | OpenRouter Go SDK -'og:description': >- - MessagesOutputConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfig%20-%20Go%20SDK&description=MessagesOutputConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for controlling output behavior. Supports the effort parameter and structured output format. - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/messagesoutputconfigeffort.mdx b/client-sdks/go/api-reference/models/messagesoutputconfigeffort.mdx deleted file mode 100644 index 205ca19c..00000000 --- a/client-sdks/go/api-reference/models/messagesoutputconfigeffort.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: MessagesOutputConfigEffort - Go SDK -sidebarTitle: MessagesOutputConfigEffort -description: MessagesOutputConfigEffort type definition -seoTitle: MessagesOutputConfigEffort Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesoutputconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigEffort Type | OpenRouter Go SDK -'og:description': >- - MessagesOutputConfigEffort type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigEffort%20-%20Go%20SDK&description=MessagesOutputConfigEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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`. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MessagesOutputConfigEffortLow - -// Open enum: custom values can be created with a direct type cast -custom := components.MessagesOutputConfigEffort("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `MessagesOutputConfigEffortLow` | low | -| `MessagesOutputConfigEffortMedium` | medium | -| `MessagesOutputConfigEffortHigh` | high | -| `MessagesOutputConfigEffortXhigh` | xhigh | -| `MessagesOutputConfigEffortMax` | max | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesoutputconfigformat.mdx b/client-sdks/go/api-reference/models/messagesoutputconfigformat.mdx deleted file mode 100644 index 6406a346..00000000 --- a/client-sdks/go/api-reference/models/messagesoutputconfigformat.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MessagesOutputConfigFormat - Go SDK -sidebarTitle: MessagesOutputConfigFormat -description: MessagesOutputConfigFormat type definition -seoTitle: MessagesOutputConfigFormat Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesoutputconfigformat -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigFormat Type | OpenRouter Go SDK -'og:description': >- - MessagesOutputConfigFormat type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigFormat%20-%20Go%20SDK&description=MessagesOutputConfigFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Schema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesOutputConfigTypeJSONSchema](/client-sdks/go/api-reference/models/messagesoutputconfigtypejsonschema) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesoutputconfigtypejsonschema.mdx b/client-sdks/go/api-reference/models/messagesoutputconfigtypejsonschema.mdx deleted file mode 100644 index efedd99d..00000000 --- a/client-sdks/go/api-reference/models/messagesoutputconfigtypejsonschema.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: MessagesOutputConfigTypeJSONSchema - Go SDK -sidebarTitle: MessagesOutputConfigTypeJSONSchema -description: MessagesOutputConfigTypeJSONSchema type definition -seoTitle: MessagesOutputConfigTypeJSONSchema Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesoutputconfigtypejsonschema -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigTypeJSONSchema Type | OpenRouter Go SDK -'og:description': >- - MessagesOutputConfigTypeJSONSchema type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigTypeJSONSchema%20-%20Go%20SDK&description=MessagesOutputConfigTypeJSONSchema%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MessagesOutputConfigTypeJSONSchemaJSONSchema -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `MessagesOutputConfigTypeJSONSchemaJSONSchema` | json_schema | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesrequest.mdx b/client-sdks/go/api-reference/models/messagesrequest.mdx deleted file mode 100644 index a9a992f9..00000000 --- a/client-sdks/go/api-reference/models/messagesrequest.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: MessagesRequest - Go SDK -sidebarTitle: MessagesRequest -description: MessagesRequest type definition -seoTitle: MessagesRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/messagesrequest' -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequest Type | OpenRouter Go SDK -'og:description': >- - MessagesRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequest%20-%20Go%20SDK&description=MessagesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Request schema for Anthropic Messages API endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `ContextManagement` | optionalnullable.OptionalNullable[[components.ContextManagement](/client-sdks/go/api-reference/models/contextmanagement)] | :heavy_minus_sign: | N/A | | -| `MaxTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Messages` | [][components.MessagesMessageParam](/client-sdks/go/api-reference/models/messagesmessageparam) | :heavy_check_mark: | N/A | | -| `Metadata` | [*components.Metadata](/client-sdks/go/api-reference/models/metadata) | :heavy_minus_sign: | N/A | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Models` | []`string` | :heavy_minus_sign: | N/A | | -| `OutputConfig` | [*components.MessagesOutputConfig](/client-sdks/go/api-reference/models/messagesoutputconfig) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | `{"effort": "medium"}` | -| `Plugins` | [][components.MessagesRequestPlugin](/client-sdks/go/api-reference/models/messagesrequestplugin) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/speed)] | :heavy_minus_sign: | N/A | fast | -| `StopSequences` | []`string` | :heavy_minus_sign: | N/A | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](/client-sdks/go/api-reference/models/stopservertoolswhencondition) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"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](/client-sdks/go/api-reference/models/system) | :heavy_minus_sign: | N/A | | -| `Temperature` | `*float64` | :heavy_minus_sign: | N/A | | -| `Thinking` | [*components.Thinking](/client-sdks/go/api-reference/models/thinking) | :heavy_minus_sign: | N/A | | -| `ToolChoice` | [*components.ToolChoice](/client-sdks/go/api-reference/models/toolchoice) | :heavy_minus_sign: | N/A | | -| `Tools` | [][components.MessagesRequestToolUnion](/client-sdks/go/api-reference/models/messagesrequesttoolunion) | :heavy_minus_sign: | N/A | | -| `TopK` | `*int64` | :heavy_minus_sign: | N/A | | -| `TopP` | `*float64` | :heavy_minus_sign: | N/A | | -| `Trace` | [*components.TraceConfig](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/messagesrequestplugin.mdx b/client-sdks/go/api-reference/models/messagesrequestplugin.mdx deleted file mode 100644 index 543db8af..00000000 --- a/client-sdks/go/api-reference/models/messagesrequestplugin.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: MessagesRequestPlugin - Go SDK -sidebarTitle: MessagesRequestPlugin -description: MessagesRequestPlugin type definition -seoTitle: MessagesRequestPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/messagesrequestplugin' -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestPlugin Type | OpenRouter Go SDK -'og:description': >- - MessagesRequestPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestPlugin%20-%20Go%20SDK&description=MessagesRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AutoRouterPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginAutoRouter(components.AutoRouterPlugin{/* values here */}) -``` - -### ContextCompressionPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginContextCompression(components.ContextCompressionPlugin{/* values here */}) -``` - -### FileParserPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginFileParser(components.FileParserPlugin{/* values here */}) -``` - -### FusionPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginFusion(components.FusionPlugin{/* values here */}) -``` - -### ModerationPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginModeration(components.ModerationPlugin{/* values here */}) -``` - -### ParetoRouterPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginParetoRouter(components.ParetoRouterPlugin{/* values here */}) -``` - -### ResponseHealingPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginResponseHealing(components.ResponseHealingPlugin{/* values here */}) -``` - -### WebSearchPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginWeb(components.WebSearchPlugin{/* values here */}) -``` - -### WebFetchPlugin - -```go lines -messagesRequestPlugin := components.CreateMessagesRequestPluginWebFetch(components.WebFetchPlugin{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch messagesRequestPlugin.Type { - case components.MessagesRequestPluginTypeAutoRouter: - // messagesRequestPlugin.AutoRouterPlugin is populated - case components.MessagesRequestPluginTypeContextCompression: - // messagesRequestPlugin.ContextCompressionPlugin is populated - case components.MessagesRequestPluginTypeFileParser: - // messagesRequestPlugin.FileParserPlugin is populated - case components.MessagesRequestPluginTypeFusion: - // messagesRequestPlugin.FusionPlugin is populated - case components.MessagesRequestPluginTypeModeration: - // messagesRequestPlugin.ModerationPlugin is populated - case components.MessagesRequestPluginTypeParetoRouter: - // messagesRequestPlugin.ParetoRouterPlugin is populated - case components.MessagesRequestPluginTypeResponseHealing: - // messagesRequestPlugin.ResponseHealingPlugin is populated - case components.MessagesRequestPluginTypeWeb: - // messagesRequestPlugin.WebSearchPlugin is populated - case components.MessagesRequestPluginTypeWebFetch: - // messagesRequestPlugin.WebFetchPlugin is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesrequesttool.mdx b/client-sdks/go/api-reference/models/messagesrequesttool.mdx deleted file mode 100644 index 48f9ee02..00000000 --- a/client-sdks/go/api-reference/models/messagesrequesttool.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MessagesRequestTool - Go SDK -sidebarTitle: MessagesRequestTool -description: MessagesRequestTool type definition -seoTitle: MessagesRequestTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/messagesrequesttool' -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestTool Type | OpenRouter Go SDK -'og:description': >- - MessagesRequestTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestTool%20-%20Go%20SDK&description=MessagesRequestTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/messagesrequesttoolunion.mdx b/client-sdks/go/api-reference/models/messagesrequesttoolunion.mdx deleted file mode 100644 index af415528..00000000 --- a/client-sdks/go/api-reference/models/messagesrequesttoolunion.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: MessagesRequestToolUnion - Go SDK -sidebarTitle: MessagesRequestToolUnion -description: MessagesRequestToolUnion type definition -seoTitle: MessagesRequestToolUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/messagesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestToolUnion Type | OpenRouter Go SDK -'og:description': >- - MessagesRequestToolUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestToolUnion%20-%20Go%20SDK&description=MessagesRequestToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ToolCustom - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolCustom(components.ToolCustom{/* values here */}) -``` - -### ToolBash20250124 - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolBash20250124(components.ToolBash20250124{/* values here */}) -``` - -### ToolTextEditor20250124 - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolTextEditor20250124(components.ToolTextEditor20250124{/* values here */}) -``` - -### ToolWebSearch20250305 - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolWebSearch20250305(components.ToolWebSearch20250305{/* values here */}) -``` - -### ToolWebSearch20260209 - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolWebSearch20260209(components.ToolWebSearch20260209{/* values here */}) -``` - -### ToolAdvisor20260301 - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionToolAdvisor20260301(components.ToolAdvisor20260301{/* values here */}) -``` - -### DatetimeServerTool - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionDatetimeServerTool(components.DatetimeServerTool{/* values here */}) -``` - -### ImageGenerationServerToolOpenRouter - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionImageGenerationServerToolOpenRouter(components.ImageGenerationServerToolOpenRouter{/* values here */}) -``` - -### ChatSearchModelsServerTool - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionChatSearchModelsServerTool(components.ChatSearchModelsServerTool{/* values here */}) -``` - -### WebFetchServerTool - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionWebFetchServerTool(components.WebFetchServerTool{/* values here */}) -``` - -### OpenRouterWebSearchServerTool - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionOpenRouterWebSearchServerTool(components.OpenRouterWebSearchServerTool{/* values here */}) -``` - -### MessagesRequestTool - -```go lines -messagesRequestToolUnion := components.CreateMessagesRequestToolUnionMessagesRequestTool(components.MessagesRequestTool{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch messagesRequestToolUnion.Type { - case components.MessagesRequestToolUnionTypeToolCustom: - // messagesRequestToolUnion.ToolCustom is populated - case components.MessagesRequestToolUnionTypeToolBash20250124: - // messagesRequestToolUnion.ToolBash20250124 is populated - case components.MessagesRequestToolUnionTypeToolTextEditor20250124: - // messagesRequestToolUnion.ToolTextEditor20250124 is populated - case components.MessagesRequestToolUnionTypeToolWebSearch20250305: - // messagesRequestToolUnion.ToolWebSearch20250305 is populated - case components.MessagesRequestToolUnionTypeToolWebSearch20260209: - // messagesRequestToolUnion.ToolWebSearch20260209 is populated - case components.MessagesRequestToolUnionTypeToolAdvisor20260301: - // messagesRequestToolUnion.ToolAdvisor20260301 is populated - case components.MessagesRequestToolUnionTypeDatetimeServerTool: - // messagesRequestToolUnion.DatetimeServerTool is populated - case components.MessagesRequestToolUnionTypeImageGenerationServerToolOpenRouter: - // messagesRequestToolUnion.ImageGenerationServerToolOpenRouter is populated - case components.MessagesRequestToolUnionTypeChatSearchModelsServerTool: - // messagesRequestToolUnion.ChatSearchModelsServerTool is populated - case components.MessagesRequestToolUnionTypeWebFetchServerTool: - // messagesRequestToolUnion.WebFetchServerTool is populated - case components.MessagesRequestToolUnionTypeOpenRouterWebSearchServerTool: - // messagesRequestToolUnion.OpenRouterWebSearchServerTool is populated - case components.MessagesRequestToolUnionTypeMessagesRequestTool: - // messagesRequestToolUnion.MessagesRequestTool is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/metadata.mdx b/client-sdks/go/api-reference/models/metadata.mdx deleted file mode 100644 index 4332dfef..00000000 --- a/client-sdks/go/api-reference/models/metadata.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Metadata - Go SDK -sidebarTitle: Metadata -description: Metadata type definition -seoTitle: Metadata Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/metadata' -'og:site_name': OpenRouter Documentation -'og:title': Metadata Type | OpenRouter Go SDK -'og:description': >- - Metadata type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Metadata%20-%20Go%20SDK&description=Metadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `UserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/metadatalevel.mdx b/client-sdks/go/api-reference/models/metadatalevel.mdx deleted file mode 100644 index 0055bc44..00000000 --- a/client-sdks/go/api-reference/models/metadatalevel.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: MetadataLevel - Go SDK -sidebarTitle: MetadataLevel -description: MetadataLevel type definition -seoTitle: MetadataLevel Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/metadatalevel' -'og:site_name': OpenRouter Documentation -'og:title': MetadataLevel Type | OpenRouter Go SDK -'og:description': >- - MetadataLevel type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MetadataLevel%20-%20Go%20SDK&description=MetadataLevel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Opt-in level for surfacing routing metadata on the response under `openrouter_metadata`. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MetadataLevelDisabled - -// Open enum: custom values can be created with a direct type cast -custom := components.MetadataLevel("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `MetadataLevelDisabled` | disabled | -| `MetadataLevelEnabled` | enabled | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/method.mdx b/client-sdks/go/api-reference/models/method.mdx deleted file mode 100644 index 5667d0f4..00000000 --- a/client-sdks/go/api-reference/models/method.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Method - Go SDK -sidebarTitle: Method -description: Method type definition -seoTitle: Method Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/method' -'og:site_name': OpenRouter Documentation -'og:title': Method Type | OpenRouter Go SDK -'og:description': >- - Method type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Method%20-%20Go%20SDK&description=Method%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.MethodPost - -// Open enum: custom values can be created with a direct type cast -custom := components.Method("custom_value") -``` - -## Values - -| Name | Value | -| ------------ | ------------ | -| `MethodPost` | POST | -| `MethodPut` | PUT | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modality.mdx b/client-sdks/go/api-reference/models/modality.mdx deleted file mode 100644 index df0e691f..00000000 --- a/client-sdks/go/api-reference/models/modality.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Modality - Go SDK -sidebarTitle: Modality -description: Modality type definition -seoTitle: Modality Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modality' -'og:site_name': OpenRouter Documentation -'og:title': Modality Type | OpenRouter Go SDK -'og:description': >- - Modality type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Modality%20-%20Go%20SDK&description=Modality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModalityText - -// Open enum: custom values can be created with a direct type cast -custom := components.Modality("custom_value") -``` - -## Values - -| Name | Value | -| --------------- | --------------- | -| `ModalityText` | text | -| `ModalityImage` | image | -| `ModalityAudio` | audio | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/mode.mdx b/client-sdks/go/api-reference/models/mode.mdx deleted file mode 100644 index 29e0ecae..00000000 --- a/client-sdks/go/api-reference/models/mode.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Mode - Go SDK -sidebarTitle: Mode -description: Mode type definition -seoTitle: Mode Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/mode' -'og:site_name': OpenRouter Documentation -'og:title': Mode Type | OpenRouter Go SDK -'og:description': >- - Mode type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Mode%20-%20Go%20SDK&description=Mode%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ModeAuto - -```go lines -mode := components.CreateModeModeAuto(components.ModeAuto{/* values here */}) -``` - -### ModeRequired - -```go lines -mode := components.CreateModeModeRequired(components.ModeRequired{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch mode.Type { - case components.ModeTypeModeAuto: - // mode.ModeAuto is populated - case components.ModeTypeModeRequired: - // mode.ModeRequired is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modeauto.mdx b/client-sdks/go/api-reference/models/modeauto.mdx deleted file mode 100644 index 5ae347fb..00000000 --- a/client-sdks/go/api-reference/models/modeauto.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ModeAuto - Go SDK -sidebarTitle: ModeAuto -description: ModeAuto type definition -seoTitle: ModeAuto Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modeauto' -'og:site_name': OpenRouter Documentation -'og:title': ModeAuto Type | OpenRouter Go SDK -'og:description': >- - ModeAuto type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeAuto%20-%20Go%20SDK&description=ModeAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModeAutoAuto -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `ModeAutoAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/model.mdx b/client-sdks/go/api-reference/models/model.mdx deleted file mode 100644 index 1aa434c6..00000000 --- a/client-sdks/go/api-reference/models/model.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Model - Go SDK -sidebarTitle: Model -description: Model type definition -seoTitle: Model Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/model' -'og:site_name': OpenRouter Documentation -'og:title': Model Type | OpenRouter Go SDK -'og:description': >- - Model type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Model%20-%20Go%20SDK&description=Model%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Information about an AI model available on OpenRouter - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.ModelArchitecture](/client-sdks/go/api-reference/models/modelarchitecture) | :heavy_check_mark: | Model architecture information | `{"input_modalities": ["text"],"instruct_type": "chatml","modality": "text-\u003etext","output_modalities": ["text"],"tokenizer": "GPT"}` | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/perrequestlimits) | :heavy_check_mark: | Per-request token limits | `{"completion_tokens": 1000,"prompt_tokens": 1000}` | -| `Pricing` | [components.PublicPricing](/client-sdks/go/api-reference/models/publicpricing) | :heavy_check_mark: | Pricing information for the model | `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}` | -| `SupportedParameters` | [][components.Parameter](/client-sdks/go/api-reference/models/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. | `` | -| `TopProvider` | [components.TopProviderInfo](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/modelarchitecture.mdx b/client-sdks/go/api-reference/models/modelarchitecture.mdx deleted file mode 100644 index b909dbf0..00000000 --- a/client-sdks/go/api-reference/models/modelarchitecture.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ModelArchitecture - Go SDK -sidebarTitle: ModelArchitecture -description: ModelArchitecture type definition -seoTitle: ModelArchitecture Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modelarchitecture' -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitecture Type | OpenRouter Go SDK -'og:description': >- - ModelArchitecture type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitecture%20-%20Go%20SDK&description=ModelArchitecture%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `InputModalities` | [][components.InputModality](/client-sdks/go/api-reference/models/inputmodality) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | optionalnullable.OptionalNullable[[components.ModelArchitectureInstructType](/client-sdks/go/api-reference/models/modelarchitectureinstructtype)] | :heavy_minus_sign: | Instruction format type | chatml | -| `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text->text | -| `OutputModalities` | [][components.OutputModality](/client-sdks/go/api-reference/models/outputmodality) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](/client-sdks/go/api-reference/models/modelgroup) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelarchitectureinstructtype.mdx b/client-sdks/go/api-reference/models/modelarchitectureinstructtype.mdx deleted file mode 100644 index ee9013b7..00000000 --- a/client-sdks/go/api-reference/models/modelarchitectureinstructtype.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ModelArchitectureInstructType - Go SDK -sidebarTitle: ModelArchitectureInstructType -description: ModelArchitectureInstructType type definition -seoTitle: ModelArchitectureInstructType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/modelarchitectureinstructtype -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitectureInstructType Type | OpenRouter Go SDK -'og:description': >- - ModelArchitectureInstructType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitectureInstructType%20-%20Go%20SDK&description=ModelArchitectureInstructType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModelArchitectureInstructTypeNone - -// Open enum: custom values can be created with a direct type cast -custom := components.ModelArchitectureInstructType("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `ModelArchitectureInstructTypeNone` | none | -| `ModelArchitectureInstructTypeAiroboros` | airoboros | -| `ModelArchitectureInstructTypeAlpaca` | alpaca | -| `ModelArchitectureInstructTypeAlpacaModif` | alpaca-modif | -| `ModelArchitectureInstructTypeChatml` | chatml | -| `ModelArchitectureInstructTypeClaude` | claude | -| `ModelArchitectureInstructTypeCodeLlama` | code-llama | -| `ModelArchitectureInstructTypeGemma` | gemma | -| `ModelArchitectureInstructTypeLlama2` | llama2 | -| `ModelArchitectureInstructTypeLlama3` | llama3 | -| `ModelArchitectureInstructTypeMistral` | mistral | -| `ModelArchitectureInstructTypeNemotron` | nemotron | -| `ModelArchitectureInstructTypeNeural` | neural | -| `ModelArchitectureInstructTypeOpenchat` | openchat | -| `ModelArchitectureInstructTypePhi3` | phi3 | -| `ModelArchitectureInstructTypeRwkv` | rwkv | -| `ModelArchitectureInstructTypeVicuna` | vicuna | -| `ModelArchitectureInstructTypeZephyr` | zephyr | -| `ModelArchitectureInstructTypeDeepseekR1` | deepseek-r1 | -| `ModelArchitectureInstructTypeDeepseekV31` | deepseek-v3.1 | -| `ModelArchitectureInstructTypeQwq` | qwq | -| `ModelArchitectureInstructTypeQwen3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelenum.mdx b/client-sdks/go/api-reference/models/modelenum.mdx deleted file mode 100644 index ad0a69e1..00000000 --- a/client-sdks/go/api-reference/models/modelenum.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ModelEnum - Go SDK -sidebarTitle: ModelEnum -description: ModelEnum type definition -seoTitle: ModelEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modelenum' -'og:site_name': OpenRouter Documentation -'og:title': ModelEnum Type | OpenRouter Go SDK -'og:description': >- - ModelEnum type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelEnum%20-%20Go%20SDK&description=ModelEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModelEnumGptImage1 - -// Open enum: custom values can be created with a direct type cast -custom := components.ModelEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ModelEnumGptImage1` | gpt-image-1 | -| `ModelEnumGptImage1Mini` | gpt-image-1-mini | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelgroup.mdx b/client-sdks/go/api-reference/models/modelgroup.mdx deleted file mode 100644 index 1e139f94..00000000 --- a/client-sdks/go/api-reference/models/modelgroup.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: ModelGroup - Go SDK -sidebarTitle: ModelGroup -description: ModelGroup type definition -seoTitle: ModelGroup Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modelgroup' -'og:site_name': OpenRouter Documentation -'og:title': ModelGroup Type | OpenRouter Go SDK -'og:description': >- - ModelGroup type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelGroup%20-%20Go%20SDK&description=ModelGroup%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModelGroupRouter - -// Open enum: custom values can be created with a direct type cast -custom := components.ModelGroup("custom_value") -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `ModelGroupRouter` | Router | -| `ModelGroupMedia` | Media | -| `ModelGroupOther` | Other | -| `ModelGroupGpt` | GPT | -| `ModelGroupClaude` | Claude | -| `ModelGroupGemini` | Gemini | -| `ModelGroupGemma` | Gemma | -| `ModelGroupGrok` | Grok | -| `ModelGroupCohere` | Cohere | -| `ModelGroupNova` | Nova | -| `ModelGroupQwen` | Qwen | -| `ModelGroupYi` | Yi | -| `ModelGroupDeepSeek` | DeepSeek | -| `ModelGroupMistral` | Mistral | -| `ModelGroupLlama2` | Llama2 | -| `ModelGroupLlama3` | Llama3 | -| `ModelGroupLlama4` | Llama4 | -| `ModelGroupPaLm` | PaLM | -| `ModelGroupRwkv` | RWKV | -| `ModelGroupQwen3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modellinks.mdx b/client-sdks/go/api-reference/models/modellinks.mdx deleted file mode 100644 index 9489cb74..00000000 --- a/client-sdks/go/api-reference/models/modellinks.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModelLinks - Go SDK -sidebarTitle: ModelLinks -description: ModelLinks type definition -seoTitle: ModelLinks Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modellinks' -'og:site_name': OpenRouter Documentation -'og:title': ModelLinks Type | OpenRouter Go SDK -'og:description': >- - ModelLinks type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelLinks%20-%20Go%20SDK&description=ModelLinks%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Related API endpoints and resources for this model. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `Details` | `string` | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelscountresponse.mdx b/client-sdks/go/api-reference/models/modelscountresponse.mdx deleted file mode 100644 index c85df5c2..00000000 --- a/client-sdks/go/api-reference/models/modelscountresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModelsCountResponse - Go SDK -sidebarTitle: ModelsCountResponse -description: ModelsCountResponse type definition -seoTitle: ModelsCountResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modelscountresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponse Type | OpenRouter Go SDK -'og:description': >- - ModelsCountResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponse%20-%20Go%20SDK&description=ModelsCountResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [components.ModelsCountResponseData](/client-sdks/go/api-reference/models/modelscountresponsedata) | :heavy_check_mark: | Model count data | `{"count": 150}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelscountresponsedata.mdx b/client-sdks/go/api-reference/models/modelscountresponsedata.mdx deleted file mode 100644 index f6b3ba6d..00000000 --- a/client-sdks/go/api-reference/models/modelscountresponsedata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ModelsCountResponseData - Go SDK -sidebarTitle: ModelsCountResponseData -description: ModelsCountResponseData type definition -seoTitle: ModelsCountResponseData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/modelscountresponsedata -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponseData Type | OpenRouter Go SDK -'og:description': >- - ModelsCountResponseData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponseData%20-%20Go%20SDK&description=ModelsCountResponseData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `Count` | `int64` | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/modelslistresponse.mdx b/client-sdks/go/api-reference/models/modelslistresponse.mdx deleted file mode 100644 index 910d6888..00000000 --- a/client-sdks/go/api-reference/models/modelslistresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModelsListResponse - Go SDK -sidebarTitle: ModelsListResponse -description: ModelsListResponse type definition -seoTitle: ModelsListResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/modelslistresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsListResponse Type | OpenRouter Go SDK -'og:description': >- - ModelsListResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsListResponse%20-%20Go%20SDK&description=ModelsListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -List of available models - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [][components.Model](/client-sdks/go/api-reference/models/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-5.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}`
\}
] | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/moderation.mdx b/client-sdks/go/api-reference/models/moderation.mdx deleted file mode 100644 index b933d25c..00000000 --- a/client-sdks/go/api-reference/models/moderation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Moderation - Go SDK -sidebarTitle: Moderation -description: Moderation type definition -seoTitle: Moderation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/moderation' -'og:site_name': OpenRouter Documentation -'og:title': Moderation Type | OpenRouter Go SDK -'og:description': >- - Moderation type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Moderation%20-%20Go%20SDK&description=Moderation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModerationAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.Moderation("custom_value") -``` - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `ModerationAuto` | auto | -| `ModerationLow` | low | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/moderationplugin.mdx b/client-sdks/go/api-reference/models/moderationplugin.mdx deleted file mode 100644 index 12924d41..00000000 --- a/client-sdks/go/api-reference/models/moderationplugin.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ModerationPlugin - Go SDK -sidebarTitle: ModerationPlugin -description: ModerationPlugin type definition -seoTitle: ModerationPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/moderationplugin' -'og:site_name': OpenRouter Documentation -'og:title': ModerationPlugin Type | OpenRouter Go SDK -'og:description': >- - ModerationPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModerationPlugin%20-%20Go%20SDK&description=ModerationPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ID` | [components.ModerationPluginID](/client-sdks/go/api-reference/models/moderationpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/moderationpluginid.mdx b/client-sdks/go/api-reference/models/moderationpluginid.mdx deleted file mode 100644 index d50f7e07..00000000 --- a/client-sdks/go/api-reference/models/moderationpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ModerationPluginID - Go SDK -sidebarTitle: ModerationPluginID -description: ModerationPluginID type definition -seoTitle: ModerationPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/moderationpluginid' -'og:site_name': OpenRouter Documentation -'og:title': ModerationPluginID Type | OpenRouter Go SDK -'og:description': >- - ModerationPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModerationPluginID%20-%20Go%20SDK&description=ModerationPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModerationPluginIDModeration -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ModerationPluginIDModeration` | moderation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/moderequired.mdx b/client-sdks/go/api-reference/models/moderequired.mdx deleted file mode 100644 index dfa0e57e..00000000 --- a/client-sdks/go/api-reference/models/moderequired.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ModeRequired - Go SDK -sidebarTitle: ModeRequired -description: ModeRequired type definition -seoTitle: ModeRequired Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/moderequired' -'og:site_name': OpenRouter Documentation -'og:title': ModeRequired Type | OpenRouter Go SDK -'og:description': >- - ModeRequired type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeRequired%20-%20Go%20SDK&description=ModeRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ModeRequiredRequired -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `ModeRequiredRequired` | required | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/multimodalmedia.mdx b/client-sdks/go/api-reference/models/multimodalmedia.mdx deleted file mode 100644 index 52e3af59..00000000 --- a/client-sdks/go/api-reference/models/multimodalmedia.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MultimodalMedia - Go SDK -sidebarTitle: MultimodalMedia -description: MultimodalMedia type definition -seoTitle: MultimodalMedia Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/multimodalmedia' -'og:site_name': OpenRouter Documentation -'og:title': MultimodalMedia Type | OpenRouter Go SDK -'og:description': >- - MultimodalMedia type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MultimodalMedia%20-%20Go%20SDK&description=MultimodalMedia%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Data` | `string` | :heavy_check_mark: | N/A | -| `Format` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/nameadvisor.mdx b/client-sdks/go/api-reference/models/nameadvisor.mdx deleted file mode 100644 index 2e45aff5..00000000 --- a/client-sdks/go/api-reference/models/nameadvisor.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NameAdvisor - Go SDK -sidebarTitle: NameAdvisor -description: NameAdvisor type definition -seoTitle: NameAdvisor Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/nameadvisor' -'og:site_name': OpenRouter Documentation -'og:title': NameAdvisor Type | OpenRouter Go SDK -'og:description': >- - NameAdvisor type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameAdvisor%20-%20Go%20SDK&description=NameAdvisor%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.NameAdvisorAdvisor -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `NameAdvisorAdvisor` | advisor | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/namebash.mdx b/client-sdks/go/api-reference/models/namebash.mdx deleted file mode 100644 index 501fc7c4..00000000 --- a/client-sdks/go/api-reference/models/namebash.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NameBash - Go SDK -sidebarTitle: NameBash -description: NameBash type definition -seoTitle: NameBash Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/namebash' -'og:site_name': OpenRouter Documentation -'og:title': NameBash Type | OpenRouter Go SDK -'og:description': >- - NameBash type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameBash%20-%20Go%20SDK&description=NameBash%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.NameBashBash -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `NameBashBash` | bash | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/namestrreplaceeditor.mdx b/client-sdks/go/api-reference/models/namestrreplaceeditor.mdx deleted file mode 100644 index 497f97b7..00000000 --- a/client-sdks/go/api-reference/models/namestrreplaceeditor.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NameStrReplaceEditor - Go SDK -sidebarTitle: NameStrReplaceEditor -description: NameStrReplaceEditor type definition -seoTitle: NameStrReplaceEditor Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/namestrreplaceeditor' -'og:site_name': OpenRouter Documentation -'og:title': NameStrReplaceEditor Type | OpenRouter Go SDK -'og:description': >- - NameStrReplaceEditor type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameStrReplaceEditor%20-%20Go%20SDK&description=NameStrReplaceEditor%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.NameStrReplaceEditorStrReplaceEditor -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `NameStrReplaceEditorStrReplaceEditor` | str_replace_editor | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/namewebsearch1.mdx b/client-sdks/go/api-reference/models/namewebsearch1.mdx deleted file mode 100644 index 01d2da31..00000000 --- a/client-sdks/go/api-reference/models/namewebsearch1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NameWebSearch1 - Go SDK -sidebarTitle: NameWebSearch1 -description: NameWebSearch1 type definition -seoTitle: NameWebSearch1 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/namewebsearch1' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch1 Type | OpenRouter Go SDK -'og:description': >- - NameWebSearch1 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch1%20-%20Go%20SDK&description=NameWebSearch1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.NameWebSearch1WebSearch -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `NameWebSearch1WebSearch` | web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/namewebsearch2.mdx b/client-sdks/go/api-reference/models/namewebsearch2.mdx deleted file mode 100644 index 4c42255c..00000000 --- a/client-sdks/go/api-reference/models/namewebsearch2.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NameWebSearch2 - Go SDK -sidebarTitle: NameWebSearch2 -description: NameWebSearch2 type definition -seoTitle: NameWebSearch2 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/namewebsearch2' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch2 Type | OpenRouter Go SDK -'og:description': >- - NameWebSearch2 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch2%20-%20Go%20SDK&description=NameWebSearch2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.NameWebSearch2WebSearch -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `NameWebSearch2WebSearch` | web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/never.mdx b/client-sdks/go/api-reference/models/never.mdx deleted file mode 100644 index 2e79f6c7..00000000 --- a/client-sdks/go/api-reference/models/never.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Never - Go SDK -sidebarTitle: Never -description: Never type definition -seoTitle: Never Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/never' -'og:site_name': OpenRouter Documentation -'og:title': Never Type | OpenRouter Go SDK -'og:description': >- - Never type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Never%20-%20Go%20SDK&description=Never%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `ToolNames` | []`string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/notfoundresponseerror.mdx b/client-sdks/go/api-reference/models/notfoundresponseerror.mdx deleted file mode 100644 index be3e9dbf..00000000 --- a/client-sdks/go/api-reference/models/notfoundresponseerror.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: NotFoundResponseError - Go SDK -sidebarTitle: NotFoundResponseError -description: NotFoundResponseError type definition -seoTitle: NotFoundResponseError Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/notfoundresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseError Type | OpenRouter Go SDK -'og:description': >- - NotFoundResponseError type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseError%20-%20Go%20SDK&description=NotFoundResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Not Found - Resource does not exist - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.NotFoundResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/notfoundresponseerrordata.mdx b/client-sdks/go/api-reference/models/notfoundresponseerrordata.mdx deleted file mode 100644 index e4df32f4..00000000 --- a/client-sdks/go/api-reference/models/notfoundresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: NotFoundResponseErrorData - Go SDK -sidebarTitle: NotFoundResponseErrorData -description: NotFoundResponseErrorData type definition -seoTitle: NotFoundResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/notfoundresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - NotFoundResponseErrorData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseErrorData%20-%20Go%20SDK&description=NotFoundResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for NotFoundResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityarizedestination.mdx b/client-sdks/go/api-reference/models/observabilityarizedestination.mdx deleted file mode 100644 index d750f1b4..00000000 --- a/client-sdks/go/api-reference/models/observabilityarizedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityArizeDestination - Go SDK -sidebarTitle: ObservabilityArizeDestination -description: ObservabilityArizeDestination type definition -seoTitle: ObservabilityArizeDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityarizedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityArizeDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestination%20-%20Go%20SDK&description=ObservabilityArizeDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityArizeDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityarizedestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityarizedestinationconfig.mdx deleted file mode 100644 index 4a9172b2..00000000 --- a/client-sdks/go/api-reference/models/observabilityarizedestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityArizeDestinationConfig - Go SDK -sidebarTitle: ObservabilityArizeDestinationConfig -description: ObservabilityArizeDestinationConfig type definition -seoTitle: ObservabilityArizeDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityarizedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityArizeDestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestinationConfig%20-%20Go%20SDK&description=ObservabilityArizeDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ModelID` | `string` | :heavy_check_mark: | N/A | -| `SpaceKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityarizedestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityarizedestinationtype.mdx deleted file mode 100644 index 3956dcbc..00000000 --- a/client-sdks/go/api-reference/models/observabilityarizedestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityArizeDestinationType - Go SDK -sidebarTitle: ObservabilityArizeDestinationType -description: ObservabilityArizeDestinationType type definition -seoTitle: ObservabilityArizeDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityarizedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityArizeDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestinationType%20-%20Go%20SDK&description=ObservabilityArizeDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityArizeDestinationTypeArize -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `ObservabilityArizeDestinationTypeArize` | arize | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitybraintrustdestination.mdx b/client-sdks/go/api-reference/models/observabilitybraintrustdestination.mdx deleted file mode 100644 index a7ab36d1..00000000 --- a/client-sdks/go/api-reference/models/observabilitybraintrustdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityBraintrustDestination - Go SDK -sidebarTitle: ObservabilityBraintrustDestination -description: ObservabilityBraintrustDestination type definition -seoTitle: ObservabilityBraintrustDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitybraintrustdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityBraintrustDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestination%20-%20Go%20SDK&description=ObservabilityBraintrustDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityBraintrustDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitybraintrustdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitybraintrustdestinationconfig.mdx deleted file mode 100644 index f57dca36..00000000 --- a/client-sdks/go/api-reference/models/observabilitybraintrustdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityBraintrustDestinationConfig - Go SDK -sidebarTitle: ObservabilityBraintrustDestinationConfig -description: ObservabilityBraintrustDestinationConfig type definition -seoTitle: ObservabilityBraintrustDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitybraintrustdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityBraintrustDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestinationConfig%20-%20Go%20SDK&description=ObservabilityBraintrustDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ProjectID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitybraintrustdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitybraintrustdestinationtype.mdx deleted file mode 100644 index 9868b0f3..00000000 --- a/client-sdks/go/api-reference/models/observabilitybraintrustdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityBraintrustDestinationType - Go SDK -sidebarTitle: ObservabilityBraintrustDestinationType -description: ObservabilityBraintrustDestinationType type definition -seoTitle: ObservabilityBraintrustDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitybraintrustdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityBraintrustDestinationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestinationType%20-%20Go%20SDK&description=ObservabilityBraintrustDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityBraintrustDestinationTypeBraintrust -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `ObservabilityBraintrustDestinationTypeBraintrust` | braintrust | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityclickhousedestination.mdx b/client-sdks/go/api-reference/models/observabilityclickhousedestination.mdx deleted file mode 100644 index ea435cea..00000000 --- a/client-sdks/go/api-reference/models/observabilityclickhousedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityClickhouseDestination - Go SDK -sidebarTitle: ObservabilityClickhouseDestination -description: ObservabilityClickhouseDestination type definition -seoTitle: ObservabilityClickhouseDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityclickhousedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityClickhouseDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestination%20-%20Go%20SDK&description=ObservabilityClickhouseDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityClickhouseDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityclickhousedestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityclickhousedestinationconfig.mdx deleted file mode 100644 index 0e42bf1e..00000000 --- a/client-sdks/go/api-reference/models/observabilityclickhousedestinationconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ObservabilityClickhouseDestinationConfig - Go SDK -sidebarTitle: ObservabilityClickhouseDestinationConfig -description: ObservabilityClickhouseDestinationConfig type definition -seoTitle: ObservabilityClickhouseDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityclickhousedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityClickhouseDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestinationConfig%20-%20Go%20SDK&description=ObservabilityClickhouseDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Database` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Host` | `string` | :heavy_check_mark: | N/A | -| `Password` | `string` | :heavy_check_mark: | N/A | -| `Table` | `*string` | :heavy_minus_sign: | N/A | -| `Username` | `string` | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityclickhousedestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityclickhousedestinationtype.mdx deleted file mode 100644 index f8cbf1e5..00000000 --- a/client-sdks/go/api-reference/models/observabilityclickhousedestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityClickhouseDestinationType - Go SDK -sidebarTitle: ObservabilityClickhouseDestinationType -description: ObservabilityClickhouseDestinationType type definition -seoTitle: ObservabilityClickhouseDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityclickhousedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityClickhouseDestinationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestinationType%20-%20Go%20SDK&description=ObservabilityClickhouseDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityClickhouseDestinationTypeClickhouse -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `ObservabilityClickhouseDestinationTypeClickhouse` | clickhouse | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitydatadogdestination.mdx b/client-sdks/go/api-reference/models/observabilitydatadogdestination.mdx deleted file mode 100644 index 2285f6e5..00000000 --- a/client-sdks/go/api-reference/models/observabilitydatadogdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityDatadogDestination - Go SDK -sidebarTitle: ObservabilityDatadogDestination -description: ObservabilityDatadogDestination type definition -seoTitle: ObservabilityDatadogDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitydatadogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityDatadogDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestination%20-%20Go%20SDK&description=ObservabilityDatadogDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityDatadogDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitydatadogdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitydatadogdestinationconfig.mdx deleted file mode 100644 index 35124563..00000000 --- a/client-sdks/go/api-reference/models/observabilitydatadogdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityDatadogDestinationConfig - Go SDK -sidebarTitle: ObservabilityDatadogDestinationConfig -description: ObservabilityDatadogDestinationConfig type definition -seoTitle: ObservabilityDatadogDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitydatadogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityDatadogDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestinationConfig%20-%20Go%20SDK&description=ObservabilityDatadogDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `MlApp` | `string` | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `URL` | `*string` | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitydatadogdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitydatadogdestinationtype.mdx deleted file mode 100644 index 80eed371..00000000 --- a/client-sdks/go/api-reference/models/observabilitydatadogdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityDatadogDestinationType - Go SDK -sidebarTitle: ObservabilityDatadogDestinationType -description: ObservabilityDatadogDestinationType type definition -seoTitle: ObservabilityDatadogDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitydatadogdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityDatadogDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestinationType%20-%20Go%20SDK&description=ObservabilityDatadogDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityDatadogDestinationTypeDatadog -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `ObservabilityDatadogDestinationTypeDatadog` | datadog | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitydestination.mdx b/client-sdks/go/api-reference/models/observabilitydestination.mdx deleted file mode 100644 index 1db76805..00000000 --- a/client-sdks/go/api-reference/models/observabilitydestination.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: ObservabilityDestination - Go SDK -sidebarTitle: ObservabilityDestination -description: ObservabilityDestination type definition -seoTitle: ObservabilityDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityDestination type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDestination%20-%20Go%20SDK&description=ObservabilityDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ObservabilityArizeDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationArize(components.ObservabilityArizeDestination{/* values here */}) -``` - -### ObservabilityBraintrustDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationBraintrust(components.ObservabilityBraintrustDestination{/* values here */}) -``` - -### ObservabilityClickhouseDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationClickhouse(components.ObservabilityClickhouseDestination{/* values here */}) -``` - -### ObservabilityDatadogDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationDatadog(components.ObservabilityDatadogDestination{/* values here */}) -``` - -### ObservabilityGrafanaDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationGrafana(components.ObservabilityGrafanaDestination{/* values here */}) -``` - -### ObservabilityLangfuseDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationLangfuse(components.ObservabilityLangfuseDestination{/* values here */}) -``` - -### ObservabilityLangsmithDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationLangsmith(components.ObservabilityLangsmithDestination{/* values here */}) -``` - -### ObservabilityNewrelicDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationNewrelic(components.ObservabilityNewrelicDestination{/* values here */}) -``` - -### ObservabilityOpikDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationOpik(components.ObservabilityOpikDestination{/* values here */}) -``` - -### ObservabilityOtelCollectorDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationOtelCollector(components.ObservabilityOtelCollectorDestination{/* values here */}) -``` - -### ObservabilityPosthogDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationPosthog(components.ObservabilityPosthogDestination{/* values here */}) -``` - -### ObservabilityRampDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationRamp(components.ObservabilityRampDestination{/* values here */}) -``` - -### ObservabilityS3Destination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationS3(components.ObservabilityS3Destination{/* values here */}) -``` - -### ObservabilitySentryDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationSentry(components.ObservabilitySentryDestination{/* values here */}) -``` - -### ObservabilitySnowflakeDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationSnowflake(components.ObservabilitySnowflakeDestination{/* values here */}) -``` - -### ObservabilityWeaveDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationWeave(components.ObservabilityWeaveDestination{/* values here */}) -``` - -### ObservabilityWebhookDestination - -```go lines -observabilityDestination := components.CreateObservabilityDestinationWebhook(components.ObservabilityWebhookDestination{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch observabilityDestination.Type { - case components.ObservabilityDestinationTypeArize: - // observabilityDestination.ObservabilityArizeDestination is populated - case components.ObservabilityDestinationTypeBraintrust: - // observabilityDestination.ObservabilityBraintrustDestination is populated - case components.ObservabilityDestinationTypeClickhouse: - // observabilityDestination.ObservabilityClickhouseDestination is populated - case components.ObservabilityDestinationTypeDatadog: - // observabilityDestination.ObservabilityDatadogDestination is populated - case components.ObservabilityDestinationTypeGrafana: - // observabilityDestination.ObservabilityGrafanaDestination is populated - case components.ObservabilityDestinationTypeLangfuse: - // observabilityDestination.ObservabilityLangfuseDestination is populated - case components.ObservabilityDestinationTypeLangsmith: - // observabilityDestination.ObservabilityLangsmithDestination is populated - case components.ObservabilityDestinationTypeNewrelic: - // observabilityDestination.ObservabilityNewrelicDestination is populated - case components.ObservabilityDestinationTypeOpik: - // observabilityDestination.ObservabilityOpikDestination is populated - case components.ObservabilityDestinationTypeOtelCollector: - // observabilityDestination.ObservabilityOtelCollectorDestination is populated - case components.ObservabilityDestinationTypePosthog: - // observabilityDestination.ObservabilityPosthogDestination is populated - case components.ObservabilityDestinationTypeRamp: - // observabilityDestination.ObservabilityRampDestination is populated - case components.ObservabilityDestinationTypeS3: - // observabilityDestination.ObservabilityS3Destination is populated - case components.ObservabilityDestinationTypeSentry: - // observabilityDestination.ObservabilitySentryDestination is populated - case components.ObservabilityDestinationTypeSnowflake: - // observabilityDestination.ObservabilitySnowflakeDestination is populated - case components.ObservabilityDestinationTypeWeave: - // observabilityDestination.ObservabilityWeaveDestination is populated - case components.ObservabilityDestinationTypeWebhook: - // observabilityDestination.ObservabilityWebhookDestination is populated - default: - // Unknown type - use observabilityDestination.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityfilterrulesconfig.mdx b/client-sdks/go/api-reference/models/observabilityfilterrulesconfig.mdx deleted file mode 100644 index eb7ea830..00000000 --- a/client-sdks/go/api-reference/models/observabilityfilterrulesconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityFilterRulesConfig - Go SDK -sidebarTitle: ObservabilityFilterRulesConfig -description: ObservabilityFilterRulesConfig type definition -seoTitle: ObservabilityFilterRulesConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityfilterrulesconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityFilterRulesConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfig%20-%20Go%20SDK&description=ObservabilityFilterRulesConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Optional structured filter rules controlling which events are forwarded. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `Enabled` | `*bool` | :heavy_minus_sign: | N/A | -| `Groups` | [][components.Group](/client-sdks/go/api-reference/models/group) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityfilterrulesconfigvalue.mdx b/client-sdks/go/api-reference/models/observabilityfilterrulesconfigvalue.mdx deleted file mode 100644 index 56b5718f..00000000 --- a/client-sdks/go/api-reference/models/observabilityfilterrulesconfigvalue.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: ObservabilityFilterRulesConfigValue - Go SDK -sidebarTitle: ObservabilityFilterRulesConfigValue -description: ObservabilityFilterRulesConfigValue type definition -seoTitle: ObservabilityFilterRulesConfigValue Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityfilterrulesconfigvalue -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfigValue Type | OpenRouter Go SDK -'og:description': >- - ObservabilityFilterRulesConfigValue type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfigValue%20-%20Go%20SDK&description=ObservabilityFilterRulesConfigValue%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -observabilityFilterRulesConfigValue := components.CreateObservabilityFilterRulesConfigValueStr(string{/* values here */}) -``` - -### - -```go lines -observabilityFilterRulesConfigValue := components.CreateObservabilityFilterRulesConfigValueNumber(float64{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch observabilityFilterRulesConfigValue.Type { - case components.ObservabilityFilterRulesConfigValueTypeStr: - // observabilityFilterRulesConfigValue.Str is populated - case components.ObservabilityFilterRulesConfigValueTypeNumber: - // observabilityFilterRulesConfigValue.Number is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitygrafanadestination.mdx b/client-sdks/go/api-reference/models/observabilitygrafanadestination.mdx deleted file mode 100644 index 12f07130..00000000 --- a/client-sdks/go/api-reference/models/observabilitygrafanadestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityGrafanaDestination - Go SDK -sidebarTitle: ObservabilityGrafanaDestination -description: ObservabilityGrafanaDestination type definition -seoTitle: ObservabilityGrafanaDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitygrafanadestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityGrafanaDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestination%20-%20Go%20SDK&description=ObservabilityGrafanaDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityGrafanaDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitygrafanadestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitygrafanadestinationconfig.mdx deleted file mode 100644 index dd2e240e..00000000 --- a/client-sdks/go/api-reference/models/observabilitygrafanadestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityGrafanaDestinationConfig - Go SDK -sidebarTitle: ObservabilityGrafanaDestinationConfig -description: ObservabilityGrafanaDestinationConfig type definition -seoTitle: ObservabilityGrafanaDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitygrafanadestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityGrafanaDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestinationConfig%20-%20Go%20SDK&description=ObservabilityGrafanaDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `InstanceID` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitygrafanadestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitygrafanadestinationtype.mdx deleted file mode 100644 index 92412205..00000000 --- a/client-sdks/go/api-reference/models/observabilitygrafanadestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityGrafanaDestinationType - Go SDK -sidebarTitle: ObservabilityGrafanaDestinationType -description: ObservabilityGrafanaDestinationType type definition -seoTitle: ObservabilityGrafanaDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitygrafanadestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityGrafanaDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestinationType%20-%20Go%20SDK&description=ObservabilityGrafanaDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityGrafanaDestinationTypeGrafana -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `ObservabilityGrafanaDestinationTypeGrafana` | grafana | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitylangfusedestination.mdx b/client-sdks/go/api-reference/models/observabilitylangfusedestination.mdx deleted file mode 100644 index 0c35899a..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangfusedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityLangfuseDestination - Go SDK -sidebarTitle: ObservabilityLangfuseDestination -description: ObservabilityLangfuseDestination type definition -seoTitle: ObservabilityLangfuseDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangfusedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangfuseDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestination%20-%20Go%20SDK&description=ObservabilityLangfuseDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityLangfuseDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitylangfusedestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitylangfusedestinationconfig.mdx deleted file mode 100644 index e14eab08..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangfusedestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityLangfuseDestinationConfig - Go SDK -sidebarTitle: ObservabilityLangfuseDestinationConfig -description: ObservabilityLangfuseDestinationConfig type definition -seoTitle: ObservabilityLangfuseDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangfusedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangfuseDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestinationConfig%20-%20Go%20SDK&description=ObservabilityLangfuseDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `PublicKey` | `string` | :heavy_check_mark: | N/A | -| `SecretKey` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitylangfusedestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitylangfusedestinationtype.mdx deleted file mode 100644 index d34b2a9d..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangfusedestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityLangfuseDestinationType - Go SDK -sidebarTitle: ObservabilityLangfuseDestinationType -description: ObservabilityLangfuseDestinationType type definition -seoTitle: ObservabilityLangfuseDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangfusedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangfuseDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestinationType%20-%20Go%20SDK&description=ObservabilityLangfuseDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityLangfuseDestinationTypeLangfuse -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `ObservabilityLangfuseDestinationTypeLangfuse` | langfuse | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitylangsmithdestination.mdx b/client-sdks/go/api-reference/models/observabilitylangsmithdestination.mdx deleted file mode 100644 index e6e53e04..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangsmithdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityLangsmithDestination - Go SDK -sidebarTitle: ObservabilityLangsmithDestination -description: ObservabilityLangsmithDestination type definition -seoTitle: ObservabilityLangsmithDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangsmithdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangsmithDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestination%20-%20Go%20SDK&description=ObservabilityLangsmithDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityLangsmithDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitylangsmithdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitylangsmithdestinationconfig.mdx deleted file mode 100644 index 42dddc91..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangsmithdestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityLangsmithDestinationConfig - Go SDK -sidebarTitle: ObservabilityLangsmithDestinationConfig -description: ObservabilityLangsmithDestinationConfig type definition -seoTitle: ObservabilityLangsmithDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangsmithdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangsmithDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestinationConfig%20-%20Go%20SDK&description=ObservabilityLangsmithDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Project` | `*string` | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `WorkspaceID` | `*string` | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitylangsmithdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitylangsmithdestinationtype.mdx deleted file mode 100644 index 6ede7688..00000000 --- a/client-sdks/go/api-reference/models/observabilitylangsmithdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityLangsmithDestinationType - Go SDK -sidebarTitle: ObservabilityLangsmithDestinationType -description: ObservabilityLangsmithDestinationType type definition -seoTitle: ObservabilityLangsmithDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitylangsmithdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityLangsmithDestinationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestinationType%20-%20Go%20SDK&description=ObservabilityLangsmithDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityLangsmithDestinationTypeLangsmith -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `ObservabilityLangsmithDestinationTypeLangsmith` | langsmith | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitynewrelicdestination.mdx b/client-sdks/go/api-reference/models/observabilitynewrelicdestination.mdx deleted file mode 100644 index f9f77105..00000000 --- a/client-sdks/go/api-reference/models/observabilitynewrelicdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityNewrelicDestination - Go SDK -sidebarTitle: ObservabilityNewrelicDestination -description: ObservabilityNewrelicDestination type definition -seoTitle: ObservabilityNewrelicDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitynewrelicdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityNewrelicDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestination%20-%20Go%20SDK&description=ObservabilityNewrelicDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityNewrelicDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitynewrelicdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitynewrelicdestinationconfig.mdx deleted file mode 100644 index b8d2b6c4..00000000 --- a/client-sdks/go/api-reference/models/observabilitynewrelicdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityNewrelicDestinationConfig - Go SDK -sidebarTitle: ObservabilityNewrelicDestinationConfig -description: ObservabilityNewrelicDestinationConfig type definition -seoTitle: ObservabilityNewrelicDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitynewrelicdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityNewrelicDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestinationConfig%20-%20Go%20SDK&description=ObservabilityNewrelicDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/region) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitynewrelicdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitynewrelicdestinationtype.mdx deleted file mode 100644 index f3ced5cf..00000000 --- a/client-sdks/go/api-reference/models/observabilitynewrelicdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityNewrelicDestinationType - Go SDK -sidebarTitle: ObservabilityNewrelicDestinationType -description: ObservabilityNewrelicDestinationType type definition -seoTitle: ObservabilityNewrelicDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitynewrelicdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityNewrelicDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestinationType%20-%20Go%20SDK&description=ObservabilityNewrelicDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityNewrelicDestinationTypeNewrelic -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `ObservabilityNewrelicDestinationTypeNewrelic` | newrelic | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityopikdestination.mdx b/client-sdks/go/api-reference/models/observabilityopikdestination.mdx deleted file mode 100644 index c0ee5aaf..00000000 --- a/client-sdks/go/api-reference/models/observabilityopikdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityOpikDestination - Go SDK -sidebarTitle: ObservabilityOpikDestination -description: ObservabilityOpikDestination type definition -seoTitle: ObservabilityOpikDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityopikdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOpikDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestination%20-%20Go%20SDK&description=ObservabilityOpikDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityOpikDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityopikdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityopikdestinationconfig.mdx deleted file mode 100644 index ef13ad4c..00000000 --- a/client-sdks/go/api-reference/models/observabilityopikdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityOpikDestinationConfig - Go SDK -sidebarTitle: ObservabilityOpikDestinationConfig -description: ObservabilityOpikDestinationConfig type definition -seoTitle: ObservabilityOpikDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityopikdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOpikDestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestinationConfig%20-%20Go%20SDK&description=ObservabilityOpikDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ProjectName` | `string` | :heavy_check_mark: | N/A | -| `Workspace` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityopikdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityopikdestinationtype.mdx deleted file mode 100644 index 56cb6ccd..00000000 --- a/client-sdks/go/api-reference/models/observabilityopikdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityOpikDestinationType - Go SDK -sidebarTitle: ObservabilityOpikDestinationType -description: ObservabilityOpikDestinationType type definition -seoTitle: ObservabilityOpikDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityopikdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOpikDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestinationType%20-%20Go%20SDK&description=ObservabilityOpikDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityOpikDestinationTypeOpik -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `ObservabilityOpikDestinationTypeOpik` | opik | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityotelcollectordestination.mdx b/client-sdks/go/api-reference/models/observabilityotelcollectordestination.mdx deleted file mode 100644 index 11c17a3f..00000000 --- a/client-sdks/go/api-reference/models/observabilityotelcollectordestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestination - Go SDK -sidebarTitle: ObservabilityOtelCollectorDestination -description: ObservabilityOtelCollectorDestination type definition -seoTitle: ObservabilityOtelCollectorDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityotelcollectordestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOtelCollectorDestination type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestination%20-%20Go%20SDK&description=ObservabilityOtelCollectorDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityotelcollectordestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityotelcollectordestinationconfig.mdx deleted file mode 100644 index 5a789bcc..00000000 --- a/client-sdks/go/api-reference/models/observabilityotelcollectordestinationconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestinationConfig - Go SDK -sidebarTitle: ObservabilityOtelCollectorDestinationConfig -description: ObservabilityOtelCollectorDestinationConfig type definition -seoTitle: ObservabilityOtelCollectorDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityotelcollectordestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOtelCollectorDestinationConfig type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestinationConfig%20-%20Go%20SDK&description=ObservabilityOtelCollectorDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Endpoint` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use `{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityotelcollectordestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityotelcollectordestinationtype.mdx deleted file mode 100644 index bb0781fe..00000000 --- a/client-sdks/go/api-reference/models/observabilityotelcollectordestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestinationType - Go SDK -sidebarTitle: ObservabilityOtelCollectorDestinationType -description: ObservabilityOtelCollectorDestinationType type definition -seoTitle: ObservabilityOtelCollectorDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityotelcollectordestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityOtelCollectorDestinationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestinationType%20-%20Go%20SDK&description=ObservabilityOtelCollectorDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityOtelCollectorDestinationTypeOtelCollector -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `ObservabilityOtelCollectorDestinationTypeOtelCollector` | otel-collector | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityposthogdestination.mdx b/client-sdks/go/api-reference/models/observabilityposthogdestination.mdx deleted file mode 100644 index 023a27c8..00000000 --- a/client-sdks/go/api-reference/models/observabilityposthogdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityPosthogDestination - Go SDK -sidebarTitle: ObservabilityPosthogDestination -description: ObservabilityPosthogDestination type definition -seoTitle: ObservabilityPosthogDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityposthogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityPosthogDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestination%20-%20Go%20SDK&description=ObservabilityPosthogDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityPosthogDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityposthogdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityposthogdestinationconfig.mdx deleted file mode 100644 index 4a0c43b3..00000000 --- a/client-sdks/go/api-reference/models/observabilityposthogdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityPosthogDestinationConfig - Go SDK -sidebarTitle: ObservabilityPosthogDestinationConfig -description: ObservabilityPosthogDestinationConfig type definition -seoTitle: ObservabilityPosthogDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityposthogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityPosthogDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestinationConfig%20-%20Go%20SDK&description=ObservabilityPosthogDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityposthogdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityposthogdestinationtype.mdx deleted file mode 100644 index a068e632..00000000 --- a/client-sdks/go/api-reference/models/observabilityposthogdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityPosthogDestinationType - Go SDK -sidebarTitle: ObservabilityPosthogDestinationType -description: ObservabilityPosthogDestinationType type definition -seoTitle: ObservabilityPosthogDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityposthogdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityPosthogDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestinationType%20-%20Go%20SDK&description=ObservabilityPosthogDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityPosthogDestinationTypePosthog -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `ObservabilityPosthogDestinationTypePosthog` | posthog | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityrampdestination.mdx b/client-sdks/go/api-reference/models/observabilityrampdestination.mdx deleted file mode 100644 index 9d76a591..00000000 --- a/client-sdks/go/api-reference/models/observabilityrampdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityRampDestination - Go SDK -sidebarTitle: ObservabilityRampDestination -description: ObservabilityRampDestination type definition -seoTitle: ObservabilityRampDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityrampdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityRampDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestination%20-%20Go%20SDK&description=ObservabilityRampDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityRampDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityrampdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityrampdestinationconfig.mdx deleted file mode 100644 index a28644ec..00000000 --- a/client-sdks/go/api-reference/models/observabilityrampdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityRampDestinationConfig - Go SDK -sidebarTitle: ObservabilityRampDestinationConfig -description: ObservabilityRampDestinationConfig type definition -seoTitle: ObservabilityRampDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityrampdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityRampDestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestinationConfig%20-%20Go%20SDK&description=ObservabilityRampDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityrampdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityrampdestinationtype.mdx deleted file mode 100644 index 4df1ac40..00000000 --- a/client-sdks/go/api-reference/models/observabilityrampdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityRampDestinationType - Go SDK -sidebarTitle: ObservabilityRampDestinationType -description: ObservabilityRampDestinationType type definition -seoTitle: ObservabilityRampDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityrampdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityRampDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestinationType%20-%20Go%20SDK&description=ObservabilityRampDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityRampDestinationTypeRamp -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `ObservabilityRampDestinationTypeRamp` | ramp | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitys3destination.mdx b/client-sdks/go/api-reference/models/observabilitys3destination.mdx deleted file mode 100644 index ce1ff139..00000000 --- a/client-sdks/go/api-reference/models/observabilitys3destination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityS3Destination - Go SDK -sidebarTitle: ObservabilityS3Destination -description: ObservabilityS3Destination type definition -seoTitle: ObservabilityS3Destination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitys3destination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3Destination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityS3Destination type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3Destination%20-%20Go%20SDK&description=ObservabilityS3Destination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityS3DestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitys3destinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitys3destinationconfig.mdx deleted file mode 100644 index cb875501..00000000 --- a/client-sdks/go/api-reference/models/observabilitys3destinationconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObservabilityS3DestinationConfig - Go SDK -sidebarTitle: ObservabilityS3DestinationConfig -description: ObservabilityS3DestinationConfig type definition -seoTitle: ObservabilityS3DestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitys3destinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3DestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityS3DestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3DestinationConfig%20-%20Go%20SDK&description=ObservabilityS3DestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AccessKeyID` | `string` | :heavy_check_mark: | N/A | -| `BucketName` | `string` | :heavy_check_mark: | N/A | -| `Endpoint` | `*string` | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `PathTemplate` | `*string` | :heavy_minus_sign: | Template for S3 object path. The filename (`{traceId}`-`{timestamp}`.json) is automatically appended. Available variables: `{prefix}`, `{date}`, `{year}`, `{month}`, `{day}`, `{apiKeyName}` | -| `Prefix` | `*string` | :heavy_minus_sign: | N/A | -| `Region` | `*string` | :heavy_minus_sign: | N/A | -| `SecretAccessKey` | `string` | :heavy_check_mark: | N/A | -| `SessionToken` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitys3destinationtype.mdx b/client-sdks/go/api-reference/models/observabilitys3destinationtype.mdx deleted file mode 100644 index e1e26050..00000000 --- a/client-sdks/go/api-reference/models/observabilitys3destinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityS3DestinationType - Go SDK -sidebarTitle: ObservabilityS3DestinationType -description: ObservabilityS3DestinationType type definition -seoTitle: ObservabilityS3DestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitys3destinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3DestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityS3DestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3DestinationType%20-%20Go%20SDK&description=ObservabilityS3DestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityS3DestinationTypeS3 -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ObservabilityS3DestinationTypeS3` | s3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitysentrydestination.mdx b/client-sdks/go/api-reference/models/observabilitysentrydestination.mdx deleted file mode 100644 index 8fa85dfe..00000000 --- a/client-sdks/go/api-reference/models/observabilitysentrydestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilitySentryDestination - Go SDK -sidebarTitle: ObservabilitySentryDestination -description: ObservabilitySentryDestination type definition -seoTitle: ObservabilitySentryDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysentrydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySentryDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestination%20-%20Go%20SDK&description=ObservabilitySentryDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilitySentryDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitysentrydestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitysentrydestinationconfig.mdx deleted file mode 100644 index 8271ecd4..00000000 --- a/client-sdks/go/api-reference/models/observabilitysentrydestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilitySentryDestinationConfig - Go SDK -sidebarTitle: ObservabilitySentryDestinationConfig -description: ObservabilitySentryDestinationConfig type definition -seoTitle: ObservabilitySentryDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysentrydestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySentryDestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestinationConfig%20-%20Go%20SDK&description=ObservabilitySentryDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Dsn` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `OtlpEndpoint` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitysentrydestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitysentrydestinationtype.mdx deleted file mode 100644 index ce77e913..00000000 --- a/client-sdks/go/api-reference/models/observabilitysentrydestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilitySentryDestinationType - Go SDK -sidebarTitle: ObservabilitySentryDestinationType -description: ObservabilitySentryDestinationType type definition -seoTitle: ObservabilitySentryDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysentrydestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySentryDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestinationType%20-%20Go%20SDK&description=ObservabilitySentryDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilitySentryDestinationTypeSentry -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `ObservabilitySentryDestinationTypeSentry` | sentry | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitysnowflakedestination.mdx b/client-sdks/go/api-reference/models/observabilitysnowflakedestination.mdx deleted file mode 100644 index 046acf7c..00000000 --- a/client-sdks/go/api-reference/models/observabilitysnowflakedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilitySnowflakeDestination - Go SDK -sidebarTitle: ObservabilitySnowflakeDestination -description: ObservabilitySnowflakeDestination type definition -seoTitle: ObservabilitySnowflakeDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysnowflakedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySnowflakeDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestination%20-%20Go%20SDK&description=ObservabilitySnowflakeDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilitySnowflakeDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitysnowflakedestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitysnowflakedestinationconfig.mdx deleted file mode 100644 index 5d8a6378..00000000 --- a/client-sdks/go/api-reference/models/observabilitysnowflakedestinationconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObservabilitySnowflakeDestinationConfig - Go SDK -sidebarTitle: ObservabilitySnowflakeDestinationConfig -description: ObservabilitySnowflakeDestinationConfig type definition -seoTitle: ObservabilitySnowflakeDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysnowflakedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySnowflakeDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestinationConfig%20-%20Go%20SDK&description=ObservabilitySnowflakeDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Account` | `string` | :heavy_check_mark: | N/A | -| `Database` | `*string` | :heavy_minus_sign: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Schema` | `*string` | :heavy_minus_sign: | N/A | -| `Table` | `*string` | :heavy_minus_sign: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `Warehouse` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitysnowflakedestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitysnowflakedestinationtype.mdx deleted file mode 100644 index 90731698..00000000 --- a/client-sdks/go/api-reference/models/observabilitysnowflakedestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilitySnowflakeDestinationType - Go SDK -sidebarTitle: ObservabilitySnowflakeDestinationType -description: ObservabilitySnowflakeDestinationType type definition -seoTitle: ObservabilitySnowflakeDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitysnowflakedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilitySnowflakeDestinationType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestinationType%20-%20Go%20SDK&description=ObservabilitySnowflakeDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilitySnowflakeDestinationTypeSnowflake -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `ObservabilitySnowflakeDestinationTypeSnowflake` | snowflake | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityweavedestination.mdx b/client-sdks/go/api-reference/models/observabilityweavedestination.mdx deleted file mode 100644 index d4f67901..00000000 --- a/client-sdks/go/api-reference/models/observabilityweavedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityWeaveDestination - Go SDK -sidebarTitle: ObservabilityWeaveDestination -description: ObservabilityWeaveDestination type definition -seoTitle: ObservabilityWeaveDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityweavedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWeaveDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestination%20-%20Go%20SDK&description=ObservabilityWeaveDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityWeaveDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilityweavedestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilityweavedestinationconfig.mdx deleted file mode 100644 index a95d730b..00000000 --- a/client-sdks/go/api-reference/models/observabilityweavedestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityWeaveDestinationConfig - Go SDK -sidebarTitle: ObservabilityWeaveDestinationConfig -description: ObservabilityWeaveDestinationConfig type definition -seoTitle: ObservabilityWeaveDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityweavedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWeaveDestinationConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestinationConfig%20-%20Go%20SDK&description=ObservabilityWeaveDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `APIKey` | `string` | :heavy_check_mark: | N/A | -| `BaseURL` | `*string` | :heavy_minus_sign: | N/A | -| `Entity` | `string` | :heavy_check_mark: | N/A | -| `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `Project` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilityweavedestinationtype.mdx b/client-sdks/go/api-reference/models/observabilityweavedestinationtype.mdx deleted file mode 100644 index a5bde725..00000000 --- a/client-sdks/go/api-reference/models/observabilityweavedestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityWeaveDestinationType - Go SDK -sidebarTitle: ObservabilityWeaveDestinationType -description: ObservabilityWeaveDestinationType type definition -seoTitle: ObservabilityWeaveDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilityweavedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWeaveDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestinationType%20-%20Go%20SDK&description=ObservabilityWeaveDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityWeaveDestinationTypeWeave -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `ObservabilityWeaveDestinationTypeWeave` | weave | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitywebhookdestination.mdx b/client-sdks/go/api-reference/models/observabilitywebhookdestination.mdx deleted file mode 100644 index 11224b50..00000000 --- a/client-sdks/go/api-reference/models/observabilitywebhookdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityWebhookDestination - Go SDK -sidebarTitle: ObservabilityWebhookDestination -description: ObservabilityWebhookDestination type definition -seoTitle: ObservabilityWebhookDestination Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitywebhookdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestination Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWebhookDestination type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestination%20-%20Go%20SDK&description=ObservabilityWebhookDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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. | `` | -| `Config` | [components.ObservabilityWebhookDestinationConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/observabilitywebhookdestinationconfig.mdx b/client-sdks/go/api-reference/models/observabilitywebhookdestinationconfig.mdx deleted file mode 100644 index 24ced92d..00000000 --- a/client-sdks/go/api-reference/models/observabilitywebhookdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityWebhookDestinationConfig - Go SDK -sidebarTitle: ObservabilityWebhookDestinationConfig -description: ObservabilityWebhookDestinationConfig type definition -seoTitle: ObservabilityWebhookDestinationConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitywebhookdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestinationConfig Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWebhookDestinationConfig type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestinationConfig%20-%20Go%20SDK&description=ObservabilityWebhookDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Headers` | map[string]`string` | :heavy_minus_sign: | N/A | -| `Method` | [*components.Method](/client-sdks/go/api-reference/models/method) | :heavy_minus_sign: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/observabilitywebhookdestinationtype.mdx b/client-sdks/go/api-reference/models/observabilitywebhookdestinationtype.mdx deleted file mode 100644 index ed093619..00000000 --- a/client-sdks/go/api-reference/models/observabilitywebhookdestinationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ObservabilityWebhookDestinationType - Go SDK -sidebarTitle: ObservabilityWebhookDestinationType -description: ObservabilityWebhookDestinationType type definition -seoTitle: ObservabilityWebhookDestinationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/observabilitywebhookdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestinationType Type | OpenRouter Go SDK -'og:description': >- - ObservabilityWebhookDestinationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestinationType%20-%20Go%20SDK&description=ObservabilityWebhookDestinationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ObservabilityWebhookDestinationTypeWebhook -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `ObservabilityWebhookDestinationTypeWebhook` | webhook | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/only.mdx b/client-sdks/go/api-reference/models/only.mdx deleted file mode 100644 index ce5a3669..00000000 --- a/client-sdks/go/api-reference/models/only.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Only - Go SDK -sidebarTitle: Only -description: Only type definition -seoTitle: Only Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/only' -'og:site_name': OpenRouter Documentation -'og:title': Only Type | OpenRouter Go SDK -'og:description': >- - Only type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Only%20-%20Go%20SDK&description=Only%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ProviderName - -```go lines -only := components.CreateOnlyProviderName(components.ProviderName{/* values here */}) -``` - -### - -```go lines -only := components.CreateOnlyStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch only.Type { - case components.OnlyTypeProviderName: - // only.ProviderName is populated - case components.OnlyTypeStr: - // only.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcall.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcall.mdx deleted file mode 100644 index 5406aa67..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcall.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenAIResponseCustomToolCall - Go SDK -sidebarTitle: OpenAIResponseCustomToolCall -description: OpenAIResponseCustomToolCall type definition -seoTitle: OpenAIResponseCustomToolCall Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCall Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCall type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCall%20-%20Go%20SDK&description=OpenAIResponseCustomToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Input` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `Type` | [components.OpenAIResponseCustomToolCallType](/client-sdks/go/api-reference/models/openairesponsecustomtoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutput.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutput.mdx deleted file mode 100644 index 37cc5fc9..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutput - Go SDK -sidebarTitle: OpenAIResponseCustomToolCallOutput -description: OpenAIResponseCustomToolCallOutput type definition -seoTitle: OpenAIResponseCustomToolCallOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutput Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCallOutput type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutput%20-%20Go%20SDK&description=OpenAIResponseCustomToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput2) | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponseCustomToolCallOutputType](/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx deleted file mode 100644 index 7d5be046..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput1 - Go SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput1 -description: OpenAIResponseCustomToolCallOutputOutput1 type definition -seoTitle: OpenAIResponseCustomToolCallOutputOutput1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput1 Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput1 type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput1%20-%20Go%20SDK&description=OpenAIResponseCustomToolCallOutputOutput1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputFile - -```go lines -openAIResponseCustomToolCallOutputOutput1 := components.CreateOpenAIResponseCustomToolCallOutputOutput1InputFile(components.InputFile{/* values here */}) -``` - -### InputImage - -```go lines -openAIResponseCustomToolCallOutputOutput1 := components.CreateOpenAIResponseCustomToolCallOutputOutput1InputImage(components.InputImage{/* values here */}) -``` - -### InputText - -```go lines -openAIResponseCustomToolCallOutputOutput1 := components.CreateOpenAIResponseCustomToolCallOutputOutput1InputText(components.InputText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseCustomToolCallOutputOutput1.Type { - case components.OpenAIResponseCustomToolCallOutputOutput1TypeInputFile: - // openAIResponseCustomToolCallOutputOutput1.InputFile is populated - case components.OpenAIResponseCustomToolCallOutputOutput1TypeInputImage: - // openAIResponseCustomToolCallOutputOutput1.InputImage is populated - case components.OpenAIResponseCustomToolCallOutputOutput1TypeInputText: - // openAIResponseCustomToolCallOutputOutput1.InputText is populated - default: - // Unknown type - use openAIResponseCustomToolCallOutputOutput1.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx deleted file mode 100644 index 4f52fc57..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput2 - Go SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput2 -description: OpenAIResponseCustomToolCallOutputOutput2 type definition -seoTitle: OpenAIResponseCustomToolCallOutputOutput2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput2 Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput2 type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput2%20-%20Go%20SDK&description=OpenAIResponseCustomToolCallOutputOutput2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -openAIResponseCustomToolCallOutputOutput2 := components.CreateOpenAIResponseCustomToolCallOutputOutput2Str(string{/* values here */}) -``` - -### - -```go lines -openAIResponseCustomToolCallOutputOutput2 := components.CreateOpenAIResponseCustomToolCallOutputOutput2ArrayOfOpenAIResponseCustomToolCallOutputOutput1([]components.OpenAIResponseCustomToolCallOutputOutput1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseCustomToolCallOutputOutput2.Type { - case components.OpenAIResponseCustomToolCallOutputOutput2TypeStr: - // openAIResponseCustomToolCallOutputOutput2.Str is populated - case components.OpenAIResponseCustomToolCallOutputOutput2TypeArrayOfOpenAIResponseCustomToolCallOutputOutput1: - // openAIResponseCustomToolCallOutputOutput2.ArrayOfOpenAIResponseCustomToolCallOutputOutput1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx deleted file mode 100644 index 85cc25f1..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputType - Go SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputType -description: OpenAIResponseCustomToolCallOutputType type definition -seoTitle: OpenAIResponseCustomToolCallOutputType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputType%20-%20Go%20SDK&description=OpenAIResponseCustomToolCallOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseCustomToolCallOutputTypeCustomToolCallOutput -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| `OpenAIResponseCustomToolCallOutputTypeCustomToolCallOutput` | custom_tool_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalltype.mdx b/client-sdks/go/api-reference/models/openairesponsecustomtoolcalltype.mdx deleted file mode 100644 index c199a4ad..00000000 --- a/client-sdks/go/api-reference/models/openairesponsecustomtoolcalltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallType - Go SDK -sidebarTitle: OpenAIResponseCustomToolCallType -description: OpenAIResponseCustomToolCallType type definition -seoTitle: OpenAIResponseCustomToolCallType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsecustomtoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseCustomToolCallType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallType%20-%20Go%20SDK&description=OpenAIResponseCustomToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseCustomToolCallTypeCustomToolCall -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OpenAIResponseCustomToolCallTypeCustomToolCall` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcall.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcall.mdx deleted file mode 100644 index 3f950be0..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcall.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCall - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCall -description: OpenAIResponseFunctionToolCall type definition -seoTitle: OpenAIResponseFunctionToolCall Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCall Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCall type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCall%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `Status` | [*components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallType](/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutput.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutput.mdx deleted file mode 100644 index e91fb6b8..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutput.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutput - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutput -description: OpenAIResponseFunctionToolCallOutput type definition -seoTitle: OpenAIResponseFunctionToolCallOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutput Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutput type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutput%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput2) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.OpenAIResponseFunctionToolCallOutputStatus](/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputstatus)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx deleted file mode 100644 index 056e0009..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput1 - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput1 -description: OpenAIResponseFunctionToolCallOutputOutput1 type definition -seoTitle: OpenAIResponseFunctionToolCallOutputOutput1 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput1 Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput1 type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput1%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputFile - -```go lines -openAIResponseFunctionToolCallOutputOutput1 := components.CreateOpenAIResponseFunctionToolCallOutputOutput1InputFile(components.InputFile{/* values here */}) -``` - -### InputImage - -```go lines -openAIResponseFunctionToolCallOutputOutput1 := components.CreateOpenAIResponseFunctionToolCallOutputOutput1InputImage(components.InputImage{/* values here */}) -``` - -### InputText - -```go lines -openAIResponseFunctionToolCallOutputOutput1 := components.CreateOpenAIResponseFunctionToolCallOutputOutput1InputText(components.InputText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseFunctionToolCallOutputOutput1.Type { - case components.OpenAIResponseFunctionToolCallOutputOutput1TypeInputFile: - // openAIResponseFunctionToolCallOutputOutput1.InputFile is populated - case components.OpenAIResponseFunctionToolCallOutputOutput1TypeInputImage: - // openAIResponseFunctionToolCallOutputOutput1.InputImage is populated - case components.OpenAIResponseFunctionToolCallOutputOutput1TypeInputText: - // openAIResponseFunctionToolCallOutputOutput1.InputText is populated - default: - // Unknown type - use openAIResponseFunctionToolCallOutputOutput1.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx deleted file mode 100644 index 98377b2f..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput2 - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput2 -description: OpenAIResponseFunctionToolCallOutputOutput2 type definition -seoTitle: OpenAIResponseFunctionToolCallOutputOutput2 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput2 Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput2 type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput2%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -openAIResponseFunctionToolCallOutputOutput2 := components.CreateOpenAIResponseFunctionToolCallOutputOutput2Str(string{/* values here */}) -``` - -### - -```go lines -openAIResponseFunctionToolCallOutputOutput2 := components.CreateOpenAIResponseFunctionToolCallOutputOutput2ArrayOfOpenAIResponseFunctionToolCallOutputOutput1([]components.OpenAIResponseFunctionToolCallOutputOutput1{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseFunctionToolCallOutputOutput2.Type { - case components.OpenAIResponseFunctionToolCallOutputOutput2TypeStr: - // openAIResponseFunctionToolCallOutputOutput2.Str is populated - case components.OpenAIResponseFunctionToolCallOutputOutput2TypeArrayOfOpenAIResponseFunctionToolCallOutputOutput1: - // openAIResponseFunctionToolCallOutputOutput2.ArrayOfOpenAIResponseFunctionToolCallOutputOutput1 is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx deleted file mode 100644 index d1a415f6..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputStatus - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputStatus -description: OpenAIResponseFunctionToolCallOutputStatus type definition -seoTitle: OpenAIResponseFunctionToolCallOutputStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputstatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputStatus Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputStatus type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputStatus%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallOutputStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseFunctionToolCallOutputStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.OpenAIResponseFunctionToolCallOutputStatus("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `OpenAIResponseFunctionToolCallOutputStatusInProgress` | in_progress | -| `OpenAIResponseFunctionToolCallOutputStatusCompleted` | completed | -| `OpenAIResponseFunctionToolCallOutputStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx deleted file mode 100644 index f4557e99..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputType - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputType -description: OpenAIResponseFunctionToolCallOutputType type definition -seoTitle: OpenAIResponseFunctionToolCallOutputType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputType%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseFunctionToolCallOutputTypeFunctionCallOutput -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -| `OpenAIResponseFunctionToolCallOutputTypeFunctionCallOutput` | function_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalltype.mdx b/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalltype.mdx deleted file mode 100644 index ad63715c..00000000 --- a/client-sdks/go/api-reference/models/openairesponsefunctiontoolcalltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallType - Go SDK -sidebarTitle: OpenAIResponseFunctionToolCallType -description: OpenAIResponseFunctionToolCallType type definition -seoTitle: OpenAIResponseFunctionToolCallType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsefunctiontoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseFunctionToolCallType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallType%20-%20Go%20SDK&description=OpenAIResponseFunctionToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseFunctionToolCallTypeFunctionCall -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OpenAIResponseFunctionToolCallTypeFunctionCall` | function_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitem.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitem.mdx deleted file mode 100644 index dac833b8..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenAIResponseInputMessageItem - Go SDK -sidebarTitle: OpenAIResponseInputMessageItem -description: OpenAIResponseInputMessageItem type definition -seoTitle: OpenAIResponseInputMessageItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItem Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItem%20-%20Go%20SDK&description=OpenAIResponseInputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.OpenAIResponseInputMessageItemContent](/client-sdks/go/api-reference/models/openairesponseinputmessageitemcontent) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleunion) | :heavy_check_mark: | N/A | -| `Type` | [*components.OpenAIResponseInputMessageItemType](/client-sdks/go/api-reference/models/openairesponseinputmessageitemtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemcontent.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemcontent.mdx deleted file mode 100644 index 3d2a11e5..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemcontent.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemContent - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemContent -description: OpenAIResponseInputMessageItemContent type definition -seoTitle: OpenAIResponseInputMessageItemContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemContent Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemContent type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemContent%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### InputAudio - -```go lines -openAIResponseInputMessageItemContent := components.CreateOpenAIResponseInputMessageItemContentInputAudio(components.InputAudio{/* values here */}) -``` - -### InputFile - -```go lines -openAIResponseInputMessageItemContent := components.CreateOpenAIResponseInputMessageItemContentInputFile(components.InputFile{/* values here */}) -``` - -### InputImage - -```go lines -openAIResponseInputMessageItemContent := components.CreateOpenAIResponseInputMessageItemContentInputImage(components.InputImage{/* values here */}) -``` - -### InputText - -```go lines -openAIResponseInputMessageItemContent := components.CreateOpenAIResponseInputMessageItemContentInputText(components.InputText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseInputMessageItemContent.Type { - case components.OpenAIResponseInputMessageItemContentTypeInputAudio: - // openAIResponseInputMessageItemContent.InputAudio is populated - case components.OpenAIResponseInputMessageItemContentTypeInputFile: - // openAIResponseInputMessageItemContent.InputFile is populated - case components.OpenAIResponseInputMessageItemContentTypeInputImage: - // openAIResponseInputMessageItemContent.InputImage is populated - case components.OpenAIResponseInputMessageItemContentTypeInputText: - // openAIResponseInputMessageItemContent.InputText is populated - default: - // Unknown type - use openAIResponseInputMessageItemContent.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx deleted file mode 100644 index 1fc7592d..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleDeveloper - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleDeveloper -description: OpenAIResponseInputMessageItemRoleDeveloper type definition -seoTitle: OpenAIResponseInputMessageItemRoleDeveloper Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleDeveloper Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleDeveloper type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleDeveloper%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseInputMessageItemRoleDeveloperDeveloper -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `OpenAIResponseInputMessageItemRoleDeveloperDeveloper` | developer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemrolesystem.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemrolesystem.mdx deleted file mode 100644 index a2d9975a..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemrolesystem.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleSystem - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleSystem -description: OpenAIResponseInputMessageItemRoleSystem type definition -seoTitle: OpenAIResponseInputMessageItemRoleSystem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleSystem Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleSystem type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleSystem%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseInputMessageItemRoleSystemSystem -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OpenAIResponseInputMessageItemRoleSystemSystem` | system | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleunion.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleunion.mdx deleted file mode 100644 index 5b992314..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUnion - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUnion -description: OpenAIResponseInputMessageItemRoleUnion type definition -seoTitle: OpenAIResponseInputMessageItemRoleUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUnion Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUnion type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUnion%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OpenAIResponseInputMessageItemRoleUser - -```go lines -openAIResponseInputMessageItemRoleUnion := components.CreateOpenAIResponseInputMessageItemRoleUnionOpenAIResponseInputMessageItemRoleUser(components.OpenAIResponseInputMessageItemRoleUser{/* values here */}) -``` - -### OpenAIResponseInputMessageItemRoleSystem - -```go lines -openAIResponseInputMessageItemRoleUnion := components.CreateOpenAIResponseInputMessageItemRoleUnionOpenAIResponseInputMessageItemRoleSystem(components.OpenAIResponseInputMessageItemRoleSystem{/* values here */}) -``` - -### OpenAIResponseInputMessageItemRoleDeveloper - -```go lines -openAIResponseInputMessageItemRoleUnion := components.CreateOpenAIResponseInputMessageItemRoleUnionOpenAIResponseInputMessageItemRoleDeveloper(components.OpenAIResponseInputMessageItemRoleDeveloper{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponseInputMessageItemRoleUnion.Type { - case components.OpenAIResponseInputMessageItemRoleUnionTypeOpenAIResponseInputMessageItemRoleUser: - // openAIResponseInputMessageItemRoleUnion.OpenAIResponseInputMessageItemRoleUser is populated - case components.OpenAIResponseInputMessageItemRoleUnionTypeOpenAIResponseInputMessageItemRoleSystem: - // openAIResponseInputMessageItemRoleUnion.OpenAIResponseInputMessageItemRoleSystem is populated - case components.OpenAIResponseInputMessageItemRoleUnionTypeOpenAIResponseInputMessageItemRoleDeveloper: - // openAIResponseInputMessageItemRoleUnion.OpenAIResponseInputMessageItemRoleDeveloper is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleuser.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleuser.mdx deleted file mode 100644 index 22e08708..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemroleuser.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUser - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUser -description: OpenAIResponseInputMessageItemRoleUser type definition -seoTitle: OpenAIResponseInputMessageItemRoleUser Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUser Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUser type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUser%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseInputMessageItemRoleUserUser -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OpenAIResponseInputMessageItemRoleUserUser` | user | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponseinputmessageitemtype.mdx b/client-sdks/go/api-reference/models/openairesponseinputmessageitemtype.mdx deleted file mode 100644 index 57dc9071..00000000 --- a/client-sdks/go/api-reference/models/openairesponseinputmessageitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemType - Go SDK -sidebarTitle: OpenAIResponseInputMessageItemType -description: OpenAIResponseInputMessageItemType type definition -seoTitle: OpenAIResponseInputMessageItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponseinputmessageitemtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponseInputMessageItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemType%20-%20Go%20SDK&description=OpenAIResponseInputMessageItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponseInputMessageItemTypeMessage -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `OpenAIResponseInputMessageItemTypeMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsesannotation.mdx b/client-sdks/go/api-reference/models/openairesponsesannotation.mdx deleted file mode 100644 index 9d9a768a..00000000 --- a/client-sdks/go/api-reference/models/openairesponsesannotation.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: OpenAIResponsesAnnotation - Go SDK -sidebarTitle: OpenAIResponsesAnnotation -description: OpenAIResponsesAnnotation type definition -seoTitle: OpenAIResponsesAnnotation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsesannotation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesAnnotation Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesAnnotation type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesAnnotation%20-%20Go%20SDK&description=OpenAIResponsesAnnotation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### FileCitation - -```go lines -openAIResponsesAnnotation := components.CreateOpenAIResponsesAnnotationFileCitation(components.FileCitation{/* values here */}) -``` - -### URLCitation - -```go lines -openAIResponsesAnnotation := components.CreateOpenAIResponsesAnnotationURLCitation(components.URLCitation{/* values here */}) -``` - -### FilePath - -```go lines -openAIResponsesAnnotation := components.CreateOpenAIResponsesAnnotationFilePath(components.FilePath{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponsesAnnotation.Type { - case components.OpenAIResponsesAnnotationTypeFileCitation: - // openAIResponsesAnnotation.FileCitation is populated - case components.OpenAIResponsesAnnotationTypeURLCitation: - // openAIResponsesAnnotation.URLCitation is populated - case components.OpenAIResponsesAnnotationTypeFilePath: - // openAIResponsesAnnotation.FilePath is populated - default: - // Unknown type - use openAIResponsesAnnotation.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsesrefusalcontent.mdx b/client-sdks/go/api-reference/models/openairesponsesrefusalcontent.mdx deleted file mode 100644 index af47d8b7..00000000 --- a/client-sdks/go/api-reference/models/openairesponsesrefusalcontent.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesRefusalContent - Go SDK -sidebarTitle: OpenAIResponsesRefusalContent -description: OpenAIResponsesRefusalContent type definition -seoTitle: OpenAIResponsesRefusalContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsesrefusalcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContent Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesRefusalContent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContent%20-%20Go%20SDK&description=OpenAIResponsesRefusalContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Refusal` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesRefusalContentType](/client-sdks/go/api-reference/models/openairesponsesrefusalcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsesrefusalcontenttype.mdx b/client-sdks/go/api-reference/models/openairesponsesrefusalcontenttype.mdx deleted file mode 100644 index 423a5edd..00000000 --- a/client-sdks/go/api-reference/models/openairesponsesrefusalcontenttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesRefusalContentType - Go SDK -sidebarTitle: OpenAIResponsesRefusalContentType -description: OpenAIResponsesRefusalContentType type definition -seoTitle: OpenAIResponsesRefusalContentType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsesrefusalcontenttype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContentType Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesRefusalContentType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContentType%20-%20Go%20SDK&description=OpenAIResponsesRefusalContentType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesRefusalContentTypeRefusal -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `OpenAIResponsesRefusalContentTypeRefusal` | refusal | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsesresponsestatus.mdx b/client-sdks/go/api-reference/models/openairesponsesresponsestatus.mdx deleted file mode 100644 index 9bcdac96..00000000 --- a/client-sdks/go/api-reference/models/openairesponsesresponsestatus.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAIResponsesResponseStatus - Go SDK -sidebarTitle: OpenAIResponsesResponseStatus -description: OpenAIResponsesResponseStatus type definition -seoTitle: OpenAIResponsesResponseStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsesresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesResponseStatus Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesResponseStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesResponseStatus%20-%20Go%20SDK&description=OpenAIResponsesResponseStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesResponseStatusCompleted - -// Open enum: custom values can be created with a direct type cast -custom := components.OpenAIResponsesResponseStatus("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `OpenAIResponsesResponseStatusCompleted` | completed | -| `OpenAIResponsesResponseStatusIncomplete` | incomplete | -| `OpenAIResponsesResponseStatusInProgress` | in_progress | -| `OpenAIResponsesResponseStatusFailed` | failed | -| `OpenAIResponsesResponseStatusCancelled` | cancelled | -| `OpenAIResponsesResponseStatusQueued` | queued | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoice.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoice.mdx deleted file mode 100644 index a85b3039..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoice.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoice - Go SDK -sidebarTitle: OpenAIResponsesToolChoice -description: OpenAIResponsesToolChoice type definition -seoTitle: OpenAIResponsesToolChoice Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoice -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoice Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoice type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoice%20-%20Go%20SDK&description=OpenAIResponsesToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Type` | [components.Type](/client-sdks/go/api-reference/models/type) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoiceapplypatch.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoiceapplypatch.mdx deleted file mode 100644 index 95e562ec..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoiceapplypatch.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceApplyPatch - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceApplyPatch -description: OpenAIResponsesToolChoiceApplyPatch type definition -seoTitle: OpenAIResponsesToolChoiceApplyPatch Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoiceapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceApplyPatch Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceApplyPatch type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceApplyPatch%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceApplyPatch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeapplypatch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoiceauto.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoiceauto.mdx deleted file mode 100644 index 2ab24f36..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoiceauto.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceAuto - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceAuto -description: OpenAIResponsesToolChoiceAuto type definition -seoTitle: OpenAIResponsesToolChoiceAuto Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceAuto Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceAuto type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceAuto%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceAutoAuto -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `OpenAIResponsesToolChoiceAutoAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicefunction.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicefunction.mdx deleted file mode 100644 index 7cdc0c66..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicefunction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceFunction - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceFunction -description: OpenAIResponsesToolChoiceFunction type definition -seoTitle: OpenAIResponsesToolChoiceFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceFunction Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceFunction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceFunction%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](/client-sdks/go/api-reference/models/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicenone.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicenone.mdx deleted file mode 100644 index 3f666ee9..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicenone.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceNone - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceNone -description: OpenAIResponsesToolChoiceNone type definition -seoTitle: OpenAIResponsesToolChoiceNone Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceNone Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceNone type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceNone%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceNoneNone -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `OpenAIResponsesToolChoiceNoneNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicerequired.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicerequired.mdx deleted file mode 100644 index 57329d6c..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicerequired.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceRequired - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceRequired -description: OpenAIResponsesToolChoiceRequired type definition -seoTitle: OpenAIResponsesToolChoiceRequired Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceRequired Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceRequired type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceRequired%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceRequiredRequired -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `OpenAIResponsesToolChoiceRequiredRequired` | required | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoiceshell.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoiceshell.mdx deleted file mode 100644 index b05144f8..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoiceshell.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceShell - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceShell -description: OpenAIResponsesToolChoiceShell type definition -seoTitle: OpenAIResponsesToolChoiceShell Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoiceshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceShell Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceShell type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceShell%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceShell%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeshell) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx deleted file mode 100644 index aaaa6c0c..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeApplyPatch - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeApplyPatch -description: OpenAIResponsesToolChoiceTypeApplyPatch type definition -seoTitle: OpenAIResponsesToolChoiceTypeApplyPatch Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicetypeapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeApplyPatch Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeApplyPatch type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeApplyPatch%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceTypeApplyPatch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceTypeApplyPatchApplyPatch -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `OpenAIResponsesToolChoiceTypeApplyPatchApplyPatch` | apply_patch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypefunction.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicetypefunction.mdx deleted file mode 100644 index d3bceab7..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypefunction.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeFunction - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeFunction -description: OpenAIResponsesToolChoiceTypeFunction type definition -seoTitle: OpenAIResponsesToolChoiceTypeFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicetypefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeFunction Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeFunction type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeFunction%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceTypeFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceTypeFunctionFunction -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `OpenAIResponsesToolChoiceTypeFunctionFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeshell.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeshell.mdx deleted file mode 100644 index 30092eb2..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypeshell.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeShell - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeShell -description: OpenAIResponsesToolChoiceTypeShell type definition -seoTitle: OpenAIResponsesToolChoiceTypeShell Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicetypeshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeShell Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeShell type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeShell%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceTypeShell%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceTypeShellShell -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `OpenAIResponsesToolChoiceTypeShellShell` | shell | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx deleted file mode 100644 index a546f5c4..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview -description: OpenAIResponsesToolChoiceTypeWebSearchPreview type definition -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview type reference for the - OpenRouter Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceTypeWebSearchPreviewWebSearchPreview -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------- | --------------------------------------------------------------- | -| `OpenAIResponsesToolChoiceTypeWebSearchPreviewWebSearchPreview` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx deleted file mode 100644 index 2df442b0..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 -description: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 type definition -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 type reference for the - OpenRouter Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311WebSearchPreview20250311 -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `OpenAIResponsesToolChoiceTypeWebSearchPreview20250311WebSearchPreview20250311` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestoolchoiceunion.mdx b/client-sdks/go/api-reference/models/openairesponsestoolchoiceunion.mdx deleted file mode 100644 index ef3b3691..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestoolchoiceunion.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceUnion - Go SDK -sidebarTitle: OpenAIResponsesToolChoiceUnion -description: OpenAIResponsesToolChoiceUnion type definition -seoTitle: OpenAIResponsesToolChoiceUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestoolchoiceunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceUnion Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesToolChoiceUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceUnion%20-%20Go%20SDK&description=OpenAIResponsesToolChoiceUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OpenAIResponsesToolChoiceAuto - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceAuto(components.OpenAIResponsesToolChoiceAuto{/* values here */}) -``` - -### OpenAIResponsesToolChoiceNone - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceNone(components.OpenAIResponsesToolChoiceNone{/* values here */}) -``` - -### OpenAIResponsesToolChoiceRequired - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceRequired(components.OpenAIResponsesToolChoiceRequired{/* values here */}) -``` - -### OpenAIResponsesToolChoiceFunction - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceFunction(components.OpenAIResponsesToolChoiceFunction{/* values here */}) -``` - -### OpenAIResponsesToolChoice - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoice(components.OpenAIResponsesToolChoice{/* values here */}) -``` - -### ToolChoiceAllowed - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionToolChoiceAllowed(components.ToolChoiceAllowed{/* values here */}) -``` - -### OpenAIResponsesToolChoiceApplyPatch - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceApplyPatch(components.OpenAIResponsesToolChoiceApplyPatch{/* values here */}) -``` - -### OpenAIResponsesToolChoiceShell - -```go lines -openAIResponsesToolChoiceUnion := components.CreateOpenAIResponsesToolChoiceUnionOpenAIResponsesToolChoiceShell(components.OpenAIResponsesToolChoiceShell{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch openAIResponsesToolChoiceUnion.Type { - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceAuto: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceAuto is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceNone: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceNone is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceRequired: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceRequired is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceFunction: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceFunction is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoice: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoice is populated - case components.OpenAIResponsesToolChoiceUnionTypeToolChoiceAllowed: - // openAIResponsesToolChoiceUnion.ToolChoiceAllowed is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceApplyPatch: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceApplyPatch is populated - case components.OpenAIResponsesToolChoiceUnionTypeOpenAIResponsesToolChoiceShell: - // openAIResponsesToolChoiceUnion.OpenAIResponsesToolChoiceShell is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openairesponsestruncation.mdx b/client-sdks/go/api-reference/models/openairesponsestruncation.mdx deleted file mode 100644 index 408a0c63..00000000 --- a/client-sdks/go/api-reference/models/openairesponsestruncation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponsesTruncation - Go SDK -sidebarTitle: OpenAIResponsesTruncation -description: OpenAIResponsesTruncation type definition -seoTitle: OpenAIResponsesTruncation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openairesponsestruncation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesTruncation Type | OpenRouter Go SDK -'og:description': >- - OpenAIResponsesTruncation type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesTruncation%20-%20Go%20SDK&description=OpenAIResponsesTruncation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenAIResponsesTruncationAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.OpenAIResponsesTruncation("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `OpenAIResponsesTruncationAuto` | auto | -| `OpenAIResponsesTruncationDisabled` | disabled | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsescreatedevent.mdx b/client-sdks/go/api-reference/models/openresponsescreatedevent.mdx deleted file mode 100644 index fdc43e63..00000000 --- a/client-sdks/go/api-reference/models/openresponsescreatedevent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesCreatedEvent - Go SDK -sidebarTitle: OpenResponsesCreatedEvent -description: OpenResponsesCreatedEvent type definition -seoTitle: OpenResponsesCreatedEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsescreatedevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesCreatedEvent Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesCreatedEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesCreatedEvent%20-%20Go%20SDK&description=OpenResponsesCreatedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is created - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](/client-sdks/go/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"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](/client-sdks/go/api-reference/models/openresponsescreatedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsescreatedeventtype.mdx b/client-sdks/go/api-reference/models/openresponsescreatedeventtype.mdx deleted file mode 100644 index 584bcfa1..00000000 --- a/client-sdks/go/api-reference/models/openresponsescreatedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenResponsesCreatedEventType - Go SDK -sidebarTitle: OpenResponsesCreatedEventType -description: OpenResponsesCreatedEventType type definition -seoTitle: OpenResponsesCreatedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsescreatedeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesCreatedEventType Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesCreatedEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesCreatedEventType%20-%20Go%20SDK&description=OpenResponsesCreatedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenResponsesCreatedEventTypeResponseCreated -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `OpenResponsesCreatedEventTypeResponseCreated` | response.created | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesinprogressevent.mdx b/client-sdks/go/api-reference/models/openresponsesinprogressevent.mdx deleted file mode 100644 index bda6cf47..00000000 --- a/client-sdks/go/api-reference/models/openresponsesinprogressevent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesInProgressEvent - Go SDK -sidebarTitle: OpenResponsesInProgressEvent -description: OpenResponsesInProgressEvent type definition -seoTitle: OpenResponsesInProgressEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInProgressEvent Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesInProgressEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInProgressEvent%20-%20Go%20SDK&description=OpenResponsesInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is in progress - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](/client-sdks/go/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"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](/client-sdks/go/api-reference/models/openresponsesinprogresseventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesinprogresseventtype.mdx b/client-sdks/go/api-reference/models/openresponsesinprogresseventtype.mdx deleted file mode 100644 index d573f71e..00000000 --- a/client-sdks/go/api-reference/models/openresponsesinprogresseventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenResponsesInProgressEventType - Go SDK -sidebarTitle: OpenResponsesInProgressEventType -description: OpenResponsesInProgressEventType type definition -seoTitle: OpenResponsesInProgressEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInProgressEventType Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesInProgressEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInProgressEventType%20-%20Go%20SDK&description=OpenResponsesInProgressEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenResponsesInProgressEventTypeResponseInProgress -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `OpenResponsesInProgressEventTypeResponseInProgress` | response.in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesresult.mdx b/client-sdks/go/api-reference/models/openresponsesresult.mdx deleted file mode 100644 index 0f1a2f5f..00000000 --- a/client-sdks/go/api-reference/models/openresponsesresult.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesResult - Go SDK -sidebarTitle: OpenResponsesResult -description: OpenResponsesResult type definition -seoTitle: OpenResponsesResult Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/openresponsesresult' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResult Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesResult type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResult%20-%20Go%20SDK&description=OpenResponsesResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Complete non-streaming response from the Responses API - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/incompletedetails) | :heavy_check_mark: | N/A | `{"reason": "max_output_tokens"}` | -| `Instructions` | [*components.BaseInputsUnion](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/openresponsesresultobject) | :heavy_check_mark: | N/A | | -| `Output` | [][components.OutputItems](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/storedprompttemplate)] | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Reasoning` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | completed | -| `Store` | `*bool` | :heavy_minus_sign: | N/A | | -| `Temperature` | `*float64` | :heavy_check_mark: | N/A | | -| `Text` | [*components.TextExtendedConfig](/client-sdks/go/api-reference/models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`
\} | -| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](/client-sdks/go/api-reference/models/openairesponsestoolchoiceunion) | :heavy_check_mark: | N/A | auto | -| `Tools` | [][components.OpenResponsesResultToolUnion](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/truncation)] | :heavy_minus_sign: | N/A | auto | -| `Usage` | optionalnullable.OptionalNullable[[components.Usage](/client-sdks/go/api-reference/models/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 | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/openresponsesresultobject.mdx b/client-sdks/go/api-reference/models/openresponsesresultobject.mdx deleted file mode 100644 index 79b63473..00000000 --- a/client-sdks/go/api-reference/models/openresponsesresultobject.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenResponsesResultObject - Go SDK -sidebarTitle: OpenResponsesResultObject -description: OpenResponsesResultObject type definition -seoTitle: OpenResponsesResultObject Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesresultobject -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultObject Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesResultObject type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultObject%20-%20Go%20SDK&description=OpenResponsesResultObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenResponsesResultObjectResponse -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `OpenResponsesResultObjectResponse` | response | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesresulttoolfunction.mdx b/client-sdks/go/api-reference/models/openresponsesresulttoolfunction.mdx deleted file mode 100644 index fabaa729..00000000 --- a/client-sdks/go/api-reference/models/openresponsesresulttoolfunction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesResultToolFunction - Go SDK -sidebarTitle: OpenResponsesResultToolFunction -description: OpenResponsesResultToolFunction type definition -seoTitle: OpenResponsesResultToolFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesresulttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolFunction Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesResultToolFunction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolFunction%20-%20Go%20SDK&description=OpenResponsesResultToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/openresponsesresulttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesresulttoolunion.mdx b/client-sdks/go/api-reference/models/openresponsesresulttoolunion.mdx deleted file mode 100644 index 706ccb9a..00000000 --- a/client-sdks/go/api-reference/models/openresponsesresulttoolunion.mdx +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: OpenResponsesResultToolUnion - Go SDK -sidebarTitle: OpenResponsesResultToolUnion -description: OpenResponsesResultToolUnion type definition -seoTitle: OpenResponsesResultToolUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesresulttoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolUnion Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesResultToolUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolUnion%20-%20Go%20SDK&description=OpenResponsesResultToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OpenResponsesResultToolFunction - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionFunction(components.OpenResponsesResultToolFunction{/* values here */}) -``` - -### PreviewWebSearchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionWebSearchPreview(components.PreviewWebSearchServerTool{/* values here */}) -``` - -### Preview20250311WebSearchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionWebSearchPreview20250311(components.Preview20250311WebSearchServerTool{/* values here */}) -``` - -### LegacyWebSearchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionWebSearch(components.LegacyWebSearchServerTool{/* values here */}) -``` - -### WebSearchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionWebSearch20250826(components.WebSearchServerTool{/* values here */}) -``` - -### FileSearchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionFileSearch(components.FileSearchServerTool{/* values here */}) -``` - -### ComputerUseServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionComputerUsePreview(components.ComputerUseServerTool{/* values here */}) -``` - -### CodeInterpreterServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionCodeInterpreter(components.CodeInterpreterServerTool{/* values here */}) -``` - -### McpServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionMcp(components.McpServerTool{/* values here */}) -``` - -### ImageGenerationServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionImageGeneration(components.ImageGenerationServerTool{/* values here */}) -``` - -### CodexLocalShellTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionLocalShell(components.CodexLocalShellTool{/* values here */}) -``` - -### ShellServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionShell(components.ShellServerTool{/* values here */}) -``` - -### ApplyPatchServerTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionApplyPatch(components.ApplyPatchServerTool{/* values here */}) -``` - -### CustomTool - -```go lines -openResponsesResultToolUnion := components.CreateOpenResponsesResultToolUnionCustom(components.CustomTool{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch openResponsesResultToolUnion.Type { - case components.OpenResponsesResultToolUnionTypeFunction: - // openResponsesResultToolUnion.OpenResponsesResultToolFunction is populated - case components.OpenResponsesResultToolUnionTypeWebSearchPreview: - // openResponsesResultToolUnion.PreviewWebSearchServerTool is populated - case components.OpenResponsesResultToolUnionTypeWebSearchPreview20250311: - // openResponsesResultToolUnion.Preview20250311WebSearchServerTool is populated - case components.OpenResponsesResultToolUnionTypeWebSearch: - // openResponsesResultToolUnion.LegacyWebSearchServerTool is populated - case components.OpenResponsesResultToolUnionTypeWebSearch20250826: - // openResponsesResultToolUnion.WebSearchServerTool is populated - case components.OpenResponsesResultToolUnionTypeFileSearch: - // openResponsesResultToolUnion.FileSearchServerTool is populated - case components.OpenResponsesResultToolUnionTypeComputerUsePreview: - // openResponsesResultToolUnion.ComputerUseServerTool is populated - case components.OpenResponsesResultToolUnionTypeCodeInterpreter: - // openResponsesResultToolUnion.CodeInterpreterServerTool is populated - case components.OpenResponsesResultToolUnionTypeMcp: - // openResponsesResultToolUnion.McpServerTool is populated - case components.OpenResponsesResultToolUnionTypeImageGeneration: - // openResponsesResultToolUnion.ImageGenerationServerTool is populated - case components.OpenResponsesResultToolUnionTypeLocalShell: - // openResponsesResultToolUnion.CodexLocalShellTool is populated - case components.OpenResponsesResultToolUnionTypeShell: - // openResponsesResultToolUnion.ShellServerTool is populated - case components.OpenResponsesResultToolUnionTypeApplyPatch: - // openResponsesResultToolUnion.ApplyPatchServerTool is populated - case components.OpenResponsesResultToolUnionTypeCustom: - // openResponsesResultToolUnion.CustomTool is populated - default: - // Unknown type - use openResponsesResultToolUnion.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openresponsesresulttype.mdx b/client-sdks/go/api-reference/models/openresponsesresulttype.mdx deleted file mode 100644 index b68a8185..00000000 --- a/client-sdks/go/api-reference/models/openresponsesresulttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenResponsesResultType - Go SDK -sidebarTitle: OpenResponsesResultType -description: OpenResponsesResultType type definition -seoTitle: OpenResponsesResultType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openresponsesresulttype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultType Type | OpenRouter Go SDK -'og:description': >- - OpenResponsesResultType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultType%20-%20Go%20SDK&description=OpenResponsesResultType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenResponsesResultTypeFunction -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `OpenResponsesResultTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openroutermetadata.mdx b/client-sdks/go/api-reference/models/openroutermetadata.mdx deleted file mode 100644 index 4ea4a4f7..00000000 --- a/client-sdks/go/api-reference/models/openroutermetadata.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenRouterMetadata - Go SDK -sidebarTitle: OpenRouterMetadata -description: OpenRouterMetadata type definition -seoTitle: OpenRouterMetadata Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/openroutermetadata' -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterMetadata Type | OpenRouter Go SDK -'og:description': >- - OpenRouterMetadata type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterMetadata%20-%20Go%20SDK&description=OpenRouterMetadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Attempt` | `int64` | :heavy_check_mark: | N/A | | -| `Attempts` | [][components.RouterAttempt](/client-sdks/go/api-reference/models/routerattempt) | :heavy_minus_sign: | N/A | | -| `Endpoints` | [components.EndpointsMetadata](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/routerparams) | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | -| `Pipeline` | [][components.PipelineStage](/client-sdks/go/api-reference/models/pipelinestage) | :heavy_minus_sign: | N/A | | -| `Region` | `*string` | :heavy_check_mark: | N/A | | -| `Requested` | `string` | :heavy_check_mark: | N/A | | -| `Strategy` | [components.RoutingStrategy](/client-sdks/go/api-reference/models/routingstrategy) | :heavy_check_mark: | N/A | direct | -| `Summary` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openrouterwebsearchservertool.mdx b/client-sdks/go/api-reference/models/openrouterwebsearchservertool.mdx deleted file mode 100644 index 884b3872..00000000 --- a/client-sdks/go/api-reference/models/openrouterwebsearchservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenRouterWebSearchServerTool - Go SDK -sidebarTitle: OpenRouterWebSearchServerTool -description: OpenRouterWebSearchServerTool type definition -seoTitle: OpenRouterWebSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openrouterwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - OpenRouterWebSearchServerTool type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerTool%20-%20Go%20SDK&description=OpenRouterWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchConfig](/client-sdks/go/api-reference/models/websearchconfig) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `Type` | [components.OpenRouterWebSearchServerToolType](/client-sdks/go/api-reference/models/openrouterwebsearchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/openrouterwebsearchservertooltype.mdx b/client-sdks/go/api-reference/models/openrouterwebsearchservertooltype.mdx deleted file mode 100644 index 6baaa339..00000000 --- a/client-sdks/go/api-reference/models/openrouterwebsearchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenRouterWebSearchServerToolType - Go SDK -sidebarTitle: OpenRouterWebSearchServerToolType -description: OpenRouterWebSearchServerToolType type definition -seoTitle: OpenRouterWebSearchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/openrouterwebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerToolType Type | OpenRouter Go SDK -'og:description': >- - OpenRouterWebSearchServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerToolType%20-%20Go%20SDK&description=OpenRouterWebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OpenRouterWebSearchServerToolTypeOpenrouterWebSearch -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `OpenRouterWebSearchServerToolTypeOpenrouterWebSearch` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/operator.mdx b/client-sdks/go/api-reference/models/operator.mdx deleted file mode 100644 index 4a94a413..00000000 --- a/client-sdks/go/api-reference/models/operator.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Operator - Go SDK -sidebarTitle: Operator -description: Operator type definition -seoTitle: Operator Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/operator' -'og:site_name': OpenRouter Documentation -'og:title': Operator Type | OpenRouter Go SDK -'og:description': >- - Operator type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Operator%20-%20Go%20SDK&description=Operator%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OperatorEquals - -// Open enum: custom values can be created with a direct type cast -custom := components.Operator("custom_value") -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `OperatorEquals` | equals | -| `OperatorNotEquals` | not_equals | -| `OperatorContains` | contains | -| `OperatorNotContains` | not_contains | -| `OperatorRegex` | regex | -| `OperatorStartsWith` | starts_with | -| `OperatorEndsWith` | ends_with | -| `OperatorGt` | gt | -| `OperatorLt` | lt | -| `OperatorGte` | gte | -| `OperatorLte` | lte | -| `OperatorExists` | exists | -| `OperatorNotExists` | not_exists | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/optionsobj.mdx b/client-sdks/go/api-reference/models/optionsobj.mdx deleted file mode 100644 index af35d683..00000000 --- a/client-sdks/go/api-reference/models/optionsobj.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: OptionsObj - Go SDK -sidebarTitle: OptionsObj -description: OptionsObj type definition -seoTitle: OptionsObj Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/optionsobj' -'og:site_name': OpenRouter Documentation -'og:title': OptionsObj Type | OpenRouter Go SDK -'og:description': >- - OptionsObj type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OptionsObj%20-%20Go%20SDK&description=OptionsObj%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | -| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | -| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | -| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/order.mdx b/client-sdks/go/api-reference/models/order.mdx deleted file mode 100644 index 89b777cf..00000000 --- a/client-sdks/go/api-reference/models/order.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Order - Go SDK -sidebarTitle: Order -description: Order type definition -seoTitle: Order Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/order' -'og:site_name': OpenRouter Documentation -'og:title': Order Type | OpenRouter Go SDK -'og:description': >- - Order type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Order%20-%20Go%20SDK&description=Order%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ProviderName - -```go lines -order := components.CreateOrderProviderName(components.ProviderName{/* values here */}) -``` - -### - -```go lines -order := components.CreateOrderStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch order.Type { - case components.OrderTypeProviderName: - // order.ProviderName is populated - case components.OrderTypeStr: - // order.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputapplypatchcallitem.mdx b/client-sdks/go/api-reference/models/outputapplypatchcallitem.mdx deleted file mode 100644 index 8488ba1c..00000000 --- a/client-sdks/go/api-reference/models/outputapplypatchcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputApplyPatchCallItem - Go SDK -sidebarTitle: OutputApplyPatchCallItem -description: OutputApplyPatchCallItem type definition -seoTitle: OutputApplyPatchCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputapplypatchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputApplyPatchCallItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchCallItem%20-%20Go%20SDK&description=OutputApplyPatchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A native `apply_patch_call` output item matching OpenAI's Responses API shape. Emitted when the client requested the `apply_patch` shorthand. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](/client-sdks/go/api-reference/models/applypatchcalloperation) | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `Status` | [components.ApplyPatchCallStatus](/client-sdks/go/api-reference/models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.OutputApplyPatchCallItemType](/client-sdks/go/api-reference/models/outputapplypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputapplypatchcallitemtype.mdx b/client-sdks/go/api-reference/models/outputapplypatchcallitemtype.mdx deleted file mode 100644 index 226ac0e1..00000000 --- a/client-sdks/go/api-reference/models/outputapplypatchcallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputApplyPatchCallItemType - Go SDK -sidebarTitle: OutputApplyPatchCallItemType -description: OutputApplyPatchCallItemType type definition -seoTitle: OutputApplyPatchCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputapplypatchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputApplyPatchCallItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchCallItemType%20-%20Go%20SDK&description=OutputApplyPatchCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputApplyPatchCallItemTypeApplyPatchCall -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OutputApplyPatchCallItemTypeApplyPatchCall` | apply_patch_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputapplypatchservertoolitem.mdx b/client-sdks/go/api-reference/models/outputapplypatchservertoolitem.mdx deleted file mode 100644 index ea725f73..00000000 --- a/client-sdks/go/api-reference/models/outputapplypatchservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputApplyPatchServerToolItem - Go SDK -sidebarTitle: OutputApplyPatchServerToolItem -description: OutputApplyPatchServerToolItem type definition -seoTitle: OutputApplyPatchServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputapplypatchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputApplyPatchServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItem%20-%20Go%20SDK&description=OutputApplyPatchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:apply_patch server tool output item. The turn halts when validation succeeds so the client can apply the patch and echo an `apply_patch_call_output` on the next turn. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `CallID` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Operation` | [*components.ApplyPatchCallOperation](/client-sdks/go/api-reference/models/applypatchcalloperation) | :heavy_minus_sign: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputApplyPatchServerToolItemType](/client-sdks/go/api-reference/models/outputapplypatchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputapplypatchservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputapplypatchservertoolitemtype.mdx deleted file mode 100644 index ce49d6c5..00000000 --- a/client-sdks/go/api-reference/models/outputapplypatchservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputApplyPatchServerToolItemType - Go SDK -sidebarTitle: OutputApplyPatchServerToolItemType -description: OutputApplyPatchServerToolItemType type definition -seoTitle: OutputApplyPatchServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputapplypatchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputApplyPatchServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItemType%20-%20Go%20SDK&description=OutputApplyPatchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputApplyPatchServerToolItemTypeOpenrouterApplyPatch -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `OutputApplyPatchServerToolItemTypeOpenrouterApplyPatch` | openrouter:apply_patch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputbashservertoolitem.mdx b/client-sdks/go/api-reference/models/outputbashservertoolitem.mdx deleted file mode 100644 index b137a7ae..00000000 --- a/client-sdks/go/api-reference/models/outputbashservertoolitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputBashServerToolItem - Go SDK -sidebarTitle: OutputBashServerToolItem -description: OutputBashServerToolItem type definition -seoTitle: OutputBashServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputbashservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputBashServerToolItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItem%20-%20Go%20SDK&description=OutputBashServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:bash server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Command` | `*string` | :heavy_minus_sign: | N/A | | -| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | -| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputBashServerToolItemType](/client-sdks/go/api-reference/models/outputbashservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputbashservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputbashservertoolitemtype.mdx deleted file mode 100644 index 64f68f4a..00000000 --- a/client-sdks/go/api-reference/models/outputbashservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputBashServerToolItemType - Go SDK -sidebarTitle: OutputBashServerToolItemType -description: OutputBashServerToolItemType type definition -seoTitle: OutputBashServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputbashservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputBashServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItemType%20-%20Go%20SDK&description=OutputBashServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputBashServerToolItemTypeOpenrouterBash -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OutputBashServerToolItemTypeOpenrouterBash` | openrouter:bash | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputbrowseruseservertoolitem.mdx b/client-sdks/go/api-reference/models/outputbrowseruseservertoolitem.mdx deleted file mode 100644 index ff0f0ade..00000000 --- a/client-sdks/go/api-reference/models/outputbrowseruseservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputBrowserUseServerToolItem - Go SDK -sidebarTitle: OutputBrowserUseServerToolItem -description: OutputBrowserUseServerToolItem type definition -seoTitle: OutputBrowserUseServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputbrowseruseservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputBrowserUseServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItem%20-%20Go%20SDK&description=OutputBrowserUseServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:browser_use server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Action` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ScreenshotB64` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputBrowserUseServerToolItemType](/client-sdks/go/api-reference/models/outputbrowseruseservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputbrowseruseservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputbrowseruseservertoolitemtype.mdx deleted file mode 100644 index a5dff247..00000000 --- a/client-sdks/go/api-reference/models/outputbrowseruseservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputBrowserUseServerToolItemType - Go SDK -sidebarTitle: OutputBrowserUseServerToolItemType -description: OutputBrowserUseServerToolItemType type definition -seoTitle: OutputBrowserUseServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputbrowseruseservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputBrowserUseServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItemType%20-%20Go%20SDK&description=OutputBrowserUseServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputBrowserUseServerToolItemTypeOpenrouterBrowserUse -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `OutputBrowserUseServerToolItemTypeOpenrouterBrowserUse` | openrouter:browser_use | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcodeinterpretercallitem.mdx b/client-sdks/go/api-reference/models/outputcodeinterpretercallitem.mdx deleted file mode 100644 index a4905459..00000000 --- a/client-sdks/go/api-reference/models/outputcodeinterpretercallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputCodeInterpreterCallItem - Go SDK -sidebarTitle: OutputCodeInterpreterCallItem -description: OutputCodeInterpreterCallItem type definition -seoTitle: OutputCodeInterpreterCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcodeinterpretercallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputCodeInterpreterCallItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItem%20-%20Go%20SDK&description=OutputCodeInterpreterCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A code interpreter execution call with outputs - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `Code` | `*string` | :heavy_check_mark: | N/A | | -| `ContainerID` | `string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Outputs` | [][components.OutputCodeInterpreterCallItemOutputUnion](/client-sdks/go/api-reference/models/outputcodeinterpretercallitemoutputunion) | :heavy_check_mark: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeCodeInterpreterCall](/client-sdks/go/api-reference/models/typecodeinterpretercall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx b/client-sdks/go/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx deleted file mode 100644 index d2b435a5..00000000 --- a/client-sdks/go/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: OutputCodeInterpreterCallItemOutputUnion - Go SDK -sidebarTitle: OutputCodeInterpreterCallItemOutputUnion -description: OutputCodeInterpreterCallItemOutputUnion type definition -seoTitle: OutputCodeInterpreterCallItemOutputUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcodeinterpretercallitemoutputunion -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItemOutputUnion Type | OpenRouter Go SDK -'og:description': >- - OutputCodeInterpreterCallItemOutputUnion type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItemOutputUnion%20-%20Go%20SDK&description=OutputCodeInterpreterCallItemOutputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputImage - -```go lines -outputCodeInterpreterCallItemOutputUnion := components.CreateOutputCodeInterpreterCallItemOutputUnionImage(components.OutputImage{/* values here */}) -``` - -### OutputLogs - -```go lines -outputCodeInterpreterCallItemOutputUnion := components.CreateOutputCodeInterpreterCallItemOutputUnionLogs(components.OutputLogs{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputCodeInterpreterCallItemOutputUnion.Type { - case components.OutputCodeInterpreterCallItemOutputUnionTypeImage: - // outputCodeInterpreterCallItemOutputUnion.OutputImage is populated - case components.OutputCodeInterpreterCallItemOutputUnionTypeLogs: - // outputCodeInterpreterCallItemOutputUnion.OutputLogs is populated - default: - // Unknown type - use outputCodeInterpreterCallItemOutputUnion.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcodeinterpretercallitemtypeimage.mdx b/client-sdks/go/api-reference/models/outputcodeinterpretercallitemtypeimage.mdx deleted file mode 100644 index 20309e98..00000000 --- a/client-sdks/go/api-reference/models/outputcodeinterpretercallitemtypeimage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputCodeInterpreterCallItemTypeImage - Go SDK -sidebarTitle: OutputCodeInterpreterCallItemTypeImage -description: OutputCodeInterpreterCallItemTypeImage type definition -seoTitle: OutputCodeInterpreterCallItemTypeImage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcodeinterpretercallitemtypeimage -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItemTypeImage Type | OpenRouter Go SDK -'og:description': >- - OutputCodeInterpreterCallItemTypeImage type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItemTypeImage%20-%20Go%20SDK&description=OutputCodeInterpreterCallItemTypeImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputCodeInterpreterCallItemTypeImageImage -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `OutputCodeInterpreterCallItemTypeImageImage` | image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitem.mdx b/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitem.mdx deleted file mode 100644 index 5653553b..00000000 --- a/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItem - Go SDK -sidebarTitle: OutputCodeInterpreterServerToolItem -description: OutputCodeInterpreterServerToolItem type definition -seoTitle: OutputCodeInterpreterServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcodeinterpreterservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputCodeInterpreterServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItem%20-%20Go%20SDK&description=OutputCodeInterpreterServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:code_interpreter server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Code` | `*string` | :heavy_minus_sign: | N/A | | -| `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Language` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Stderr` | `*string` | :heavy_minus_sign: | N/A | | -| `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputCodeInterpreterServerToolItemType](/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx deleted file mode 100644 index 8eca4453..00000000 --- a/client-sdks/go/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItemType - Go SDK -sidebarTitle: OutputCodeInterpreterServerToolItemType -description: OutputCodeInterpreterServerToolItemType type definition -seoTitle: OutputCodeInterpreterServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcodeinterpreterservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputCodeInterpreterServerToolItemType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItemType%20-%20Go%20SDK&description=OutputCodeInterpreterServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputCodeInterpreterServerToolItemTypeOpenrouterCodeInterpreter -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `OutputCodeInterpreterServerToolItemTypeOpenrouterCodeInterpreter` | openrouter:code_interpreter | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcomputercallitem.mdx b/client-sdks/go/api-reference/models/outputcomputercallitem.mdx deleted file mode 100644 index 1cf976ca..00000000 --- a/client-sdks/go/api-reference/models/outputcomputercallitem.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OutputComputerCallItem - Go SDK -sidebarTitle: OutputComputerCallItem -description: OutputComputerCallItem type definition -seoTitle: OutputComputerCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputcomputercallitem' -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputComputerCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItem%20-%20Go%20SDK&description=OutputComputerCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Action` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `PendingSafetyChecks` | [][components.PendingSafetyCheck](/client-sdks/go/api-reference/models/pendingsafetycheck) | :heavy_check_mark: | N/A | -| `Status` | [components.OutputComputerCallItemStatus](/client-sdks/go/api-reference/models/outputcomputercallitemstatus) | :heavy_check_mark: | N/A | -| `Type` | [components.OutputComputerCallItemType](/client-sdks/go/api-reference/models/outputcomputercallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcomputercallitemstatus.mdx b/client-sdks/go/api-reference/models/outputcomputercallitemstatus.mdx deleted file mode 100644 index 227b6c89..00000000 --- a/client-sdks/go/api-reference/models/outputcomputercallitemstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OutputComputerCallItemStatus - Go SDK -sidebarTitle: OutputComputerCallItemStatus -description: OutputComputerCallItemStatus type definition -seoTitle: OutputComputerCallItemStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcomputercallitemstatus -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemStatus Type | OpenRouter Go SDK -'og:description': >- - OutputComputerCallItemStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemStatus%20-%20Go%20SDK&description=OutputComputerCallItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputComputerCallItemStatusCompleted - -// Open enum: custom values can be created with a direct type cast -custom := components.OutputComputerCallItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `OutputComputerCallItemStatusCompleted` | completed | -| `OutputComputerCallItemStatusIncomplete` | incomplete | -| `OutputComputerCallItemStatusInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcomputercallitemtype.mdx b/client-sdks/go/api-reference/models/outputcomputercallitemtype.mdx deleted file mode 100644 index 1b29a5fc..00000000 --- a/client-sdks/go/api-reference/models/outputcomputercallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputComputerCallItemType - Go SDK -sidebarTitle: OutputComputerCallItemType -description: OutputComputerCallItemType type definition -seoTitle: OutputComputerCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcomputercallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputComputerCallItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemType%20-%20Go%20SDK&description=OutputComputerCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputComputerCallItemTypeComputerCall -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `OutputComputerCallItemTypeComputerCall` | computer_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcustomtoolcallitem.mdx b/client-sdks/go/api-reference/models/outputcustomtoolcallitem.mdx deleted file mode 100644 index b5342200..00000000 --- a/client-sdks/go/api-reference/models/outputcustomtoolcallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputCustomToolCallItem - Go SDK -sidebarTitle: OutputCustomToolCallItem -description: OutputCustomToolCallItem type definition -seoTitle: OutputCustomToolCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcustomtoolcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputCustomToolCallItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItem%20-%20Go%20SDK&description=OutputCustomToolCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Input` | `string` | :heavy_check_mark: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `Type` | [components.OutputCustomToolCallItemType](/client-sdks/go/api-reference/models/outputcustomtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputcustomtoolcallitemtype.mdx b/client-sdks/go/api-reference/models/outputcustomtoolcallitemtype.mdx deleted file mode 100644 index 81717a69..00000000 --- a/client-sdks/go/api-reference/models/outputcustomtoolcallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputCustomToolCallItemType - Go SDK -sidebarTitle: OutputCustomToolCallItemType -description: OutputCustomToolCallItemType type definition -seoTitle: OutputCustomToolCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputcustomtoolcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputCustomToolCallItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItemType%20-%20Go%20SDK&description=OutputCustomToolCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputCustomToolCallItemTypeCustomToolCall -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OutputCustomToolCallItemTypeCustomToolCall` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputdatetimeitem.mdx b/client-sdks/go/api-reference/models/outputdatetimeitem.mdx deleted file mode 100644 index 1e4401a4..00000000 --- a/client-sdks/go/api-reference/models/outputdatetimeitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputDatetimeItem - Go SDK -sidebarTitle: OutputDatetimeItem -description: OutputDatetimeItem type definition -seoTitle: OutputDatetimeItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputdatetimeitem' -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItem Type | OpenRouter Go SDK -'og:description': >- - OutputDatetimeItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItem%20-%20Go%20SDK&description=OutputDatetimeItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:datetime server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Datetime` | `string` | :heavy_check_mark: | ISO 8601 datetime string | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Timezone` | `string` | :heavy_check_mark: | IANA timezone name | | -| `Type` | [components.OutputDatetimeItemType](/client-sdks/go/api-reference/models/outputdatetimeitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputdatetimeitemtype.mdx b/client-sdks/go/api-reference/models/outputdatetimeitemtype.mdx deleted file mode 100644 index 9a3aa7d7..00000000 --- a/client-sdks/go/api-reference/models/outputdatetimeitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputDatetimeItemType - Go SDK -sidebarTitle: OutputDatetimeItemType -description: OutputDatetimeItemType type definition -seoTitle: OutputDatetimeItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputdatetimeitemtype' -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItemType Type | OpenRouter Go SDK -'og:description': >- - OutputDatetimeItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItemType%20-%20Go%20SDK&description=OutputDatetimeItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputDatetimeItemTypeOpenrouterDatetime -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `OutputDatetimeItemTypeOpenrouterDatetime` | openrouter:datetime | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfilesearchcallitem.mdx b/client-sdks/go/api-reference/models/outputfilesearchcallitem.mdx deleted file mode 100644 index 45b72ee8..00000000 --- a/client-sdks/go/api-reference/models/outputfilesearchcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputFileSearchCallItem - Go SDK -sidebarTitle: OutputFileSearchCallItem -description: OutputFileSearchCallItem type definition -seoTitle: OutputFileSearchCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfilesearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputFileSearchCallItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItem%20-%20Go%20SDK&description=OutputFileSearchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Queries` | []`string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](/client-sdks/go/api-reference/models/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchCallItemType](/client-sdks/go/api-reference/models/outputfilesearchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfilesearchcallitemtype.mdx b/client-sdks/go/api-reference/models/outputfilesearchcallitemtype.mdx deleted file mode 100644 index a1b66d6e..00000000 --- a/client-sdks/go/api-reference/models/outputfilesearchcallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFileSearchCallItemType - Go SDK -sidebarTitle: OutputFileSearchCallItemType -description: OutputFileSearchCallItemType type definition -seoTitle: OutputFileSearchCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfilesearchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputFileSearchCallItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItemType%20-%20Go%20SDK&description=OutputFileSearchCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFileSearchCallItemTypeFileSearchCall -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OutputFileSearchCallItemTypeFileSearchCall` | file_search_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfilesearchservertoolitem.mdx b/client-sdks/go/api-reference/models/outputfilesearchservertoolitem.mdx deleted file mode 100644 index 387e17ef..00000000 --- a/client-sdks/go/api-reference/models/outputfilesearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputFileSearchServerToolItem - Go SDK -sidebarTitle: OutputFileSearchServerToolItem -description: OutputFileSearchServerToolItem type definition -seoTitle: OutputFileSearchServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfilesearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputFileSearchServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItem%20-%20Go%20SDK&description=OutputFileSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:file_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Queries` | []`string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchServerToolItemType](/client-sdks/go/api-reference/models/outputfilesearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfilesearchservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputfilesearchservertoolitemtype.mdx deleted file mode 100644 index a5235260..00000000 --- a/client-sdks/go/api-reference/models/outputfilesearchservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFileSearchServerToolItemType - Go SDK -sidebarTitle: OutputFileSearchServerToolItemType -description: OutputFileSearchServerToolItemType type definition -seoTitle: OutputFileSearchServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfilesearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputFileSearchServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItemType%20-%20Go%20SDK&description=OutputFileSearchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFileSearchServerToolItemTypeOpenrouterFileSearch -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `OutputFileSearchServerToolItemTypeOpenrouterFileSearch` | openrouter:file_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputformat.mdx b/client-sdks/go/api-reference/models/outputformat.mdx deleted file mode 100644 index 0a45de2d..00000000 --- a/client-sdks/go/api-reference/models/outputformat.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputFormat - Go SDK -sidebarTitle: OutputFormat -description: OutputFormat type definition -seoTitle: OutputFormat Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputformat' -'og:site_name': OpenRouter Documentation -'og:title': OutputFormat Type | OpenRouter Go SDK -'og:description': >- - OutputFormat type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFormat%20-%20Go%20SDK&description=OutputFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFormatPng - -// Open enum: custom values can be created with a direct type cast -custom := components.OutputFormat("custom_value") -``` - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `OutputFormatPng` | png | -| `OutputFormatWebp` | webp | -| `OutputFormatJpeg` | jpeg | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitem.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitem.mdx deleted file mode 100644 index f4af08c1..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputFunctionCallItem - Go SDK -sidebarTitle: OutputFunctionCallItem -description: OutputFunctionCallItem type definition -seoTitle: OutputFunctionCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputfunctioncallitem' -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItem%20-%20Go%20SDK&description=OutputFunctionCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Arguments` | `string` | :heavy_check_mark: | N/A | -| `CallID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Namespace` | `*string` | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `Status` | [*components.OutputFunctionCallItemStatusUnion](/client-sdks/go/api-reference/models/outputfunctioncallitemstatusunion) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputFunctionCallItemType](/client-sdks/go/api-reference/models/outputfunctioncallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitemstatuscompleted.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitemstatuscompleted.mdx deleted file mode 100644 index 4271be72..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitemstatuscompleted.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFunctionCallItemStatusCompleted - Go SDK -sidebarTitle: OutputFunctionCallItemStatusCompleted -description: OutputFunctionCallItemStatusCompleted type definition -seoTitle: OutputFunctionCallItemStatusCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfunctioncallitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusCompleted Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItemStatusCompleted type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusCompleted%20-%20Go%20SDK&description=OutputFunctionCallItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFunctionCallItemStatusCompletedCompleted -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OutputFunctionCallItemStatusCompletedCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusincomplete.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitemstatusincomplete.mdx deleted file mode 100644 index 44cdc591..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusincomplete.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFunctionCallItemStatusIncomplete - Go SDK -sidebarTitle: OutputFunctionCallItemStatusIncomplete -description: OutputFunctionCallItemStatusIncomplete type definition -seoTitle: OutputFunctionCallItemStatusIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfunctioncallitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusIncomplete Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItemStatusIncomplete type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusIncomplete%20-%20Go%20SDK&description=OutputFunctionCallItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFunctionCallItemStatusIncompleteIncomplete -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `OutputFunctionCallItemStatusIncompleteIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusinprogress.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitemstatusinprogress.mdx deleted file mode 100644 index 2eb241d1..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusinprogress.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFunctionCallItemStatusInProgress - Go SDK -sidebarTitle: OutputFunctionCallItemStatusInProgress -description: OutputFunctionCallItemStatusInProgress type definition -seoTitle: OutputFunctionCallItemStatusInProgress Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfunctioncallitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusInProgress Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItemStatusInProgress type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusInProgress%20-%20Go%20SDK&description=OutputFunctionCallItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFunctionCallItemStatusInProgressInProgress -``` - -## Values - -| Name | Value | -| -------------------------------------------------- | -------------------------------------------------- | -| `OutputFunctionCallItemStatusInProgressInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusunion.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitemstatusunion.mdx deleted file mode 100644 index 004d7d2e..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitemstatusunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OutputFunctionCallItemStatusUnion - Go SDK -sidebarTitle: OutputFunctionCallItemStatusUnion -description: OutputFunctionCallItemStatusUnion type definition -seoTitle: OutputFunctionCallItemStatusUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfunctioncallitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusUnion Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItemStatusUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusUnion%20-%20Go%20SDK&description=OutputFunctionCallItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputFunctionCallItemStatusCompleted - -```go lines -outputFunctionCallItemStatusUnion := components.CreateOutputFunctionCallItemStatusUnionOutputFunctionCallItemStatusCompleted(components.OutputFunctionCallItemStatusCompleted{/* values here */}) -``` - -### OutputFunctionCallItemStatusIncomplete - -```go lines -outputFunctionCallItemStatusUnion := components.CreateOutputFunctionCallItemStatusUnionOutputFunctionCallItemStatusIncomplete(components.OutputFunctionCallItemStatusIncomplete{/* values here */}) -``` - -### OutputFunctionCallItemStatusInProgress - -```go lines -outputFunctionCallItemStatusUnion := components.CreateOutputFunctionCallItemStatusUnionOutputFunctionCallItemStatusInProgress(components.OutputFunctionCallItemStatusInProgress{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputFunctionCallItemStatusUnion.Type { - case components.OutputFunctionCallItemStatusUnionTypeOutputFunctionCallItemStatusCompleted: - // outputFunctionCallItemStatusUnion.OutputFunctionCallItemStatusCompleted is populated - case components.OutputFunctionCallItemStatusUnionTypeOutputFunctionCallItemStatusIncomplete: - // outputFunctionCallItemStatusUnion.OutputFunctionCallItemStatusIncomplete is populated - case components.OutputFunctionCallItemStatusUnionTypeOutputFunctionCallItemStatusInProgress: - // outputFunctionCallItemStatusUnion.OutputFunctionCallItemStatusInProgress is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfunctioncallitemtype.mdx b/client-sdks/go/api-reference/models/outputfunctioncallitemtype.mdx deleted file mode 100644 index b170e535..00000000 --- a/client-sdks/go/api-reference/models/outputfunctioncallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFunctionCallItemType - Go SDK -sidebarTitle: OutputFunctionCallItemType -description: OutputFunctionCallItemType type definition -seoTitle: OutputFunctionCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfunctioncallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputFunctionCallItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemType%20-%20Go%20SDK&description=OutputFunctionCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFunctionCallItemTypeFunctionCall -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `OutputFunctionCallItemTypeFunctionCall` | function_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfusionservertoolitem.mdx b/client-sdks/go/api-reference/models/outputfusionservertoolitem.mdx deleted file mode 100644 index e2e64033..00000000 --- a/client-sdks/go/api-reference/models/outputfusionservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputFusionServerToolItem - Go SDK -sidebarTitle: OutputFusionServerToolItem -description: OutputFusionServerToolItem type definition -seoTitle: OutputFusionServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfusionservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFusionServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputFusionServerToolItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFusionServerToolItem%20-%20Go%20SDK&description=OutputFusionServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:fusion server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [*components.Analysis](/client-sdks/go/api-reference/models/analysis) | :heavy_minus_sign: | Structured analysis produced by the fusion judge model. | | -| `Error` | `*string` | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `FailedModels` | [][components.FailedModel](/client-sdks/go/api-reference/models/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. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Responses` | [][components.Response](/client-sdks/go/api-reference/models/response) | :heavy_minus_sign: | Slugs of the analysis models that produced a response in this fusion run. | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFusionServerToolItemType](/client-sdks/go/api-reference/models/outputfusionservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputfusionservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputfusionservertoolitemtype.mdx deleted file mode 100644 index 521ffc42..00000000 --- a/client-sdks/go/api-reference/models/outputfusionservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputFusionServerToolItemType - Go SDK -sidebarTitle: OutputFusionServerToolItemType -description: OutputFusionServerToolItemType type definition -seoTitle: OutputFusionServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputfusionservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFusionServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputFusionServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFusionServerToolItemType%20-%20Go%20SDK&description=OutputFusionServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputFusionServerToolItemTypeOpenrouterFusion -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OutputFusionServerToolItemTypeOpenrouterFusion` | openrouter:fusion | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputimage.mdx b/client-sdks/go/api-reference/models/outputimage.mdx deleted file mode 100644 index 2a0f48e3..00000000 --- a/client-sdks/go/api-reference/models/outputimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputImage - Go SDK -sidebarTitle: OutputImage -description: OutputImage type definition -seoTitle: OutputImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputimage' -'og:site_name': OpenRouter Documentation -'og:title': OutputImage Type | OpenRouter Go SDK -'og:description': >- - OutputImage type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImage%20-%20Go%20SDK&description=OutputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputCodeInterpreterCallItemTypeImage](/client-sdks/go/api-reference/models/outputcodeinterpretercallitemtypeimage) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputimagegenerationcallitem.mdx b/client-sdks/go/api-reference/models/outputimagegenerationcallitem.mdx deleted file mode 100644 index 747fd8cd..00000000 --- a/client-sdks/go/api-reference/models/outputimagegenerationcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputImageGenerationCallItem - Go SDK -sidebarTitle: OutputImageGenerationCallItem -description: OutputImageGenerationCallItem type definition -seoTitle: OutputImageGenerationCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputimagegenerationcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputImageGenerationCallItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItem%20-%20Go%20SDK&description=OutputImageGenerationCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](/client-sdks/go/api-reference/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationCallItemType](/client-sdks/go/api-reference/models/outputimagegenerationcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputimagegenerationcallitemtype.mdx b/client-sdks/go/api-reference/models/outputimagegenerationcallitemtype.mdx deleted file mode 100644 index ea3f2118..00000000 --- a/client-sdks/go/api-reference/models/outputimagegenerationcallitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputImageGenerationCallItemType - Go SDK -sidebarTitle: OutputImageGenerationCallItemType -description: OutputImageGenerationCallItemType type definition -seoTitle: OutputImageGenerationCallItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputimagegenerationcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItemType Type | OpenRouter Go SDK -'og:description': >- - OutputImageGenerationCallItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItemType%20-%20Go%20SDK&description=OutputImageGenerationCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputImageGenerationCallItemTypeImageGenerationCall -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `OutputImageGenerationCallItemTypeImageGenerationCall` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputimagegenerationservertoolitem.mdx b/client-sdks/go/api-reference/models/outputimagegenerationservertoolitem.mdx deleted file mode 100644 index 6e062f5c..00000000 --- a/client-sdks/go/api-reference/models/outputimagegenerationservertoolitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputImageGenerationServerToolItem - Go SDK -sidebarTitle: OutputImageGenerationServerToolItem -description: OutputImageGenerationServerToolItem type definition -seoTitle: OutputImageGenerationServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputimagegenerationservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputImageGenerationServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItem%20-%20Go%20SDK&description=OutputImageGenerationServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:image_generation server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ImageB64` | `*string` | :heavy_minus_sign: | N/A | | -| `ImageURL` | `*string` | :heavy_minus_sign: | N/A | | -| `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](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationServerToolItemType](/client-sdks/go/api-reference/models/outputimagegenerationservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputimagegenerationservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputimagegenerationservertoolitemtype.mdx deleted file mode 100644 index c83a3217..00000000 --- a/client-sdks/go/api-reference/models/outputimagegenerationservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputImageGenerationServerToolItemType - Go SDK -sidebarTitle: OutputImageGenerationServerToolItemType -description: OutputImageGenerationServerToolItemType type definition -seoTitle: OutputImageGenerationServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputimagegenerationservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputImageGenerationServerToolItemType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItemType%20-%20Go%20SDK&description=OutputImageGenerationServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputImageGenerationServerToolItemTypeOpenrouterImageGeneration -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `OutputImageGenerationServerToolItemTypeOpenrouterImageGeneration` | openrouter:image_generation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputitemimagegenerationcall.mdx b/client-sdks/go/api-reference/models/outputitemimagegenerationcall.mdx deleted file mode 100644 index ede61d3d..00000000 --- a/client-sdks/go/api-reference/models/outputitemimagegenerationcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputItemImageGenerationCall - Go SDK -sidebarTitle: OutputItemImageGenerationCall -description: OutputItemImageGenerationCall type definition -seoTitle: OutputItemImageGenerationCall Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputitemimagegenerationcall -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCall Type | OpenRouter Go SDK -'og:description': >- - OutputItemImageGenerationCall type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCall%20-%20Go%20SDK&description=OutputItemImageGenerationCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](/client-sdks/go/api-reference/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputItemImageGenerationCallType](/client-sdks/go/api-reference/models/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputitemimagegenerationcalltype.mdx b/client-sdks/go/api-reference/models/outputitemimagegenerationcalltype.mdx deleted file mode 100644 index f0b94aee..00000000 --- a/client-sdks/go/api-reference/models/outputitemimagegenerationcalltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputItemImageGenerationCallType - Go SDK -sidebarTitle: OutputItemImageGenerationCallType -description: OutputItemImageGenerationCallType type definition -seoTitle: OutputItemImageGenerationCallType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputitemimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCallType Type | OpenRouter Go SDK -'og:description': >- - OutputItemImageGenerationCallType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCallType%20-%20Go%20SDK&description=OutputItemImageGenerationCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputItemImageGenerationCallTypeImageGenerationCall -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `OutputItemImageGenerationCallTypeImageGenerationCall` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputitems.mdx b/client-sdks/go/api-reference/models/outputitems.mdx deleted file mode 100644 index afa9f192..00000000 --- a/client-sdks/go/api-reference/models/outputitems.mdx +++ /dev/null @@ -1,242 +0,0 @@ ---- -title: OutputItems - Go SDK -sidebarTitle: OutputItems -description: OutputItems type definition -seoTitle: OutputItems Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputitems' -'og:site_name': OpenRouter Documentation -'og:title': OutputItems Type | OpenRouter Go SDK -'og:description': >- - OutputItems type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItems%20-%20Go%20SDK&description=OutputItems%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An output item from the response - -## Supported Types - -### OutputApplyPatchCallItem - -```go lines -outputItems := components.CreateOutputItemsApplyPatchCall(components.OutputApplyPatchCallItem{/* values here */}) -``` - -### OutputCodeInterpreterCallItem - -```go lines -outputItems := components.CreateOutputItemsCodeInterpreterCall(components.OutputCodeInterpreterCallItem{/* values here */}) -``` - -### OutputComputerCallItem - -```go lines -outputItems := components.CreateOutputItemsComputerCall(components.OutputComputerCallItem{/* values here */}) -``` - -### OutputCustomToolCallItem - -```go lines -outputItems := components.CreateOutputItemsCustomToolCall(components.OutputCustomToolCallItem{/* values here */}) -``` - -### OutputFileSearchCallItem - -```go lines -outputItems := components.CreateOutputItemsFileSearchCall(components.OutputFileSearchCallItem{/* values here */}) -``` - -### OutputFunctionCallItem - -```go lines -outputItems := components.CreateOutputItemsFunctionCall(components.OutputFunctionCallItem{/* values here */}) -``` - -### OutputImageGenerationCallItem - -```go lines -outputItems := components.CreateOutputItemsImageGenerationCall(components.OutputImageGenerationCallItem{/* values here */}) -``` - -### OutputMessageItem - -```go lines -outputItems := components.CreateOutputItemsMessage(components.OutputMessageItem{/* values here */}) -``` - -### OutputApplyPatchServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterApplyPatch(components.OutputApplyPatchServerToolItem{/* values here */}) -``` - -### OutputBashServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterBash(components.OutputBashServerToolItem{/* values here */}) -``` - -### OutputBrowserUseServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterBrowserUse(components.OutputBrowserUseServerToolItem{/* values here */}) -``` - -### OutputCodeInterpreterServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterCodeInterpreter(components.OutputCodeInterpreterServerToolItem{/* values here */}) -``` - -### OutputDatetimeItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterDatetime(components.OutputDatetimeItem{/* values here */}) -``` - -### OutputSearchModelsServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterExperimentalSearchModels(components.OutputSearchModelsServerToolItem{/* values here */}) -``` - -### OutputFileSearchServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterFileSearch(components.OutputFileSearchServerToolItem{/* values here */}) -``` - -### OutputFusionServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterFusion(components.OutputFusionServerToolItem{/* values here */}) -``` - -### OutputImageGenerationServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterImageGeneration(components.OutputImageGenerationServerToolItem{/* values here */}) -``` - -### OutputMcpServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterMcp(components.OutputMcpServerToolItem{/* values here */}) -``` - -### OutputMemoryServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterMemory(components.OutputMemoryServerToolItem{/* values here */}) -``` - -### OutputTextEditorServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterTextEditor(components.OutputTextEditorServerToolItem{/* values here */}) -``` - -### OutputToolSearchServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterToolSearch(components.OutputToolSearchServerToolItem{/* values here */}) -``` - -### OutputWebFetchServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterWebFetch(components.OutputWebFetchServerToolItem{/* values here */}) -``` - -### OutputWebSearchServerToolItem - -```go lines -outputItems := components.CreateOutputItemsOpenrouterWebSearch(components.OutputWebSearchServerToolItem{/* values here */}) -``` - -### OutputReasoningItem - -```go lines -outputItems := components.CreateOutputItemsReasoning(components.OutputReasoningItem{/* values here */}) -``` - -### OutputWebSearchCallItem - -```go lines -outputItems := components.CreateOutputItemsWebSearchCall(components.OutputWebSearchCallItem{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch outputItems.Type { - case components.OutputItemsTypeApplyPatchCall: - // outputItems.OutputApplyPatchCallItem is populated - case components.OutputItemsTypeCodeInterpreterCall: - // outputItems.OutputCodeInterpreterCallItem is populated - case components.OutputItemsTypeComputerCall: - // outputItems.OutputComputerCallItem is populated - case components.OutputItemsTypeCustomToolCall: - // outputItems.OutputCustomToolCallItem is populated - case components.OutputItemsTypeFileSearchCall: - // outputItems.OutputFileSearchCallItem is populated - case components.OutputItemsTypeFunctionCall: - // outputItems.OutputFunctionCallItem is populated - case components.OutputItemsTypeImageGenerationCall: - // outputItems.OutputImageGenerationCallItem is populated - case components.OutputItemsTypeMessage: - // outputItems.OutputMessageItem is populated - case components.OutputItemsTypeOpenrouterApplyPatch: - // outputItems.OutputApplyPatchServerToolItem is populated - case components.OutputItemsTypeOpenrouterBash: - // outputItems.OutputBashServerToolItem is populated - case components.OutputItemsTypeOpenrouterBrowserUse: - // outputItems.OutputBrowserUseServerToolItem is populated - case components.OutputItemsTypeOpenrouterCodeInterpreter: - // outputItems.OutputCodeInterpreterServerToolItem is populated - case components.OutputItemsTypeOpenrouterDatetime: - // outputItems.OutputDatetimeItem is populated - case components.OutputItemsTypeOpenrouterExperimentalSearchModels: - // outputItems.OutputSearchModelsServerToolItem is populated - case components.OutputItemsTypeOpenrouterFileSearch: - // outputItems.OutputFileSearchServerToolItem is populated - case components.OutputItemsTypeOpenrouterFusion: - // outputItems.OutputFusionServerToolItem is populated - case components.OutputItemsTypeOpenrouterImageGeneration: - // outputItems.OutputImageGenerationServerToolItem is populated - case components.OutputItemsTypeOpenrouterMcp: - // outputItems.OutputMcpServerToolItem is populated - case components.OutputItemsTypeOpenrouterMemory: - // outputItems.OutputMemoryServerToolItem is populated - case components.OutputItemsTypeOpenrouterTextEditor: - // outputItems.OutputTextEditorServerToolItem is populated - case components.OutputItemsTypeOpenrouterToolSearch: - // outputItems.OutputToolSearchServerToolItem is populated - case components.OutputItemsTypeOpenrouterWebFetch: - // outputItems.OutputWebFetchServerToolItem is populated - case components.OutputItemsTypeOpenrouterWebSearch: - // outputItems.OutputWebSearchServerToolItem is populated - case components.OutputItemsTypeReasoning: - // outputItems.OutputReasoningItem is populated - case components.OutputItemsTypeWebSearchCall: - // outputItems.OutputWebSearchCallItem is populated - default: - // Unknown type - use outputItems.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputlogs.mdx b/client-sdks/go/api-reference/models/outputlogs.mdx deleted file mode 100644 index 79f3afc0..00000000 --- a/client-sdks/go/api-reference/models/outputlogs.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputLogs - Go SDK -sidebarTitle: OutputLogs -description: OutputLogs type definition -seoTitle: OutputLogs Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputlogs' -'og:site_name': OpenRouter Documentation -'og:title': OutputLogs Type | OpenRouter Go SDK -'og:description': >- - OutputLogs type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputLogs%20-%20Go%20SDK&description=OutputLogs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Logs` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeLogs](/client-sdks/go/api-reference/models/typelogs) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmcpservertoolitem.mdx b/client-sdks/go/api-reference/models/outputmcpservertoolitem.mdx deleted file mode 100644 index b847e6a3..00000000 --- a/client-sdks/go/api-reference/models/outputmcpservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMcpServerToolItem - Go SDK -sidebarTitle: OutputMcpServerToolItem -description: OutputMcpServerToolItem type definition -seoTitle: OutputMcpServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmcpservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputMcpServerToolItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItem%20-%20Go%20SDK&description=OutputMcpServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:mcp server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `ServerLabel` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `ToolName` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputMcpServerToolItemType](/client-sdks/go/api-reference/models/outputmcpservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmcpservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputmcpservertoolitemtype.mdx deleted file mode 100644 index fb201418..00000000 --- a/client-sdks/go/api-reference/models/outputmcpservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMcpServerToolItemType - Go SDK -sidebarTitle: OutputMcpServerToolItemType -description: OutputMcpServerToolItemType type definition -seoTitle: OutputMcpServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmcpservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputMcpServerToolItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItemType%20-%20Go%20SDK&description=OutputMcpServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMcpServerToolItemTypeOpenrouterMcp -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `OutputMcpServerToolItemTypeOpenrouterMcp` | openrouter:mcp | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmemoryservertoolitem.mdx b/client-sdks/go/api-reference/models/outputmemoryservertoolitem.mdx deleted file mode 100644 index fc9247fd..00000000 --- a/client-sdks/go/api-reference/models/outputmemoryservertoolitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputMemoryServerToolItem - Go SDK -sidebarTitle: OutputMemoryServerToolItem -description: OutputMemoryServerToolItem type definition -seoTitle: OutputMemoryServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmemoryservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputMemoryServerToolItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItem%20-%20Go%20SDK&description=OutputMemoryServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:memory server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.ActionEnum](/client-sdks/go/api-reference/models/actionenum) | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Key` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputMemoryServerToolItemType](/client-sdks/go/api-reference/models/outputmemoryservertoolitemtype) | :heavy_check_mark: | N/A | | -| `Value` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmemoryservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputmemoryservertoolitemtype.mdx deleted file mode 100644 index fac40d73..00000000 --- a/client-sdks/go/api-reference/models/outputmemoryservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMemoryServerToolItemType - Go SDK -sidebarTitle: OutputMemoryServerToolItemType -description: OutputMemoryServerToolItemType type definition -seoTitle: OutputMemoryServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmemoryservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputMemoryServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItemType%20-%20Go%20SDK&description=OutputMemoryServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMemoryServerToolItemTypeOpenrouterMemory -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `OutputMemoryServerToolItemTypeOpenrouterMemory` | openrouter:memory | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessage.mdx b/client-sdks/go/api-reference/models/outputmessage.mdx deleted file mode 100644 index 70ff4b6e..00000000 --- a/client-sdks/go/api-reference/models/outputmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OutputMessage - Go SDK -sidebarTitle: OutputMessage -description: OutputMessage type definition -seoTitle: OutputMessage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessage' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessage Type | OpenRouter Go SDK -'og:description': >- - OutputMessage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessage%20-%20Go%20SDK&description=OutputMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageContent](/client-sdks/go/api-reference/models/outputmessagecontent) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](/client-sdks/go/api-reference/models/outputmessagephaseunion)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageRole](/client-sdks/go/api-reference/models/outputmessagerole) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageStatusUnion](/client-sdks/go/api-reference/models/outputmessagestatusunion) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageType](/client-sdks/go/api-reference/models/outputmessagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagecontent.mdx b/client-sdks/go/api-reference/models/outputmessagecontent.mdx deleted file mode 100644 index 576e0676..00000000 --- a/client-sdks/go/api-reference/models/outputmessagecontent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OutputMessageContent - Go SDK -sidebarTitle: OutputMessageContent -description: OutputMessageContent type definition -seoTitle: OutputMessageContent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageContent Type | OpenRouter Go SDK -'og:description': >- - OutputMessageContent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageContent%20-%20Go%20SDK&description=OutputMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponseOutputText - -```go lines -outputMessageContent := components.CreateOutputMessageContentOutputText(components.ResponseOutputText{/* values here */}) -``` - -### OpenAIResponsesRefusalContent - -```go lines -outputMessageContent := components.CreateOutputMessageContentRefusal(components.OpenAIResponsesRefusalContent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessageContent.Type { - case components.OutputMessageContentTypeOutputText: - // outputMessageContent.ResponseOutputText is populated - case components.OutputMessageContentTypeRefusal: - // outputMessageContent.OpenAIResponsesRefusalContent is populated - default: - // Unknown type - use outputMessageContent.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitem.mdx b/client-sdks/go/api-reference/models/outputmessageitem.mdx deleted file mode 100644 index 621b8e0f..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMessageItem - Go SDK -sidebarTitle: OutputMessageItem -description: OutputMessageItem type definition -seoTitle: OutputMessageItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessageitem' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItem Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItem%20-%20Go%20SDK&description=OutputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An output message item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageItemContent](/client-sdks/go/api-reference/models/outputmessageitemcontent) | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](/client-sdks/go/api-reference/models/outputmessageitemphaseunion)] | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `Role` | [components.OutputMessageItemRole](/client-sdks/go/api-reference/models/outputmessageitemrole) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageItemStatusUnion](/client-sdks/go/api-reference/models/outputmessageitemstatusunion) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageItemType](/client-sdks/go/api-reference/models/outputmessageitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemcontent.mdx b/client-sdks/go/api-reference/models/outputmessageitemcontent.mdx deleted file mode 100644 index 458584ef..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemcontent.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: OutputMessageItemContent - Go SDK -sidebarTitle: OutputMessageItemContent -description: OutputMessageItemContent type definition -seoTitle: OutputMessageItemContent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemContent Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemContent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemContent%20-%20Go%20SDK&description=OutputMessageItemContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponseOutputText - -```go lines -outputMessageItemContent := components.CreateOutputMessageItemContentOutputText(components.ResponseOutputText{/* values here */}) -``` - -### OpenAIResponsesRefusalContent - -```go lines -outputMessageItemContent := components.CreateOutputMessageItemContentRefusal(components.OpenAIResponsesRefusalContent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessageItemContent.Type { - case components.OutputMessageItemContentTypeOutputText: - // outputMessageItemContent.ResponseOutputText is populated - case components.OutputMessageItemContentTypeRefusal: - // outputMessageItemContent.OpenAIResponsesRefusalContent is populated - default: - // Unknown type - use outputMessageItemContent.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemphasecommentary.mdx b/client-sdks/go/api-reference/models/outputmessageitemphasecommentary.mdx deleted file mode 100644 index 8d40573f..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemphasecommentary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageItemPhaseCommentary - Go SDK -sidebarTitle: OutputMessageItemPhaseCommentary -description: OutputMessageItemPhaseCommentary type definition -seoTitle: OutputMessageItemPhaseCommentary Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseCommentary Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemPhaseCommentary type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseCommentary%20-%20Go%20SDK&description=OutputMessageItemPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemPhaseCommentaryCommentary -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `OutputMessageItemPhaseCommentaryCommentary` | commentary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemphasefinalanswer.mdx b/client-sdks/go/api-reference/models/outputmessageitemphasefinalanswer.mdx deleted file mode 100644 index 71ffcfec..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemphasefinalanswer.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageItemPhaseFinalAnswer - Go SDK -sidebarTitle: OutputMessageItemPhaseFinalAnswer -description: OutputMessageItemPhaseFinalAnswer type definition -seoTitle: OutputMessageItemPhaseFinalAnswer Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseFinalAnswer Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemPhaseFinalAnswer type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseFinalAnswer%20-%20Go%20SDK&description=OutputMessageItemPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemPhaseFinalAnswerFinalAnswer -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `OutputMessageItemPhaseFinalAnswerFinalAnswer` | final_answer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemphaseunion.mdx b/client-sdks/go/api-reference/models/outputmessageitemphaseunion.mdx deleted file mode 100644 index bc218803..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemphaseunion.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: OutputMessageItemPhaseUnion - Go SDK -sidebarTitle: OutputMessageItemPhaseUnion -description: OutputMessageItemPhaseUnion type definition -seoTitle: OutputMessageItemPhaseUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemphaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseUnion Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemPhaseUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseUnion%20-%20Go%20SDK&description=OutputMessageItemPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### OutputMessageItemPhaseCommentary - -```go lines -outputMessageItemPhaseUnion := components.CreateOutputMessageItemPhaseUnionOutputMessageItemPhaseCommentary(components.OutputMessageItemPhaseCommentary{/* values here */}) -``` - -### OutputMessageItemPhaseFinalAnswer - -```go lines -outputMessageItemPhaseUnion := components.CreateOutputMessageItemPhaseUnionOutputMessageItemPhaseFinalAnswer(components.OutputMessageItemPhaseFinalAnswer{/* values here */}) -``` - -### - -```go lines -outputMessageItemPhaseUnion := components.CreateOutputMessageItemPhaseUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessageItemPhaseUnion.Type { - case components.OutputMessageItemPhaseUnionTypeOutputMessageItemPhaseCommentary: - // outputMessageItemPhaseUnion.OutputMessageItemPhaseCommentary is populated - case components.OutputMessageItemPhaseUnionTypeOutputMessageItemPhaseFinalAnswer: - // outputMessageItemPhaseUnion.OutputMessageItemPhaseFinalAnswer is populated - case components.OutputMessageItemPhaseUnionTypeAny: - // outputMessageItemPhaseUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemrole.mdx b/client-sdks/go/api-reference/models/outputmessageitemrole.mdx deleted file mode 100644 index f2203c56..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemrole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputMessageItemRole - Go SDK -sidebarTitle: OutputMessageItemRole -description: OutputMessageItemRole type definition -seoTitle: OutputMessageItemRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessageitemrole' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemRole Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemRole%20-%20Go%20SDK&description=OutputMessageItemRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemRoleAssistant -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `OutputMessageItemRoleAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemstatuscompleted.mdx b/client-sdks/go/api-reference/models/outputmessageitemstatuscompleted.mdx deleted file mode 100644 index e1a840e4..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemstatuscompleted.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageItemStatusCompleted - Go SDK -sidebarTitle: OutputMessageItemStatusCompleted -description: OutputMessageItemStatusCompleted type definition -seoTitle: OutputMessageItemStatusCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusCompleted Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemStatusCompleted type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusCompleted%20-%20Go%20SDK&description=OutputMessageItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemStatusCompletedCompleted -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `OutputMessageItemStatusCompletedCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemstatusincomplete.mdx b/client-sdks/go/api-reference/models/outputmessageitemstatusincomplete.mdx deleted file mode 100644 index 8bccf621..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemstatusincomplete.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageItemStatusIncomplete - Go SDK -sidebarTitle: OutputMessageItemStatusIncomplete -description: OutputMessageItemStatusIncomplete type definition -seoTitle: OutputMessageItemStatusIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusIncomplete Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemStatusIncomplete type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusIncomplete%20-%20Go%20SDK&description=OutputMessageItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemStatusIncompleteIncomplete -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `OutputMessageItemStatusIncompleteIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemstatusinprogress.mdx b/client-sdks/go/api-reference/models/outputmessageitemstatusinprogress.mdx deleted file mode 100644 index 16945830..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemstatusinprogress.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageItemStatusInProgress - Go SDK -sidebarTitle: OutputMessageItemStatusInProgress -description: OutputMessageItemStatusInProgress type definition -seoTitle: OutputMessageItemStatusInProgress Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusInProgress Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemStatusInProgress type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusInProgress%20-%20Go%20SDK&description=OutputMessageItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemStatusInProgressInProgress -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `OutputMessageItemStatusInProgressInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemstatusunion.mdx b/client-sdks/go/api-reference/models/outputmessageitemstatusunion.mdx deleted file mode 100644 index d9cf151d..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemstatusunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OutputMessageItemStatusUnion - Go SDK -sidebarTitle: OutputMessageItemStatusUnion -description: OutputMessageItemStatusUnion type definition -seoTitle: OutputMessageItemStatusUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessageitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusUnion Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemStatusUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusUnion%20-%20Go%20SDK&description=OutputMessageItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputMessageItemStatusCompleted - -```go lines -outputMessageItemStatusUnion := components.CreateOutputMessageItemStatusUnionOutputMessageItemStatusCompleted(components.OutputMessageItemStatusCompleted{/* values here */}) -``` - -### OutputMessageItemStatusIncomplete - -```go lines -outputMessageItemStatusUnion := components.CreateOutputMessageItemStatusUnionOutputMessageItemStatusIncomplete(components.OutputMessageItemStatusIncomplete{/* values here */}) -``` - -### OutputMessageItemStatusInProgress - -```go lines -outputMessageItemStatusUnion := components.CreateOutputMessageItemStatusUnionOutputMessageItemStatusInProgress(components.OutputMessageItemStatusInProgress{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessageItemStatusUnion.Type { - case components.OutputMessageItemStatusUnionTypeOutputMessageItemStatusCompleted: - // outputMessageItemStatusUnion.OutputMessageItemStatusCompleted is populated - case components.OutputMessageItemStatusUnionTypeOutputMessageItemStatusIncomplete: - // outputMessageItemStatusUnion.OutputMessageItemStatusIncomplete is populated - case components.OutputMessageItemStatusUnionTypeOutputMessageItemStatusInProgress: - // outputMessageItemStatusUnion.OutputMessageItemStatusInProgress is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessageitemtype.mdx b/client-sdks/go/api-reference/models/outputmessageitemtype.mdx deleted file mode 100644 index 622169ad..00000000 --- a/client-sdks/go/api-reference/models/outputmessageitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputMessageItemType - Go SDK -sidebarTitle: OutputMessageItemType -description: OutputMessageItemType type definition -seoTitle: OutputMessageItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessageitemtype' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemType Type | OpenRouter Go SDK -'og:description': >- - OutputMessageItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemType%20-%20Go%20SDK&description=OutputMessageItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageItemTypeMessage -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `OutputMessageItemTypeMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagephasecommentary.mdx b/client-sdks/go/api-reference/models/outputmessagephasecommentary.mdx deleted file mode 100644 index 2bef5f9e..00000000 --- a/client-sdks/go/api-reference/models/outputmessagephasecommentary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessagePhaseCommentary - Go SDK -sidebarTitle: OutputMessagePhaseCommentary -description: OutputMessagePhaseCommentary type definition -seoTitle: OutputMessagePhaseCommentary Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseCommentary Type | OpenRouter Go SDK -'og:description': >- - OutputMessagePhaseCommentary type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseCommentary%20-%20Go%20SDK&description=OutputMessagePhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessagePhaseCommentaryCommentary -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `OutputMessagePhaseCommentaryCommentary` | commentary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagephasefinalanswer.mdx b/client-sdks/go/api-reference/models/outputmessagephasefinalanswer.mdx deleted file mode 100644 index f20a1b6c..00000000 --- a/client-sdks/go/api-reference/models/outputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessagePhaseFinalAnswer - Go SDK -sidebarTitle: OutputMessagePhaseFinalAnswer -description: OutputMessagePhaseFinalAnswer type definition -seoTitle: OutputMessagePhaseFinalAnswer Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseFinalAnswer Type | OpenRouter Go SDK -'og:description': >- - OutputMessagePhaseFinalAnswer type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseFinalAnswer%20-%20Go%20SDK&description=OutputMessagePhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessagePhaseFinalAnswerFinalAnswer -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `OutputMessagePhaseFinalAnswerFinalAnswer` | final_answer | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagephaseunion.mdx b/client-sdks/go/api-reference/models/outputmessagephaseunion.mdx deleted file mode 100644 index 7b9703d1..00000000 --- a/client-sdks/go/api-reference/models/outputmessagephaseunion.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: OutputMessagePhaseUnion - Go SDK -sidebarTitle: OutputMessagePhaseUnion -description: OutputMessagePhaseUnion type definition -seoTitle: OutputMessagePhaseUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseUnion Type | OpenRouter Go SDK -'og:description': >- - OutputMessagePhaseUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseUnion%20-%20Go%20SDK&description=OutputMessagePhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### OutputMessagePhaseCommentary - -```go lines -outputMessagePhaseUnion := components.CreateOutputMessagePhaseUnionOutputMessagePhaseCommentary(components.OutputMessagePhaseCommentary{/* values here */}) -``` - -### OutputMessagePhaseFinalAnswer - -```go lines -outputMessagePhaseUnion := components.CreateOutputMessagePhaseUnionOutputMessagePhaseFinalAnswer(components.OutputMessagePhaseFinalAnswer{/* values here */}) -``` - -### - -```go lines -outputMessagePhaseUnion := components.CreateOutputMessagePhaseUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessagePhaseUnion.Type { - case components.OutputMessagePhaseUnionTypeOutputMessagePhaseCommentary: - // outputMessagePhaseUnion.OutputMessagePhaseCommentary is populated - case components.OutputMessagePhaseUnionTypeOutputMessagePhaseFinalAnswer: - // outputMessagePhaseUnion.OutputMessagePhaseFinalAnswer is populated - case components.OutputMessagePhaseUnionTypeAny: - // outputMessagePhaseUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagerole.mdx b/client-sdks/go/api-reference/models/outputmessagerole.mdx deleted file mode 100644 index 23ac99a6..00000000 --- a/client-sdks/go/api-reference/models/outputmessagerole.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputMessageRole - Go SDK -sidebarTitle: OutputMessageRole -description: OutputMessageRole type definition -seoTitle: OutputMessageRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageRole Type | OpenRouter Go SDK -'og:description': >- - OutputMessageRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageRole%20-%20Go%20SDK&description=OutputMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageRoleAssistant -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `OutputMessageRoleAssistant` | assistant | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagestatuscompleted.mdx b/client-sdks/go/api-reference/models/outputmessagestatuscompleted.mdx deleted file mode 100644 index 41cb56bb..00000000 --- a/client-sdks/go/api-reference/models/outputmessagestatuscompleted.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageStatusCompleted - Go SDK -sidebarTitle: OutputMessageStatusCompleted -description: OutputMessageStatusCompleted type definition -seoTitle: OutputMessageStatusCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagestatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusCompleted Type | OpenRouter Go SDK -'og:description': >- - OutputMessageStatusCompleted type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusCompleted%20-%20Go%20SDK&description=OutputMessageStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageStatusCompletedCompleted -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `OutputMessageStatusCompletedCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagestatusincomplete.mdx b/client-sdks/go/api-reference/models/outputmessagestatusincomplete.mdx deleted file mode 100644 index 832e3adb..00000000 --- a/client-sdks/go/api-reference/models/outputmessagestatusincomplete.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageStatusIncomplete - Go SDK -sidebarTitle: OutputMessageStatusIncomplete -description: OutputMessageStatusIncomplete type definition -seoTitle: OutputMessageStatusIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusIncomplete Type | OpenRouter Go SDK -'og:description': >- - OutputMessageStatusIncomplete type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusIncomplete%20-%20Go%20SDK&description=OutputMessageStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageStatusIncompleteIncomplete -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `OutputMessageStatusIncompleteIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagestatusinprogress.mdx b/client-sdks/go/api-reference/models/outputmessagestatusinprogress.mdx deleted file mode 100644 index d56ef342..00000000 --- a/client-sdks/go/api-reference/models/outputmessagestatusinprogress.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputMessageStatusInProgress - Go SDK -sidebarTitle: OutputMessageStatusInProgress -description: OutputMessageStatusInProgress type definition -seoTitle: OutputMessageStatusInProgress Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusInProgress Type | OpenRouter Go SDK -'og:description': >- - OutputMessageStatusInProgress type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusInProgress%20-%20Go%20SDK&description=OutputMessageStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageStatusInProgressInProgress -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `OutputMessageStatusInProgressInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagestatusunion.mdx b/client-sdks/go/api-reference/models/outputmessagestatusunion.mdx deleted file mode 100644 index 326f3932..00000000 --- a/client-sdks/go/api-reference/models/outputmessagestatusunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OutputMessageStatusUnion - Go SDK -sidebarTitle: OutputMessageStatusUnion -description: OutputMessageStatusUnion type definition -seoTitle: OutputMessageStatusUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputmessagestatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusUnion Type | OpenRouter Go SDK -'og:description': >- - OutputMessageStatusUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusUnion%20-%20Go%20SDK&description=OutputMessageStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputMessageStatusCompleted - -```go lines -outputMessageStatusUnion := components.CreateOutputMessageStatusUnionOutputMessageStatusCompleted(components.OutputMessageStatusCompleted{/* values here */}) -``` - -### OutputMessageStatusIncomplete - -```go lines -outputMessageStatusUnion := components.CreateOutputMessageStatusUnionOutputMessageStatusIncomplete(components.OutputMessageStatusIncomplete{/* values here */}) -``` - -### OutputMessageStatusInProgress - -```go lines -outputMessageStatusUnion := components.CreateOutputMessageStatusUnionOutputMessageStatusInProgress(components.OutputMessageStatusInProgress{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputMessageStatusUnion.Type { - case components.OutputMessageStatusUnionTypeOutputMessageStatusCompleted: - // outputMessageStatusUnion.OutputMessageStatusCompleted is populated - case components.OutputMessageStatusUnionTypeOutputMessageStatusIncomplete: - // outputMessageStatusUnion.OutputMessageStatusIncomplete is populated - case components.OutputMessageStatusUnionTypeOutputMessageStatusInProgress: - // outputMessageStatusUnion.OutputMessageStatusInProgress is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmessagetype.mdx b/client-sdks/go/api-reference/models/outputmessagetype.mdx deleted file mode 100644 index f3a04915..00000000 --- a/client-sdks/go/api-reference/models/outputmessagetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputMessageType - Go SDK -sidebarTitle: OutputMessageType -description: OutputMessageType type definition -seoTitle: OutputMessageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmessagetype' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageType Type | OpenRouter Go SDK -'og:description': >- - OutputMessageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageType%20-%20Go%20SDK&description=OutputMessageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputMessageTypeMessage -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `OutputMessageTypeMessage` | message | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmodality.mdx b/client-sdks/go/api-reference/models/outputmodality.mdx deleted file mode 100644 index 99bd0df2..00000000 --- a/client-sdks/go/api-reference/models/outputmodality.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OutputModality - Go SDK -sidebarTitle: OutputModality -description: OutputModality type definition -seoTitle: OutputModality Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmodality' -'og:site_name': OpenRouter Documentation -'og:title': OutputModality Type | OpenRouter Go SDK -'og:description': >- - OutputModality type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModality%20-%20Go%20SDK&description=OutputModality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputModalityText - -// Open enum: custom values can be created with a direct type cast -custom := components.OutputModality("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `OutputModalityText` | text | -| `OutputModalityImage` | image | -| `OutputModalityEmbeddings` | embeddings | -| `OutputModalityAudio` | audio | -| `OutputModalityVideo` | video | -| `OutputModalityRerank` | rerank | -| `OutputModalitySpeech` | speech | -| `OutputModalityTranscription` | transcription | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputmodalityenum.mdx b/client-sdks/go/api-reference/models/outputmodalityenum.mdx deleted file mode 100644 index f1d3b359..00000000 --- a/client-sdks/go/api-reference/models/outputmodalityenum.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OutputModalityEnum - Go SDK -sidebarTitle: OutputModalityEnum -description: OutputModalityEnum type definition -seoTitle: OutputModalityEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputmodalityenum' -'og:site_name': OpenRouter Documentation -'og:title': OutputModalityEnum Type | OpenRouter Go SDK -'og:description': >- - OutputModalityEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModalityEnum%20-%20Go%20SDK&description=OutputModalityEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputModalityEnumText - -// Open enum: custom values can be created with a direct type cast -custom := components.OutputModalityEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `OutputModalityEnumText` | text | -| `OutputModalityEnumImage` | image | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputreasoningitem.mdx b/client-sdks/go/api-reference/models/outputreasoningitem.mdx deleted file mode 100644 index b4b9c05e..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputReasoningItem - Go SDK -sidebarTitle: OutputReasoningItem -description: OutputReasoningItem type definition -seoTitle: OutputReasoningItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputreasoningitem' -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItem Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItem%20-%20Go%20SDK&description=OutputReasoningItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/outputreasoningitemstatusunion) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](/client-sdks/go/api-reference/models/reasoningsummarytext) | :heavy_check_mark: | N/A | | -| `Type` | [components.OutputReasoningItemType](/client-sdks/go/api-reference/models/outputreasoningitemtype) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/outputreasoningitemstatuscompleted.mdx b/client-sdks/go/api-reference/models/outputreasoningitemstatuscompleted.mdx deleted file mode 100644 index 02d03fd2..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputReasoningItemStatusCompleted - Go SDK -sidebarTitle: OutputReasoningItemStatusCompleted -description: OutputReasoningItemStatusCompleted type definition -seoTitle: OutputReasoningItemStatusCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputreasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusCompleted Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItemStatusCompleted type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusCompleted%20-%20Go%20SDK&description=OutputReasoningItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputReasoningItemStatusCompletedCompleted -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `OutputReasoningItemStatusCompletedCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputreasoningitemstatusincomplete.mdx b/client-sdks/go/api-reference/models/outputreasoningitemstatusincomplete.mdx deleted file mode 100644 index 806b4f1c..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputReasoningItemStatusIncomplete - Go SDK -sidebarTitle: OutputReasoningItemStatusIncomplete -description: OutputReasoningItemStatusIncomplete type definition -seoTitle: OutputReasoningItemStatusIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputreasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusIncomplete Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItemStatusIncomplete type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusIncomplete%20-%20Go%20SDK&description=OutputReasoningItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputReasoningItemStatusIncompleteIncomplete -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `OutputReasoningItemStatusIncompleteIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputreasoningitemstatusinprogress.mdx b/client-sdks/go/api-reference/models/outputreasoningitemstatusinprogress.mdx deleted file mode 100644 index d96f28e4..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputReasoningItemStatusInProgress - Go SDK -sidebarTitle: OutputReasoningItemStatusInProgress -description: OutputReasoningItemStatusInProgress type definition -seoTitle: OutputReasoningItemStatusInProgress Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputreasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusInProgress Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItemStatusInProgress type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusInProgress%20-%20Go%20SDK&description=OutputReasoningItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputReasoningItemStatusInProgressInProgress -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `OutputReasoningItemStatusInProgressInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputreasoningitemstatusunion.mdx b/client-sdks/go/api-reference/models/outputreasoningitemstatusunion.mdx deleted file mode 100644 index 8c142007..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitemstatusunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OutputReasoningItemStatusUnion - Go SDK -sidebarTitle: OutputReasoningItemStatusUnion -description: OutputReasoningItemStatusUnion type definition -seoTitle: OutputReasoningItemStatusUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputreasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusUnion Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItemStatusUnion type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusUnion%20-%20Go%20SDK&description=OutputReasoningItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OutputReasoningItemStatusCompleted - -```go lines -outputReasoningItemStatusUnion := components.CreateOutputReasoningItemStatusUnionOutputReasoningItemStatusCompleted(components.OutputReasoningItemStatusCompleted{/* values here */}) -``` - -### OutputReasoningItemStatusIncomplete - -```go lines -outputReasoningItemStatusUnion := components.CreateOutputReasoningItemStatusUnionOutputReasoningItemStatusIncomplete(components.OutputReasoningItemStatusIncomplete{/* values here */}) -``` - -### OutputReasoningItemStatusInProgress - -```go lines -outputReasoningItemStatusUnion := components.CreateOutputReasoningItemStatusUnionOutputReasoningItemStatusInProgress(components.OutputReasoningItemStatusInProgress{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch outputReasoningItemStatusUnion.Type { - case components.OutputReasoningItemStatusUnionTypeOutputReasoningItemStatusCompleted: - // outputReasoningItemStatusUnion.OutputReasoningItemStatusCompleted is populated - case components.OutputReasoningItemStatusUnionTypeOutputReasoningItemStatusIncomplete: - // outputReasoningItemStatusUnion.OutputReasoningItemStatusIncomplete is populated - case components.OutputReasoningItemStatusUnionTypeOutputReasoningItemStatusInProgress: - // outputReasoningItemStatusUnion.OutputReasoningItemStatusInProgress is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputreasoningitemtype.mdx b/client-sdks/go/api-reference/models/outputreasoningitemtype.mdx deleted file mode 100644 index caae1a71..00000000 --- a/client-sdks/go/api-reference/models/outputreasoningitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputReasoningItemType - Go SDK -sidebarTitle: OutputReasoningItemType -description: OutputReasoningItemType type definition -seoTitle: OutputReasoningItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputreasoningitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemType Type | OpenRouter Go SDK -'og:description': >- - OutputReasoningItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemType%20-%20Go%20SDK&description=OutputReasoningItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputReasoningItemTypeReasoning -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `OutputReasoningItemTypeReasoning` | reasoning | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitem.mdx b/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitem.mdx deleted file mode 100644 index 0a61eae0..00000000 --- a/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputSearchModelsServerToolItem - Go SDK -sidebarTitle: OutputSearchModelsServerToolItem -description: OutputSearchModelsServerToolItem type definition -seoTitle: OutputSearchModelsServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputsearchmodelsservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputSearchModelsServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItem%20-%20Go%20SDK&description=OutputSearchModelsServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:experimental__search_models server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Arguments` | `*string` | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. `{"query":"Claude"}`) | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Query` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputSearchModelsServerToolItemType](/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitemtype.mdx deleted file mode 100644 index 55ec6106..00000000 --- a/client-sdks/go/api-reference/models/outputsearchmodelsservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputSearchModelsServerToolItemType - Go SDK -sidebarTitle: OutputSearchModelsServerToolItemType -description: OutputSearchModelsServerToolItemType type definition -seoTitle: OutputSearchModelsServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputsearchmodelsservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputSearchModelsServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItemType%20-%20Go%20SDK&description=OutputSearchModelsServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputSearchModelsServerToolItemTypeOpenrouterExperimentalSearchModels -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `OutputSearchModelsServerToolItemTypeOpenrouterExperimentalSearchModels` | openrouter:experimental__search_models | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputtexteditorservertoolitem.mdx b/client-sdks/go/api-reference/models/outputtexteditorservertoolitem.mdx deleted file mode 100644 index fbc8c77a..00000000 --- a/client-sdks/go/api-reference/models/outputtexteditorservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputTextEditorServerToolItem - Go SDK -sidebarTitle: OutputTextEditorServerToolItem -description: OutputTextEditorServerToolItem type definition -seoTitle: OutputTextEditorServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputtexteditorservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputTextEditorServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItem%20-%20Go%20SDK&description=OutputTextEditorServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:text_editor server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Command` | [*components.Command](/client-sdks/go/api-reference/models/command) | :heavy_minus_sign: | N/A | | -| `FilePath` | `*string` | :heavy_minus_sign: | N/A | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputTextEditorServerToolItemType](/client-sdks/go/api-reference/models/outputtexteditorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputtexteditorservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputtexteditorservertoolitemtype.mdx deleted file mode 100644 index 8e9728a4..00000000 --- a/client-sdks/go/api-reference/models/outputtexteditorservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputTextEditorServerToolItemType - Go SDK -sidebarTitle: OutputTextEditorServerToolItemType -description: OutputTextEditorServerToolItemType type definition -seoTitle: OutputTextEditorServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputtexteditorservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputTextEditorServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItemType%20-%20Go%20SDK&description=OutputTextEditorServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputTextEditorServerToolItemTypeOpenrouterTextEditor -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `OutputTextEditorServerToolItemTypeOpenrouterTextEditor` | openrouter:text_editor | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputtokensdetails.mdx b/client-sdks/go/api-reference/models/outputtokensdetails.mdx deleted file mode 100644 index 2777d398..00000000 --- a/client-sdks/go/api-reference/models/outputtokensdetails.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OutputTokensDetails - Go SDK -sidebarTitle: OutputTokensDetails -description: OutputTokensDetails type definition -seoTitle: OutputTokensDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/outputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': OutputTokensDetails Type | OpenRouter Go SDK -'og:description': >- - OutputTokensDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTokensDetails%20-%20Go%20SDK&description=OutputTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `ReasoningTokens` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputtoolsearchservertoolitem.mdx b/client-sdks/go/api-reference/models/outputtoolsearchservertoolitem.mdx deleted file mode 100644 index 875ac03a..00000000 --- a/client-sdks/go/api-reference/models/outputtoolsearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputToolSearchServerToolItem - Go SDK -sidebarTitle: OutputToolSearchServerToolItem -description: OutputToolSearchServerToolItem type definition -seoTitle: OutputToolSearchServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputtoolsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputToolSearchServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItem%20-%20Go%20SDK&description=OutputToolSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:tool_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Query` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputToolSearchServerToolItemType](/client-sdks/go/api-reference/models/outputtoolsearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputtoolsearchservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputtoolsearchservertoolitemtype.mdx deleted file mode 100644 index 95979797..00000000 --- a/client-sdks/go/api-reference/models/outputtoolsearchservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputToolSearchServerToolItemType - Go SDK -sidebarTitle: OutputToolSearchServerToolItemType -description: OutputToolSearchServerToolItemType type definition -seoTitle: OutputToolSearchServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputtoolsearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputToolSearchServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItemType%20-%20Go%20SDK&description=OutputToolSearchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputToolSearchServerToolItemTypeOpenrouterToolSearch -``` - -## Values - -| Name | Value | -| -------------------------------------------------------- | -------------------------------------------------------- | -| `OutputToolSearchServerToolItemTypeOpenrouterToolSearch` | openrouter:tool_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebfetchservertoolitem.mdx b/client-sdks/go/api-reference/models/outputwebfetchservertoolitem.mdx deleted file mode 100644 index 0120cf77..00000000 --- a/client-sdks/go/api-reference/models/outputwebfetchservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputWebFetchServerToolItem - Go SDK -sidebarTitle: OutputWebFetchServerToolItem -description: OutputWebFetchServerToolItem type definition -seoTitle: OutputWebFetchServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebfetchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputWebFetchServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItem%20-%20Go%20SDK&description=OutputWebFetchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:web_fetch server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Content` | `*string` | :heavy_minus_sign: | N/A | | -| `Error` | `*string` | :heavy_minus_sign: | The error message if the fetch failed. | | -| `HTTPStatus` | `*int64` | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Title` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputWebFetchServerToolItemType](/client-sdks/go/api-reference/models/outputwebfetchservertoolitemtype) | :heavy_check_mark: | N/A | | -| `URL` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebfetchservertoolitemtype.mdx b/client-sdks/go/api-reference/models/outputwebfetchservertoolitemtype.mdx deleted file mode 100644 index 457d1854..00000000 --- a/client-sdks/go/api-reference/models/outputwebfetchservertoolitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputWebFetchServerToolItemType - Go SDK -sidebarTitle: OutputWebFetchServerToolItemType -description: OutputWebFetchServerToolItemType type definition -seoTitle: OutputWebFetchServerToolItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebfetchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItemType Type | OpenRouter Go SDK -'og:description': >- - OutputWebFetchServerToolItemType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItemType%20-%20Go%20SDK&description=OutputWebFetchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputWebFetchServerToolItemTypeOpenrouterWebFetch -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `OutputWebFetchServerToolItemTypeOpenrouterWebFetch` | openrouter:web_fetch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchcallitem.mdx b/client-sdks/go/api-reference/models/outputwebsearchcallitem.mdx deleted file mode 100644 index 9af02be0..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputWebSearchCallItem - Go SDK -sidebarTitle: OutputWebSearchCallItem -description: OutputWebSearchCallItem type definition -seoTitle: OutputWebSearchCallItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItem Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchCallItem type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItem%20-%20Go%20SDK&description=OutputWebSearchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Action` | [components.Action](/client-sdks/go/api-reference/models/action) | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](/client-sdks/go/api-reference/models/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeWebSearchCall](/client-sdks/go/api-reference/models/typewebsearchcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchcallitemactionsearch.mdx b/client-sdks/go/api-reference/models/outputwebsearchcallitemactionsearch.mdx deleted file mode 100644 index 8b535837..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchcallitemactionsearch.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputWebSearchCallItemActionSearch - Go SDK -sidebarTitle: OutputWebSearchCallItemActionSearch -description: OutputWebSearchCallItemActionSearch type definition -seoTitle: OutputWebSearchCallItemActionSearch Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchcallitemactionsearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItemActionSearch Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchCallItemActionSearch type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItemActionSearch%20-%20Go%20SDK&description=OutputWebSearchCallItemActionSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Queries` | []`string` | :heavy_minus_sign: | N/A | -| `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.WebSearchSource](/client-sdks/go/api-reference/models/websearchsource) | :heavy_minus_sign: | N/A | -| `Type` | [components.ActionTypeSearch](/client-sdks/go/api-reference/models/actiontypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitem.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitem.mdx deleted file mode 100644 index cd685ce2..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputWebSearchServerToolItem - Go SDK -sidebarTitle: OutputWebSearchServerToolItem -description: OutputWebSearchServerToolItem type definition -seoTitle: OutputWebSearchServerToolItem Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItem Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItem type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItem%20-%20Go%20SDK&description=OutputWebSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -An openrouter:web_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.OutputWebSearchServerToolItemAction](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemaction.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitemaction.mdx deleted file mode 100644 index 8e79e591..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemaction.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OutputWebSearchServerToolItemAction - Go SDK -sidebarTitle: OutputWebSearchServerToolItemAction -description: OutputWebSearchServerToolItemAction type definition -seoTitle: OutputWebSearchServerToolItemAction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitemaction -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemAction Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItemAction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemAction%20-%20Go%20SDK&description=OutputWebSearchServerToolItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.OutputWebSearchServerToolItemSource](/client-sdks/go/api-reference/models/outputwebsearchservertoolitemsource) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemsource.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitemsource.mdx deleted file mode 100644 index da0f4315..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemsource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OutputWebSearchServerToolItemSource - Go SDK -sidebarTitle: OutputWebSearchServerToolItemSource -description: OutputWebSearchServerToolItemSource type definition -seoTitle: OutputWebSearchServerToolItemSource Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitemsource -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemSource Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItemSource type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemSource%20-%20Go%20SDK&description=OutputWebSearchServerToolItemSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OutputWebSearchServerToolItemTypeURL](/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeurl) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx deleted file mode 100644 index f0c03a14..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeOpenrouterWebSearch - Go SDK -sidebarTitle: OutputWebSearchServerToolItemTypeOpenrouterWebSearch -description: OutputWebSearchServerToolItemTypeOpenrouterWebSearch type definition -seoTitle: OutputWebSearchServerToolItemTypeOpenrouterWebSearch Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeOpenrouterWebSearch Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItemTypeOpenrouterWebSearch type reference for the - OpenRouter Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20-%20Go%20SDK&description=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputWebSearchServerToolItemTypeOpenrouterWebSearchOpenrouterWebSearch -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `OutputWebSearchServerToolItemTypeOpenrouterWebSearchOpenrouterWebSearch` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx deleted file mode 100644 index a8366bf4..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeSearch - Go SDK -sidebarTitle: OutputWebSearchServerToolItemTypeSearch -description: OutputWebSearchServerToolItemTypeSearch type definition -seoTitle: OutputWebSearchServerToolItemTypeSearch Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitemtypesearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeSearch Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItemTypeSearch type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeSearch%20-%20Go%20SDK&description=OutputWebSearchServerToolItemTypeSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputWebSearchServerToolItemTypeSearchSearch -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `OutputWebSearchServerToolItemTypeSearchSearch` | search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx b/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx deleted file mode 100644 index af4869aa..00000000 --- a/client-sdks/go/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeURL - Go SDK -sidebarTitle: OutputWebSearchServerToolItemTypeURL -description: OutputWebSearchServerToolItemTypeURL type definition -seoTitle: OutputWebSearchServerToolItemTypeURL Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/outputwebsearchservertoolitemtypeurl -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeURL Type | OpenRouter Go SDK -'og:description': >- - OutputWebSearchServerToolItemTypeURL type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeURL%20-%20Go%20SDK&description=OutputWebSearchServerToolItemTypeURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.OutputWebSearchServerToolItemTypeURLURL -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `OutputWebSearchServerToolItemTypeURLURL` | url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/parameter.mdx b/client-sdks/go/api-reference/models/parameter.mdx deleted file mode 100644 index 03affd71..00000000 --- a/client-sdks/go/api-reference/models/parameter.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Parameter - Go SDK -sidebarTitle: Parameter -description: Parameter type definition -seoTitle: Parameter Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/parameter' -'og:site_name': OpenRouter Documentation -'og:title': Parameter Type | OpenRouter Go SDK -'og:description': >- - Parameter type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Parameter%20-%20Go%20SDK&description=Parameter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ParameterTemperature - -// Open enum: custom values can be created with a direct type cast -custom := components.Parameter("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ParameterTemperature` | temperature | -| `ParameterTopP` | top_p | -| `ParameterTopK` | top_k | -| `ParameterMinP` | min_p | -| `ParameterTopA` | top_a | -| `ParameterFrequencyPenalty` | frequency_penalty | -| `ParameterPresencePenalty` | presence_penalty | -| `ParameterRepetitionPenalty` | repetition_penalty | -| `ParameterMaxTokens` | max_tokens | -| `ParameterMaxCompletionTokens` | max_completion_tokens | -| `ParameterLogitBias` | logit_bias | -| `ParameterLogprobs` | logprobs | -| `ParameterTopLogprobs` | top_logprobs | -| `ParameterSeed` | seed | -| `ParameterResponseFormat` | response_format | -| `ParameterStructuredOutputs` | structured_outputs | -| `ParameterStop` | stop | -| `ParameterTools` | tools | -| `ParameterToolChoice` | tool_choice | -| `ParameterParallelToolCalls` | parallel_tool_calls | -| `ParameterIncludeReasoning` | include_reasoning | -| `ParameterReasoning` | reasoning | -| `ParameterReasoningEffort` | reasoning_effort | -| `ParameterWebSearchOptions` | web_search_options | -| `ParameterVerbosity` | verbosity | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/paretorouterplugin.mdx b/client-sdks/go/api-reference/models/paretorouterplugin.mdx deleted file mode 100644 index dab0d314..00000000 --- a/client-sdks/go/api-reference/models/paretorouterplugin.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ParetoRouterPlugin - Go SDK -sidebarTitle: ParetoRouterPlugin -description: ParetoRouterPlugin type definition -seoTitle: ParetoRouterPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/paretorouterplugin' -'og:site_name': OpenRouter Documentation -'og:title': ParetoRouterPlugin Type | OpenRouter Go SDK -'og:description': >- - ParetoRouterPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ParetoRouterPlugin%20-%20Go%20SDK&description=ParetoRouterPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/paretorouterpluginid) | :heavy_check_mark: | N/A | | -| `MinCodingScore` | `*float64` | :heavy_minus_sign: | Minimum desired coding score between 0 and 1, where 1 is best. Higher values select from stronger coding models (sourced from Artificial Analysis coding percentiles). Maps internally to one of three tiers (low, medium, high). Omit to use the router default tier. | 0.8 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/paretorouterpluginid.mdx b/client-sdks/go/api-reference/models/paretorouterpluginid.mdx deleted file mode 100644 index 8dd168ee..00000000 --- a/client-sdks/go/api-reference/models/paretorouterpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ParetoRouterPluginID - Go SDK -sidebarTitle: ParetoRouterPluginID -description: ParetoRouterPluginID type definition -seoTitle: ParetoRouterPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/paretorouterpluginid' -'og:site_name': OpenRouter Documentation -'og:title': ParetoRouterPluginID Type | OpenRouter Go SDK -'og:description': >- - ParetoRouterPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ParetoRouterPluginID%20-%20Go%20SDK&description=ParetoRouterPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ParetoRouterPluginIDParetoRouter -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ParetoRouterPluginIDParetoRouter` | pareto-router | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/partialcoverage.mdx b/client-sdks/go/api-reference/models/partialcoverage.mdx deleted file mode 100644 index 980ff275..00000000 --- a/client-sdks/go/api-reference/models/partialcoverage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PartialCoverage - Go SDK -sidebarTitle: PartialCoverage -description: PartialCoverage type definition -seoTitle: PartialCoverage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/partialcoverage' -'og:site_name': OpenRouter Documentation -'og:title': PartialCoverage Type | OpenRouter Go SDK -'og:description': >- - PartialCoverage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PartialCoverage%20-%20Go%20SDK&description=PartialCoverage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Models` | []`string` | :heavy_check_mark: | N/A | -| `Point` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/partition.mdx b/client-sdks/go/api-reference/models/partition.mdx deleted file mode 100644 index 094a58e7..00000000 --- a/client-sdks/go/api-reference/models/partition.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Partition - Go SDK -sidebarTitle: Partition -description: Partition type definition -seoTitle: Partition Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/partition' -'og:site_name': OpenRouter Documentation -'og:title': Partition Type | OpenRouter Go SDK -'og:description': >- - Partition type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Partition%20-%20Go%20SDK&description=Partition%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PartitionModel - -// Open enum: custom values can be created with a direct type cast -custom := components.Partition("custom_value") -``` - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `PartitionModel` | model | -| `PartitionNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/payloadtoolargeresponseerror.mdx b/client-sdks/go/api-reference/models/payloadtoolargeresponseerror.mdx deleted file mode 100644 index 34afef67..00000000 --- a/client-sdks/go/api-reference/models/payloadtoolargeresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PayloadTooLargeResponseError - Go SDK -sidebarTitle: PayloadTooLargeResponseError -description: PayloadTooLargeResponseError type definition -seoTitle: PayloadTooLargeResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/payloadtoolargeresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseError Type | OpenRouter Go SDK -'og:description': >- - PayloadTooLargeResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseError%20-%20Go%20SDK&description=PayloadTooLargeResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Payload Too Large - Request payload exceeds size limits - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PayloadTooLargeResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/payloadtoolargeresponseerrordata.mdx b/client-sdks/go/api-reference/models/payloadtoolargeresponseerrordata.mdx deleted file mode 100644 index de919d19..00000000 --- a/client-sdks/go/api-reference/models/payloadtoolargeresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PayloadTooLargeResponseErrorData - Go SDK -sidebarTitle: PayloadTooLargeResponseErrorData -description: PayloadTooLargeResponseErrorData type definition -seoTitle: PayloadTooLargeResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/payloadtoolargeresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - PayloadTooLargeResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseErrorData%20-%20Go%20SDK&description=PayloadTooLargeResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for PayloadTooLargeResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/paymentrequiredresponseerror.mdx b/client-sdks/go/api-reference/models/paymentrequiredresponseerror.mdx deleted file mode 100644 index ca7a02dd..00000000 --- a/client-sdks/go/api-reference/models/paymentrequiredresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PaymentRequiredResponseError - Go SDK -sidebarTitle: PaymentRequiredResponseError -description: PaymentRequiredResponseError type definition -seoTitle: PaymentRequiredResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/paymentrequiredresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseError Type | OpenRouter Go SDK -'og:description': >- - PaymentRequiredResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseError%20-%20Go%20SDK&description=PaymentRequiredResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Payment Required - Insufficient credits or quota to complete request - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PaymentRequiredResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/paymentrequiredresponseerrordata.mdx b/client-sdks/go/api-reference/models/paymentrequiredresponseerrordata.mdx deleted file mode 100644 index dd4a76a5..00000000 --- a/client-sdks/go/api-reference/models/paymentrequiredresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PaymentRequiredResponseErrorData - Go SDK -sidebarTitle: PaymentRequiredResponseErrorData -description: PaymentRequiredResponseErrorData type definition -seoTitle: PaymentRequiredResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/paymentrequiredresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - PaymentRequiredResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseErrorData%20-%20Go%20SDK&description=PaymentRequiredResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for PaymentRequiredResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pdfparserengine.mdx b/client-sdks/go/api-reference/models/pdfparserengine.mdx deleted file mode 100644 index b749084a..00000000 --- a/client-sdks/go/api-reference/models/pdfparserengine.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: PDFParserEngine - Go SDK -sidebarTitle: PDFParserEngine -description: PDFParserEngine type definition -seoTitle: PDFParserEngine Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pdfparserengine' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngine Type | OpenRouter Go SDK -'og:description': >- - PDFParserEngine type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngine%20-%20Go%20SDK&description=PDFParserEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". - -## Supported Types - -### PDFParserEngineEnum - -```go lines -pdfParserEngine := components.CreatePDFParserEnginePDFParserEngineEnum(components.PDFParserEngineEnum{/* values here */}) -``` - -### PDFParserEnginePDFText - -```go lines -pdfParserEngine := components.CreatePDFParserEnginePDFParserEnginePDFText(components.PDFParserEnginePDFText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch pdfParserEngine.Type { - case components.PDFParserEngineTypePDFParserEngineEnum: - // pdfParserEngine.PDFParserEngineEnum is populated - case components.PDFParserEngineTypePDFParserEnginePDFText: - // pdfParserEngine.PDFParserEnginePDFText is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pdfparserengineenum.mdx b/client-sdks/go/api-reference/models/pdfparserengineenum.mdx deleted file mode 100644 index 38a85519..00000000 --- a/client-sdks/go/api-reference/models/pdfparserengineenum.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PDFParserEngineEnum - Go SDK -sidebarTitle: PDFParserEngineEnum -description: PDFParserEngineEnum type definition -seoTitle: PDFParserEngineEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pdfparserengineenum' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngineEnum Type | OpenRouter Go SDK -'og:description': >- - PDFParserEngineEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngineEnum%20-%20Go%20SDK&description=PDFParserEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PDFParserEngineEnumMistralOcr - -// Open enum: custom values can be created with a direct type cast -custom := components.PDFParserEngineEnum("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------- | --------------------------------- | -| `PDFParserEngineEnumMistralOcr` | mistral-ocr | -| `PDFParserEngineEnumNative` | native | -| `PDFParserEngineEnumCloudflareAi` | cloudflare-ai | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pdfparserenginepdftext.mdx b/client-sdks/go/api-reference/models/pdfparserenginepdftext.mdx deleted file mode 100644 index 73897de7..00000000 --- a/client-sdks/go/api-reference/models/pdfparserenginepdftext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PDFParserEnginePDFText - Go SDK -sidebarTitle: PDFParserEnginePDFText -description: PDFParserEnginePDFText type definition -seoTitle: PDFParserEnginePDFText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pdfparserenginepdftext' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEnginePDFText Type | OpenRouter Go SDK -'og:description': >- - PDFParserEnginePDFText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEnginePDFText%20-%20Go%20SDK&description=PDFParserEnginePDFText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PDFParserEnginePDFTextPdfText -``` - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `PDFParserEnginePDFTextPdfText` | pdf-text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pdfparseroptions.mdx b/client-sdks/go/api-reference/models/pdfparseroptions.mdx deleted file mode 100644 index cdb3bcef..00000000 --- a/client-sdks/go/api-reference/models/pdfparseroptions.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PDFParserOptions - Go SDK -sidebarTitle: PDFParserOptions -description: PDFParserOptions type definition -seoTitle: PDFParserOptions Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pdfparseroptions' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserOptions Type | OpenRouter Go SDK -'og:description': >- - PDFParserOptions type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserOptions%20-%20Go%20SDK&description=PDFParserOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Options for PDF parsing. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.PDFParserEngine](/client-sdks/go/api-reference/models/pdfparserengine) | :heavy_minus_sign: | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pendingsafetycheck.mdx b/client-sdks/go/api-reference/models/pendingsafetycheck.mdx deleted file mode 100644 index de5862b4..00000000 --- a/client-sdks/go/api-reference/models/pendingsafetycheck.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PendingSafetyCheck - Go SDK -sidebarTitle: PendingSafetyCheck -description: PendingSafetyCheck type definition -seoTitle: PendingSafetyCheck Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pendingsafetycheck' -'og:site_name': OpenRouter Documentation -'og:title': PendingSafetyCheck Type | OpenRouter Go SDK -'og:description': >- - PendingSafetyCheck type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PendingSafetyCheck%20-%20Go%20SDK&description=PendingSafetyCheck%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Code` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/percentilelatencycutoffs.mdx b/client-sdks/go/api-reference/models/percentilelatencycutoffs.mdx deleted file mode 100644 index d445862a..00000000 --- a/client-sdks/go/api-reference/models/percentilelatencycutoffs.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PercentileLatencyCutoffs - Go SDK -sidebarTitle: PercentileLatencyCutoffs -description: PercentileLatencyCutoffs type definition -seoTitle: PercentileLatencyCutoffs Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/percentilelatencycutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileLatencyCutoffs Type | OpenRouter Go SDK -'og:description': >- - PercentileLatencyCutoffs type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileLatencyCutoffs%20-%20Go%20SDK&description=PercentileLatencyCutoffs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Percentile-based latency cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/percentilestats.mdx b/client-sdks/go/api-reference/models/percentilestats.mdx deleted file mode 100644 index d733a2c0..00000000 --- a/client-sdks/go/api-reference/models/percentilestats.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PercentileStats - Go SDK -sidebarTitle: PercentileStats -description: PercentileStats type definition -seoTitle: PercentileStats Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/percentilestats' -'og:site_name': OpenRouter Documentation -'og:title': PercentileStats Type | OpenRouter Go SDK -'og:description': >- - PercentileStats type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileStats%20-%20Go%20SDK&description=PercentileStats%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `P50` | `float64` | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `P75` | `float64` | :heavy_check_mark: | 75th percentile | 35.2 | -| `P90` | `float64` | :heavy_check_mark: | 90th percentile | 48.7 | -| `P99` | `float64` | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/percentilethroughputcutoffs.mdx b/client-sdks/go/api-reference/models/percentilethroughputcutoffs.mdx deleted file mode 100644 index dab3a394..00000000 --- a/client-sdks/go/api-reference/models/percentilethroughputcutoffs.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PercentileThroughputCutoffs - Go SDK -sidebarTitle: PercentileThroughputCutoffs -description: PercentileThroughputCutoffs type definition -seoTitle: PercentileThroughputCutoffs Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/percentilethroughputcutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileThroughputCutoffs Type | OpenRouter Go SDK -'og:description': >- - PercentileThroughputCutoffs type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileThroughputCutoffs%20-%20Go%20SDK&description=PercentileThroughputCutoffs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Percentile-based throughput cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `P50` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `P75` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `P90` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `P99` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/perrequestlimits.mdx b/client-sdks/go/api-reference/models/perrequestlimits.mdx deleted file mode 100644 index 27298c36..00000000 --- a/client-sdks/go/api-reference/models/perrequestlimits.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PerRequestLimits - Go SDK -sidebarTitle: PerRequestLimits -description: PerRequestLimits type definition -seoTitle: PerRequestLimits Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/perrequestlimits' -'og:site_name': OpenRouter Documentation -'og:title': PerRequestLimits Type | OpenRouter Go SDK -'og:description': >- - PerRequestLimits type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PerRequestLimits%20-%20Go%20SDK&description=PerRequestLimits%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Per-request token limits - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `CompletionTokens` | `float64` | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `PromptTokens` | `float64` | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pipelinestage.mdx b/client-sdks/go/api-reference/models/pipelinestage.mdx deleted file mode 100644 index 6d014872..00000000 --- a/client-sdks/go/api-reference/models/pipelinestage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PipelineStage - Go SDK -sidebarTitle: PipelineStage -description: PipelineStage type definition -seoTitle: PipelineStage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pipelinestage' -'og:site_name': OpenRouter Documentation -'og:title': PipelineStage Type | OpenRouter Go SDK -'og:description': >- - PipelineStage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStage%20-%20Go%20SDK&description=PipelineStage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CostUsd` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Data` | map[string]`any` | :heavy_minus_sign: | N/A | | -| `GuardrailID` | `*string` | :heavy_minus_sign: | N/A | | -| `GuardrailScope` | `*string` | :heavy_minus_sign: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Summary` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.PipelineStageType](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/pipelinestagetype.mdx b/client-sdks/go/api-reference/models/pipelinestagetype.mdx deleted file mode 100644 index 62c8fc26..00000000 --- a/client-sdks/go/api-reference/models/pipelinestagetype.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: PipelineStageType - Go SDK -sidebarTitle: PipelineStageType -description: PipelineStageType type definition -seoTitle: PipelineStageType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pipelinestagetype' -'og:site_name': OpenRouter Documentation -'og:title': PipelineStageType Type | OpenRouter Go SDK -'og:description': >- - PipelineStageType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStageType%20-%20Go%20SDK&description=PipelineStageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PipelineStageTypeGuardrail - -// Open enum: custom values can be created with a direct type cast -custom := components.PipelineStageType("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `PipelineStageTypeGuardrail` | guardrail | -| `PipelineStageTypePlugin` | plugin | -| `PipelineStageTypeServerTools` | server_tools | -| `PipelineStageTypeResponseHealing` | response_healing | -| `PipelineStageTypeContextCompression` | context_compression | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/preferredmaxlatency.mdx b/client-sdks/go/api-reference/models/preferredmaxlatency.mdx deleted file mode 100644 index 05d11e82..00000000 --- a/client-sdks/go/api-reference/models/preferredmaxlatency.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: PreferredMaxLatency - Go SDK -sidebarTitle: PreferredMaxLatency -description: PreferredMaxLatency type definition -seoTitle: PreferredMaxLatency Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/preferredmaxlatency' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMaxLatency Type | OpenRouter Go SDK -'og:description': >- - PreferredMaxLatency type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMaxLatency%20-%20Go%20SDK&description=PreferredMaxLatency%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### - -```go lines -preferredMaxLatency := components.CreatePreferredMaxLatencyNumber(float64{/* values here */}) -``` - -### PercentileLatencyCutoffs - -```go lines -preferredMaxLatency := components.CreatePreferredMaxLatencyPercentileLatencyCutoffs(components.PercentileLatencyCutoffs{/* values here */}) -``` - -### - -```go lines -preferredMaxLatency := components.CreatePreferredMaxLatencyAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch preferredMaxLatency.Type { - case components.PreferredMaxLatencyTypeNumber: - // preferredMaxLatency.Number is populated - case components.PreferredMaxLatencyTypePercentileLatencyCutoffs: - // preferredMaxLatency.PercentileLatencyCutoffs is populated - case components.PreferredMaxLatencyTypeAny: - // preferredMaxLatency.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/preferredminthroughput.mdx b/client-sdks/go/api-reference/models/preferredminthroughput.mdx deleted file mode 100644 index fd0e38ba..00000000 --- a/client-sdks/go/api-reference/models/preferredminthroughput.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: PreferredMinThroughput - Go SDK -sidebarTitle: PreferredMinThroughput -description: PreferredMinThroughput type definition -seoTitle: PreferredMinThroughput Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/preferredminthroughput' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMinThroughput Type | OpenRouter Go SDK -'og:description': >- - PreferredMinThroughput type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMinThroughput%20-%20Go%20SDK&description=PreferredMinThroughput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### - -```go lines -preferredMinThroughput := components.CreatePreferredMinThroughputNumber(float64{/* values here */}) -``` - -### PercentileThroughputCutoffs - -```go lines -preferredMinThroughput := components.CreatePreferredMinThroughputPercentileThroughputCutoffs(components.PercentileThroughputCutoffs{/* values here */}) -``` - -### - -```go lines -preferredMinThroughput := components.CreatePreferredMinThroughputAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch preferredMinThroughput.Type { - case components.PreferredMinThroughputTypeNumber: - // preferredMinThroughput.Number is populated - case components.PreferredMinThroughputTypePercentileThroughputCutoffs: - // preferredMinThroughput.PercentileThroughputCutoffs is populated - case components.PreferredMinThroughputTypeAny: - // preferredMinThroughput.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/presetdesignatedversion.mdx b/client-sdks/go/api-reference/models/presetdesignatedversion.mdx deleted file mode 100644 index 86a15b12..00000000 --- a/client-sdks/go/api-reference/models/presetdesignatedversion.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PresetDesignatedVersion - Go SDK -sidebarTitle: PresetDesignatedVersion -description: PresetDesignatedVersion type definition -seoTitle: PresetDesignatedVersion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/presetdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetDesignatedVersion Type | OpenRouter Go SDK -'og:description': >- - PresetDesignatedVersion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetDesignatedVersion%20-%20Go%20SDK&description=PresetDesignatedVersion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A specific version of a preset, containing config and optional system prompt. - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Config` | map[string]`any` | :heavy_check_mark: | N/A | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | -| `CreatorID` | `string` | :heavy_check_mark: | N/A | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `PresetID` | `string` | :heavy_check_mark: | N/A | -| `SystemPrompt` | `*string` | :heavy_check_mark: | N/A | -| `UpdatedAt` | `string` | :heavy_check_mark: | N/A | -| `Version` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/presetwithdesignatedversion.mdx b/client-sdks/go/api-reference/models/presetwithdesignatedversion.mdx deleted file mode 100644 index fb86c0bf..00000000 --- a/client-sdks/go/api-reference/models/presetwithdesignatedversion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PresetWithDesignatedVersion - Go SDK -sidebarTitle: PresetWithDesignatedVersion -description: PresetWithDesignatedVersion type definition -seoTitle: PresetWithDesignatedVersion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/presetwithdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersion Type | OpenRouter Go SDK -'og:description': >- - PresetWithDesignatedVersion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersion%20-%20Go%20SDK&description=PresetWithDesignatedVersion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A preset with its currently designated version. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | N/A | | -| `CreatorUserID` | `*string` | :heavy_check_mark: | N/A | | -| `Description` | `*string` | :heavy_check_mark: | N/A | | -| `DesignatedVersion` | [*components.PresetDesignatedVersion](/client-sdks/go/api-reference/models/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
`\} | -| `DesignatedVersionID` | `*string` | :heavy_check_mark: | N/A | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Slug` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.PresetWithDesignatedVersionStatus](/client-sdks/go/api-reference/models/presetwithdesignatedversionstatus) | :heavy_check_mark: | N/A | | -| `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/client-sdks/go/api-reference/models/presetwithdesignatedversionstatus.mdx b/client-sdks/go/api-reference/models/presetwithdesignatedversionstatus.mdx deleted file mode 100644 index 242aba41..00000000 --- a/client-sdks/go/api-reference/models/presetwithdesignatedversionstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: PresetWithDesignatedVersionStatus - Go SDK -sidebarTitle: PresetWithDesignatedVersionStatus -description: PresetWithDesignatedVersionStatus type definition -seoTitle: PresetWithDesignatedVersionStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/presetwithdesignatedversionstatus -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersionStatus Type | OpenRouter Go SDK -'og:description': >- - PresetWithDesignatedVersionStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersionStatus%20-%20Go%20SDK&description=PresetWithDesignatedVersionStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PresetWithDesignatedVersionStatusActive - -// Open enum: custom values can be created with a direct type cast -custom := components.PresetWithDesignatedVersionStatus("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `PresetWithDesignatedVersionStatusActive` | active | -| `PresetWithDesignatedVersionStatusDisabled` | disabled | -| `PresetWithDesignatedVersionStatusArchived` | archived | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/preview20250311websearchservertool.mdx b/client-sdks/go/api-reference/models/preview20250311websearchservertool.mdx deleted file mode 100644 index b56bf122..00000000 --- a/client-sdks/go/api-reference/models/preview20250311websearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Preview20250311WebSearchServerTool - Go SDK -sidebarTitle: Preview20250311WebSearchServerTool -description: Preview20250311WebSearchServerTool type definition -seoTitle: Preview20250311WebSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/preview20250311websearchservertool -'og:site_name': OpenRouter Documentation -'og:title': Preview20250311WebSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - Preview20250311WebSearchServerTool type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Preview20250311WebSearchServerTool%20-%20Go%20SDK&description=Preview20250311WebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration (2025-03-11 version) - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](/client-sdks/go/api-reference/models/websearchdomainfilter)] | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.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, and Parallel engines; ignored with native provider search. | 5 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](/client-sdks/go/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.Preview20250311WebSearchServerToolType](/client-sdks/go/api-reference/models/preview20250311websearchservertooltype) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/preview20250311websearchservertooltype.mdx b/client-sdks/go/api-reference/models/preview20250311websearchservertooltype.mdx deleted file mode 100644 index fc9d961d..00000000 --- a/client-sdks/go/api-reference/models/preview20250311websearchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Preview20250311WebSearchServerToolType - Go SDK -sidebarTitle: Preview20250311WebSearchServerToolType -description: Preview20250311WebSearchServerToolType type definition -seoTitle: Preview20250311WebSearchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/preview20250311websearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': Preview20250311WebSearchServerToolType Type | OpenRouter Go SDK -'og:description': >- - Preview20250311WebSearchServerToolType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Preview20250311WebSearchServerToolType%20-%20Go%20SDK&description=Preview20250311WebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.Preview20250311WebSearchServerToolTypeWebSearchPreview20250311 -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Preview20250311WebSearchServerToolTypeWebSearchPreview20250311` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/previewwebsearchservertool.mdx b/client-sdks/go/api-reference/models/previewwebsearchservertool.mdx deleted file mode 100644 index 4bbec8dc..00000000 --- a/client-sdks/go/api-reference/models/previewwebsearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: PreviewWebSearchServerTool - Go SDK -sidebarTitle: PreviewWebSearchServerTool -description: PreviewWebSearchServerTool type definition -seoTitle: PreviewWebSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/previewwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - PreviewWebSearchServerTool type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchServerTool%20-%20Go%20SDK&description=PreviewWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](/client-sdks/go/api-reference/models/websearchdomainfilter)] | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.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, and Parallel engines; ignored with native provider search. | 5 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](/client-sdks/go/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.PreviewWebSearchServerToolType](/client-sdks/go/api-reference/models/previewwebsearchservertooltype) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/previewwebsearchservertooltype.mdx b/client-sdks/go/api-reference/models/previewwebsearchservertooltype.mdx deleted file mode 100644 index 28b570dc..00000000 --- a/client-sdks/go/api-reference/models/previewwebsearchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PreviewWebSearchServerToolType - Go SDK -sidebarTitle: PreviewWebSearchServerToolType -description: PreviewWebSearchServerToolType type definition -seoTitle: PreviewWebSearchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/previewwebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchServerToolType Type | OpenRouter Go SDK -'og:description': >- - PreviewWebSearchServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchServerToolType%20-%20Go%20SDK&description=PreviewWebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PreviewWebSearchServerToolTypeWebSearchPreview -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `PreviewWebSearchServerToolTypeWebSearchPreview` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/previewwebsearchuserlocation.mdx b/client-sdks/go/api-reference/models/previewwebsearchuserlocation.mdx deleted file mode 100644 index a3f62b9f..00000000 --- a/client-sdks/go/api-reference/models/previewwebsearchuserlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PreviewWebSearchUserLocation - Go SDK -sidebarTitle: PreviewWebSearchUserLocation -description: PreviewWebSearchUserLocation type definition -seoTitle: PreviewWebSearchUserLocation Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/previewwebsearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocation Type | OpenRouter Go SDK -'og:description': >- - PreviewWebSearchUserLocation type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocation%20-%20Go%20SDK&description=PreviewWebSearchUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/previewwebsearchuserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/previewwebsearchuserlocationtype.mdx b/client-sdks/go/api-reference/models/previewwebsearchuserlocationtype.mdx deleted file mode 100644 index 14da7173..00000000 --- a/client-sdks/go/api-reference/models/previewwebsearchuserlocationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PreviewWebSearchUserLocationType - Go SDK -sidebarTitle: PreviewWebSearchUserLocationType -description: PreviewWebSearchUserLocationType type definition -seoTitle: PreviewWebSearchUserLocationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/previewwebsearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocationType Type | OpenRouter Go SDK -'og:description': >- - PreviewWebSearchUserLocationType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocationType%20-%20Go%20SDK&description=PreviewWebSearchUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PreviewWebSearchUserLocationTypeApproximate -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `PreviewWebSearchUserLocationTypeApproximate` | approximate | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/pricing.mdx b/client-sdks/go/api-reference/models/pricing.mdx deleted file mode 100644 index 60f875c4..00000000 --- a/client-sdks/go/api-reference/models/pricing.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Pricing - Go SDK -sidebarTitle: Pricing -description: Pricing type definition -seoTitle: Pricing Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/pricing' -'og:site_name': OpenRouter Documentation -'og:title': Pricing Type | OpenRouter Go SDK -'og:description': >- - Pricing type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pricing%20-%20Go%20SDK&description=Pricing%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `AudioOutput` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Completion` | `string` | :heavy_check_mark: | N/A | 1000 | -| `Discount` | `*float64` | :heavy_minus_sign: | N/A | | -| `Image` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `ImageOutput` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `ImageToken` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputAudioCache` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputCacheRead` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputCacheWrite` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InternalReasoning` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Prompt` | `string` | :heavy_check_mark: | N/A | 1000 | -| `Request` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `WebSearch` | `*string` | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/prompttokensdetails.mdx b/client-sdks/go/api-reference/models/prompttokensdetails.mdx deleted file mode 100644 index 178cffa9..00000000 --- a/client-sdks/go/api-reference/models/prompttokensdetails.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PromptTokensDetails - Go SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails type definition -seoTitle: PromptTokensDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/prompttokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails Type | OpenRouter Go SDK -'og:description': >- - PromptTokensDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20Go%20SDK&description=PromptTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Detailed prompt token usage - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `AudioTokens` | `*int64` | :heavy_minus_sign: | Audio input tokens | -| `CacheWriteTokens` | `*int64` | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `CachedTokens` | `*int64` | :heavy_minus_sign: | Cached prompt tokens | -| `VideoTokens` | `*int64` | :heavy_minus_sign: | Video input tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/providername.mdx b/client-sdks/go/api-reference/models/providername.mdx deleted file mode 100644 index a97da1e0..00000000 --- a/client-sdks/go/api-reference/models/providername.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: ProviderName - Go SDK -sidebarTitle: ProviderName -description: ProviderName type definition -seoTitle: ProviderName Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/providername' -'og:site_name': OpenRouter Documentation -'og:title': ProviderName Type | OpenRouter Go SDK -'og:description': >- - ProviderName type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderName%20-%20Go%20SDK&description=ProviderName%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ProviderNameAkashMl - -// Open enum: custom values can be created with a direct type cast -custom := components.ProviderName("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `ProviderNameAkashMl` | AkashML | -| `ProviderNameAi21` | AI21 | -| `ProviderNameAionLabs` | AionLabs | -| `ProviderNameAlibaba` | Alibaba | -| `ProviderNameAmbient` | Ambient | -| `ProviderNameBaidu` | Baidu | -| `ProviderNameAmazonBedrock` | Amazon Bedrock | -| `ProviderNameAmazonNova` | Amazon Nova | -| `ProviderNameAnthropic` | Anthropic | -| `ProviderNameArceeAi` | Arcee AI | -| `ProviderNameAtlasCloud` | AtlasCloud | -| `ProviderNameAvian` | Avian | -| `ProviderNameAzure` | Azure | -| `ProviderNameBaseTen` | BaseTen | -| `ProviderNameBytePlus` | BytePlus | -| `ProviderNameBlackForestLabs` | Black Forest Labs | -| `ProviderNameCerebras` | Cerebras | -| `ProviderNameChutes` | Chutes | -| `ProviderNameCirrascale` | Cirrascale | -| `ProviderNameClarifai` | Clarifai | -| `ProviderNameCloudflare` | Cloudflare | -| `ProviderNameCohere` | Cohere | -| `ProviderNameCrucible` | Crucible | -| `ProviderNameCrusoe` | Crusoe | -| `ProviderNameDarkbloom` | Darkbloom | -| `ProviderNameDeepInfra` | DeepInfra | -| `ProviderNameDeepSeek` | DeepSeek | -| `ProviderNameDekaLlm` | DekaLLM | -| `ProviderNameDigitalOcean` | DigitalOcean | -| `ProviderNameFeatherless` | Featherless | -| `ProviderNameFireworks` | Fireworks | -| `ProviderNameFriendli` | Friendli | -| `ProviderNameGmiCloud` | GMICloud | -| `ProviderNameGoogle` | Google | -| `ProviderNameGoogleAiStudio` | Google AI Studio | -| `ProviderNameGroq` | Groq | -| `ProviderNameHyperbolic` | Hyperbolic | -| `ProviderNameInception` | Inception | -| `ProviderNameInceptron` | Inceptron | -| `ProviderNameInferenceNet` | InferenceNet | -| `ProviderNameIonstream` | Ionstream | -| `ProviderNameInfermatic` | Infermatic | -| `ProviderNameIoNet` | Io Net | -| `ProviderNameInflection` | Inflection | -| `ProviderNameLiquid` | Liquid | -| `ProviderNameMara` | Mara | -| `ProviderNameMancer2` | Mancer 2 | -| `ProviderNameMinimax` | Minimax | -| `ProviderNameModelRun` | ModelRun | -| `ProviderNameMistral` | Mistral | -| `ProviderNameModular` | Modular | -| `ProviderNameMoonshotAi` | Moonshot AI | -| `ProviderNameMorph` | Morph | -| `ProviderNameNCompass` | NCompass | -| `ProviderNameNebius` | Nebius | -| `ProviderNameNexAgi` | Nex AGI | -| `ProviderNameNextBit` | NextBit | -| `ProviderNameNovita` | Novita | -| `ProviderNameNvidia` | Nvidia | -| `ProviderNameOpenAi` | OpenAI | -| `ProviderNameOpenInference` | OpenInference | -| `ProviderNameParasail` | Parasail | -| `ProviderNamePoolside` | Poolside | -| `ProviderNamePerceptron` | Perceptron | -| `ProviderNamePerplexity` | Perplexity | -| `ProviderNamePhala` | Phala | -| `ProviderNameRecraft` | Recraft | -| `ProviderNameReka` | Reka | -| `ProviderNameRelace` | Relace | -| `ProviderNameSambaNova` | SambaNova | -| `ProviderNameSeed` | Seed | -| `ProviderNameSiliconFlow` | SiliconFlow | -| `ProviderNameSourceful` | Sourceful | -| `ProviderNameStepFun` | StepFun | -| `ProviderNameStealth` | Stealth | -| `ProviderNameStreamLake` | StreamLake | -| `ProviderNameSwitchpoint` | Switchpoint | -| `ProviderNameTogether` | Together | -| `ProviderNameUpstage` | Upstage | -| `ProviderNameVenice` | Venice | -| `ProviderNameWandB` | WandB | -| `ProviderNameXiaomi` | Xiaomi | -| `ProviderNameXAi` | xAI | -| `ProviderNameZAi` | Z.AI | -| `ProviderNameFakeProvider` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/provideroptions.mdx b/client-sdks/go/api-reference/models/provideroptions.mdx deleted file mode 100644 index d451506e..00000000 --- a/client-sdks/go/api-reference/models/provideroptions.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: ProviderOptions - Go SDK -sidebarTitle: ProviderOptions -description: ProviderOptions type definition -seoTitle: ProviderOptions Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/provideroptions' -'og:site_name': OpenRouter Documentation -'og:title': ProviderOptions Type | OpenRouter Go SDK -'og:description': >- - ProviderOptions type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOptions%20-%20Go%20SDK&description=ProviderOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `Oneai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ai21` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AionLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Akashml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Alibaba` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonBedrock` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AmazonNova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ambient` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anthropic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Anyscale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ArceeAi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `AtlasCloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Atoma` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Avian` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Azure` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baidu` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Baseten` | map[string]`any` | :heavy_minus_sign: | N/A | -| `BlackForestLabs` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Byteplus` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Centml` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cerebras` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Chutes` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cirrascale` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Clarifai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cloudflare` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Cohere` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crofai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crucible` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Crusoe` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Darkbloom` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepinfra` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Deepseek` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Dekallm` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Digitalocean` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Enfer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `FakeProvider` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Featherless` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Fireworks` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Friendli` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gmicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleAiStudio` | map[string]`any` | :heavy_minus_sign: | N/A | -| `GoogleVertex` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Gopomelo` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Groq` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Huggingface` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Hyperbolic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `HyperbolicQuantized` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inception` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `InferenceNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Infermatic` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Inocloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `IoNet` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ionstream` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Klusterai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lambda` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lepton` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Liquid` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Lynn` | map[string]`any` | :heavy_minus_sign: | N/A | -| `LynnPrivate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mancer` | map[string]`any` | :heavy_minus_sign: | N/A | -| `MancerOld` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mara` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Meta` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Minimax` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Mistral` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modelrun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Modular` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Moonshotai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Morph` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ncompass` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nebius` | map[string]`any` | :heavy_minus_sign: | N/A | -| `NexAgi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nextbit` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nineteen` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Novita` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Nvidia` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Octoai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `OpenInference` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Openai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Parasail` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perceptron` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Perplexity` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Phala` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Poolside` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recraft` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Recursal` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reflection` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Reka` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Relace` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Replicate` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sambanova` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SambanovaCloaked` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Seed` | map[string]`any` | :heavy_minus_sign: | N/A | -| `SfCompute` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Siliconflow` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Sourceful` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stealth` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Stepfun` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Streamlake` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Switchpoint` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Targon` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Together` | map[string]`any` | :heavy_minus_sign: | N/A | -| `TogetherLite` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Ubicloud` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Upstage` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Venice` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Wandb` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xai` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Xiaomi` | map[string]`any` | :heavy_minus_sign: | N/A | -| `ZAi` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/provideroverloadedresponseerror.mdx b/client-sdks/go/api-reference/models/provideroverloadedresponseerror.mdx deleted file mode 100644 index 069904d4..00000000 --- a/client-sdks/go/api-reference/models/provideroverloadedresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderOverloadedResponseError - Go SDK -sidebarTitle: ProviderOverloadedResponseError -description: ProviderOverloadedResponseError type definition -seoTitle: ProviderOverloadedResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/provideroverloadedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseError Type | OpenRouter Go SDK -'og:description': >- - ProviderOverloadedResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseError%20-%20Go%20SDK&description=ProviderOverloadedResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider Overloaded - Provider is temporarily overloaded - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ProviderOverloadedResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/provideroverloadedresponseerrordata.mdx b/client-sdks/go/api-reference/models/provideroverloadedresponseerrordata.mdx deleted file mode 100644 index 66a457f0..00000000 --- a/client-sdks/go/api-reference/models/provideroverloadedresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderOverloadedResponseErrorData - Go SDK -sidebarTitle: ProviderOverloadedResponseErrorData -description: ProviderOverloadedResponseErrorData type definition -seoTitle: ProviderOverloadedResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/provideroverloadedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - ProviderOverloadedResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseErrorData%20-%20Go%20SDK&description=ProviderOverloadedResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for ProviderOverloadedResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/providerpreferences.mdx b/client-sdks/go/api-reference/models/providerpreferences.mdx deleted file mode 100644 index e97e3f04..00000000 --- a/client-sdks/go/api-reference/models/providerpreferences.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ProviderPreferences - Go SDK -sidebarTitle: ProviderPreferences -description: ProviderPreferences type definition -seoTitle: ProviderPreferences Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/providerpreferences' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferences Type | OpenRouter Go SDK -'og:description': >- - ProviderPreferences type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferences%20-%20Go%20SDK&description=ProviderPreferences%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -When multiple model providers are available, optionally indicate your routing preference. - -## Fields - -| 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](/client-sdks/go/api-reference/models/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.Ignore](/client-sdks/go/api-reference/models/ignore)] | :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](/client-sdks/go/api-reference/models/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.Only](/client-sdks/go/api-reference/models/only)] | :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.Order](/client-sdks/go/api-reference/models/order)] | :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](/client-sdks/go/api-reference/models/preferredmaxlatency)] | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | -| `PreferredMinThroughput` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](/client-sdks/go/api-reference/models/preferredminthroughput)] | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `Quantizations` | optionalnullable.OptionalNullable[[][components.Quantization](/client-sdks/go/api-reference/models/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.Sort](/client-sdks/go/api-reference/models/sort)] | :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/client-sdks/go/api-reference/models/providerresponse.mdx b/client-sdks/go/api-reference/models/providerresponse.mdx deleted file mode 100644 index bfd4301e..00000000 --- a/client-sdks/go/api-reference/models/providerresponse.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ProviderResponse - Go SDK -sidebarTitle: ProviderResponse -description: ProviderResponse type definition -seoTitle: ProviderResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/providerresponse' -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponse Type | OpenRouter Go SDK -'og:description': >- - ProviderResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponse%20-%20Go%20SDK&description=ProviderResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Details of a provider response for a generation attempt - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `EndpointID` | `*string` | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `ID` | `*string` | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `IsByok` | `*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](/client-sdks/go/api-reference/models/providerresponseprovidername) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `Status` | `*float64` | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/providerresponseprovidername.mdx b/client-sdks/go/api-reference/models/providerresponseprovidername.mdx deleted file mode 100644 index 8bf69796..00000000 --- a/client-sdks/go/api-reference/models/providerresponseprovidername.mdx +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: ProviderResponseProviderName - Go SDK -sidebarTitle: ProviderResponseProviderName -description: ProviderResponseProviderName type definition -seoTitle: ProviderResponseProviderName Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/providerresponseprovidername -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponseProviderName Type | OpenRouter Go SDK -'og:description': >- - ProviderResponseProviderName type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponseProviderName%20-%20Go%20SDK&description=ProviderResponseProviderName%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Name of the provider - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ProviderResponseProviderNameAnyScale - -// Open enum: custom values can be created with a direct type cast -custom := components.ProviderResponseProviderName("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ProviderResponseProviderNameAnyScale` | AnyScale | -| `ProviderResponseProviderNameAtoma` | Atoma | -| `ProviderResponseProviderNameCentMl` | Cent-ML | -| `ProviderResponseProviderNameCrofAi` | CrofAI | -| `ProviderResponseProviderNameEnfer` | Enfer | -| `ProviderResponseProviderNameGoPomelo` | GoPomelo | -| `ProviderResponseProviderNameHuggingFace` | HuggingFace | -| `ProviderResponseProviderNameHyperbolic2` | Hyperbolic 2 | -| `ProviderResponseProviderNameInoCloud` | InoCloud | -| `ProviderResponseProviderNameKluster` | Kluster | -| `ProviderResponseProviderNameLambda` | Lambda | -| `ProviderResponseProviderNameLepton` | Lepton | -| `ProviderResponseProviderNameLynn2` | Lynn 2 | -| `ProviderResponseProviderNameLynn` | Lynn | -| `ProviderResponseProviderNameMancer` | Mancer | -| `ProviderResponseProviderNameMeta` | Meta | -| `ProviderResponseProviderNameModal` | Modal | -| `ProviderResponseProviderNameNineteen` | Nineteen | -| `ProviderResponseProviderNameOctoAi` | OctoAI | -| `ProviderResponseProviderNameRecursal` | Recursal | -| `ProviderResponseProviderNameReflection` | Reflection | -| `ProviderResponseProviderNameReplicate` | Replicate | -| `ProviderResponseProviderNameSambaNova2` | SambaNova 2 | -| `ProviderResponseProviderNameSfCompute` | SF Compute | -| `ProviderResponseProviderNameTargon` | Targon | -| `ProviderResponseProviderNameTogether2` | Together 2 | -| `ProviderResponseProviderNameUbicloud` | Ubicloud | -| `ProviderResponseProviderNameOneDotAi` | 01.AI | -| `ProviderResponseProviderNameAkashMl` | AkashML | -| `ProviderResponseProviderNameAi21` | AI21 | -| `ProviderResponseProviderNameAionLabs` | AionLabs | -| `ProviderResponseProviderNameAlibaba` | Alibaba | -| `ProviderResponseProviderNameAmbient` | Ambient | -| `ProviderResponseProviderNameBaidu` | Baidu | -| `ProviderResponseProviderNameAmazonBedrock` | Amazon Bedrock | -| `ProviderResponseProviderNameAmazonNova` | Amazon Nova | -| `ProviderResponseProviderNameAnthropic` | Anthropic | -| `ProviderResponseProviderNameArceeAi` | Arcee AI | -| `ProviderResponseProviderNameAtlasCloud` | AtlasCloud | -| `ProviderResponseProviderNameAvian` | Avian | -| `ProviderResponseProviderNameAzure` | Azure | -| `ProviderResponseProviderNameBaseTen` | BaseTen | -| `ProviderResponseProviderNameBytePlus` | BytePlus | -| `ProviderResponseProviderNameBlackForestLabs` | Black Forest Labs | -| `ProviderResponseProviderNameCerebras` | Cerebras | -| `ProviderResponseProviderNameChutes` | Chutes | -| `ProviderResponseProviderNameCirrascale` | Cirrascale | -| `ProviderResponseProviderNameClarifai` | Clarifai | -| `ProviderResponseProviderNameCloudflare` | Cloudflare | -| `ProviderResponseProviderNameCohere` | Cohere | -| `ProviderResponseProviderNameCrucible` | Crucible | -| `ProviderResponseProviderNameCrusoe` | Crusoe | -| `ProviderResponseProviderNameDarkbloom` | Darkbloom | -| `ProviderResponseProviderNameDeepInfra` | DeepInfra | -| `ProviderResponseProviderNameDeepSeek` | DeepSeek | -| `ProviderResponseProviderNameDekaLlm` | DekaLLM | -| `ProviderResponseProviderNameDigitalOcean` | DigitalOcean | -| `ProviderResponseProviderNameFeatherless` | Featherless | -| `ProviderResponseProviderNameFireworks` | Fireworks | -| `ProviderResponseProviderNameFriendli` | Friendli | -| `ProviderResponseProviderNameGmiCloud` | GMICloud | -| `ProviderResponseProviderNameGoogle` | Google | -| `ProviderResponseProviderNameGoogleAiStudio` | Google AI Studio | -| `ProviderResponseProviderNameGroq` | Groq | -| `ProviderResponseProviderNameHyperbolic` | Hyperbolic | -| `ProviderResponseProviderNameInception` | Inception | -| `ProviderResponseProviderNameInceptron` | Inceptron | -| `ProviderResponseProviderNameInferenceNet` | InferenceNet | -| `ProviderResponseProviderNameIonstream` | Ionstream | -| `ProviderResponseProviderNameInfermatic` | Infermatic | -| `ProviderResponseProviderNameIoNet` | Io Net | -| `ProviderResponseProviderNameInflection` | Inflection | -| `ProviderResponseProviderNameLiquid` | Liquid | -| `ProviderResponseProviderNameMara` | Mara | -| `ProviderResponseProviderNameMancer2` | Mancer 2 | -| `ProviderResponseProviderNameMinimax` | Minimax | -| `ProviderResponseProviderNameModelRun` | ModelRun | -| `ProviderResponseProviderNameMistral` | Mistral | -| `ProviderResponseProviderNameModular` | Modular | -| `ProviderResponseProviderNameMoonshotAi` | Moonshot AI | -| `ProviderResponseProviderNameMorph` | Morph | -| `ProviderResponseProviderNameNCompass` | NCompass | -| `ProviderResponseProviderNameNebius` | Nebius | -| `ProviderResponseProviderNameNexAgi` | Nex AGI | -| `ProviderResponseProviderNameNextBit` | NextBit | -| `ProviderResponseProviderNameNovita` | Novita | -| `ProviderResponseProviderNameNvidia` | Nvidia | -| `ProviderResponseProviderNameOpenAi` | OpenAI | -| `ProviderResponseProviderNameOpenInference` | OpenInference | -| `ProviderResponseProviderNameParasail` | Parasail | -| `ProviderResponseProviderNamePoolside` | Poolside | -| `ProviderResponseProviderNamePerceptron` | Perceptron | -| `ProviderResponseProviderNamePerplexity` | Perplexity | -| `ProviderResponseProviderNamePhala` | Phala | -| `ProviderResponseProviderNameRecraft` | Recraft | -| `ProviderResponseProviderNameReka` | Reka | -| `ProviderResponseProviderNameRelace` | Relace | -| `ProviderResponseProviderNameSambaNova` | SambaNova | -| `ProviderResponseProviderNameSeed` | Seed | -| `ProviderResponseProviderNameSiliconFlow` | SiliconFlow | -| `ProviderResponseProviderNameSourceful` | Sourceful | -| `ProviderResponseProviderNameStepFun` | StepFun | -| `ProviderResponseProviderNameStealth` | Stealth | -| `ProviderResponseProviderNameStreamLake` | StreamLake | -| `ProviderResponseProviderNameSwitchpoint` | Switchpoint | -| `ProviderResponseProviderNameTogether` | Together | -| `ProviderResponseProviderNameUpstage` | Upstage | -| `ProviderResponseProviderNameVenice` | Venice | -| `ProviderResponseProviderNameWandB` | WandB | -| `ProviderResponseProviderNameXiaomi` | Xiaomi | -| `ProviderResponseProviderNameXAi` | xAI | -| `ProviderResponseProviderNameZAi` | Z.AI | -| `ProviderResponseProviderNameFakeProvider` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/providersort.mdx b/client-sdks/go/api-reference/models/providersort.mdx deleted file mode 100644 index 5f9a2506..00000000 --- a/client-sdks/go/api-reference/models/providersort.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ProviderSort - Go SDK -sidebarTitle: ProviderSort -description: ProviderSort type definition -seoTitle: ProviderSort Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/providersort' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSort Type | OpenRouter Go SDK -'og:description': >- - ProviderSort type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSort%20-%20Go%20SDK&description=ProviderSort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ProviderSortPrice - -// Open enum: custom values can be created with a direct type cast -custom := components.ProviderSort("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ProviderSortPrice` | price | -| `ProviderSortThroughput` | throughput | -| `ProviderSortLatency` | latency | -| `ProviderSortExacto` | exacto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/providersortconfig.mdx b/client-sdks/go/api-reference/models/providersortconfig.mdx deleted file mode 100644 index 0c2e2ebe..00000000 --- a/client-sdks/go/api-reference/models/providersortconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ProviderSortConfig - Go SDK -sidebarTitle: ProviderSortConfig -description: ProviderSortConfig type definition -seoTitle: ProviderSortConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/providersortconfig' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfig Type | OpenRouter Go SDK -'og:description': >- - ProviderSortConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfig%20-%20Go%20SDK&description=ProviderSortConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `By` | optionalnullable.OptionalNullable[[components.By](/client-sdks/go/api-reference/models/by)] | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `Partition` | optionalnullable.OptionalNullable[[components.Partition](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/publicendpoint.mdx b/client-sdks/go/api-reference/models/publicendpoint.mdx deleted file mode 100644 index aef9ad75..00000000 --- a/client-sdks/go/api-reference/models/publicendpoint.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: PublicEndpoint - Go SDK -sidebarTitle: PublicEndpoint -description: PublicEndpoint type definition -seoTitle: PublicEndpoint Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/publicendpoint' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpoint Type | OpenRouter Go SDK -'og:description': >- - PublicEndpoint type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpoint%20-%20Go%20SDK&description=PublicEndpoint%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Information about a specific model endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ContextLength` | `int64` | :heavy_check_mark: | N/A | | -| `LatencyLast30m` | [*components.PercentileStats](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/pricing) | :heavy_check_mark: | N/A | | -| `ProviderName` | [components.ProviderName](/client-sdks/go/api-reference/models/providername) | :heavy_check_mark: | N/A | OpenAI | -| `Quantization` | [*components.PublicEndpointQuantization](/client-sdks/go/api-reference/models/publicendpointquantization) | :heavy_check_mark: | N/A | fp16 | -| `Status` | [*components.EndpointStatus](/client-sdks/go/api-reference/models/endpointstatus) | :heavy_minus_sign: | N/A | 0 | -| `SupportedParameters` | [][components.Parameter](/client-sdks/go/api-reference/models/parameter) | :heavy_check_mark: | N/A | | -| `SupportsImplicitCaching` | `bool` | :heavy_check_mark: | N/A | | -| `Tag` | `string` | :heavy_check_mark: | N/A | | -| `ThroughputLast30m` | [*components.PercentileStats](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/publicendpointquantization.mdx b/client-sdks/go/api-reference/models/publicendpointquantization.mdx deleted file mode 100644 index 1cb30e2b..00000000 --- a/client-sdks/go/api-reference/models/publicendpointquantization.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: PublicEndpointQuantization - Go SDK -sidebarTitle: PublicEndpointQuantization -description: PublicEndpointQuantization type definition -seoTitle: PublicEndpointQuantization Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/publicendpointquantization -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpointQuantization Type | OpenRouter Go SDK -'og:description': >- - PublicEndpointQuantization type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpointQuantization%20-%20Go%20SDK&description=PublicEndpointQuantization%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.PublicEndpointQuantizationInt4 - -// Open enum: custom values can be created with a direct type cast -custom := components.PublicEndpointQuantization("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `PublicEndpointQuantizationInt4` | int4 | -| `PublicEndpointQuantizationInt8` | int8 | -| `PublicEndpointQuantizationFp4` | fp4 | -| `PublicEndpointQuantizationFp6` | fp6 | -| `PublicEndpointQuantizationFp8` | fp8 | -| `PublicEndpointQuantizationFp16` | fp16 | -| `PublicEndpointQuantizationBf16` | bf16 | -| `PublicEndpointQuantizationFp32` | fp32 | -| `PublicEndpointQuantizationUnknown` | unknown | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/publicpricing.mdx b/client-sdks/go/api-reference/models/publicpricing.mdx deleted file mode 100644 index db25d1a5..00000000 --- a/client-sdks/go/api-reference/models/publicpricing.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PublicPricing - Go SDK -sidebarTitle: PublicPricing -description: PublicPricing type definition -seoTitle: PublicPricing Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/publicpricing' -'og:site_name': OpenRouter Documentation -'og:title': PublicPricing Type | OpenRouter Go SDK -'og:description': >- - PublicPricing type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicPricing%20-%20Go%20SDK&description=PublicPricing%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Pricing information for the model - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `Audio` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `AudioOutput` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Completion` | `string` | :heavy_check_mark: | N/A | 1000 | -| `Discount` | `*float64` | :heavy_minus_sign: | N/A | | -| `Image` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `ImageOutput` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `ImageToken` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputAudioCache` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputCacheRead` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InputCacheWrite` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `InternalReasoning` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `Prompt` | `string` | :heavy_check_mark: | N/A | 1000 | -| `Request` | `*string` | :heavy_minus_sign: | N/A | 1000 | -| `WebSearch` | `*string` | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/quality.mdx b/client-sdks/go/api-reference/models/quality.mdx deleted file mode 100644 index d5b20d2d..00000000 --- a/client-sdks/go/api-reference/models/quality.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Quality - Go SDK -sidebarTitle: Quality -description: Quality type definition -seoTitle: Quality Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/quality' -'og:site_name': OpenRouter Documentation -'og:title': Quality Type | OpenRouter Go SDK -'og:description': >- - Quality type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quality%20-%20Go%20SDK&description=Quality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.QualityLow - -// Open enum: custom values can be created with a direct type cast -custom := components.Quality("custom_value") -``` - -## Values - -| Name | Value | -| --------------- | --------------- | -| `QualityLow` | low | -| `QualityMedium` | medium | -| `QualityHigh` | high | -| `QualityAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/quantization.mdx b/client-sdks/go/api-reference/models/quantization.mdx deleted file mode 100644 index b28808f0..00000000 --- a/client-sdks/go/api-reference/models/quantization.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Quantization - Go SDK -sidebarTitle: Quantization -description: Quantization type definition -seoTitle: Quantization Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/quantization' -'og:site_name': OpenRouter Documentation -'og:title': Quantization Type | OpenRouter Go SDK -'og:description': >- - Quantization type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantization%20-%20Go%20SDK&description=Quantization%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.QuantizationInt4 - -// Open enum: custom values can be created with a direct type cast -custom := components.Quantization("custom_value") -``` - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `QuantizationInt4` | int4 | -| `QuantizationInt8` | int8 | -| `QuantizationFp4` | fp4 | -| `QuantizationFp6` | fp6 | -| `QuantizationFp8` | fp8 | -| `QuantizationFp16` | fp16 | -| `QuantizationBf16` | bf16 | -| `QuantizationFp32` | fp32 | -| `QuantizationUnknown` | unknown | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/ranker.mdx b/client-sdks/go/api-reference/models/ranker.mdx deleted file mode 100644 index 52bdcd61..00000000 --- a/client-sdks/go/api-reference/models/ranker.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Ranker - Go SDK -sidebarTitle: Ranker -description: Ranker type definition -seoTitle: Ranker Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/ranker' -'og:site_name': OpenRouter Documentation -'og:title': Ranker Type | OpenRouter Go SDK -'og:description': >- - Ranker type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ranker%20-%20Go%20SDK&description=Ranker%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RankerAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.Ranker("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `RankerAuto` | auto | -| `RankerDefault20241115` | default-2024-11-15 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/rankingoptions.mdx b/client-sdks/go/api-reference/models/rankingoptions.mdx deleted file mode 100644 index bdee1cc4..00000000 --- a/client-sdks/go/api-reference/models/rankingoptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RankingOptions - Go SDK -sidebarTitle: RankingOptions -description: RankingOptions type definition -seoTitle: RankingOptions Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/rankingoptions' -'og:site_name': OpenRouter Documentation -'og:title': RankingOptions Type | OpenRouter Go SDK -'og:description': >- - RankingOptions type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingOptions%20-%20Go%20SDK&description=RankingOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Ranker` | [*components.Ranker](/client-sdks/go/api-reference/models/ranker) | :heavy_minus_sign: | N/A | -| `ScoreThreshold` | `*float64` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/rankingsdailyitem.mdx b/client-sdks/go/api-reference/models/rankingsdailyitem.mdx deleted file mode 100644 index 4d849745..00000000 --- a/client-sdks/go/api-reference/models/rankingsdailyitem.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RankingsDailyItem - Go SDK -sidebarTitle: RankingsDailyItem -description: RankingsDailyItem type definition -seoTitle: RankingsDailyItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/rankingsdailyitem' -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyItem Type | OpenRouter Go SDK -'og:description': >- - RankingsDailyItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyItem%20-%20Go%20SDK&description=RankingsDailyItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | `string` | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `ModelPermaslug` | `string` | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `TotalTokens` | `string` | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/rankingsdailymeta.mdx b/client-sdks/go/api-reference/models/rankingsdailymeta.mdx deleted file mode 100644 index 7f646436..00000000 --- a/client-sdks/go/api-reference/models/rankingsdailymeta.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: RankingsDailyMeta - Go SDK -sidebarTitle: RankingsDailyMeta -description: RankingsDailyMeta type definition -seoTitle: RankingsDailyMeta Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/rankingsdailymeta' -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyMeta Type | OpenRouter Go SDK -'og:description': >- - RankingsDailyMeta type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyMeta%20-%20Go%20SDK&description=RankingsDailyMeta%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AsOf` | `string` | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00: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.Version](/client-sdks/go/api-reference/models/version) | :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/client-sdks/go/api-reference/models/rankingsdailyresponse.mdx b/client-sdks/go/api-reference/models/rankingsdailyresponse.mdx deleted file mode 100644 index 61e4d52f..00000000 --- a/client-sdks/go/api-reference/models/rankingsdailyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RankingsDailyResponse - Go SDK -sidebarTitle: RankingsDailyResponse -description: RankingsDailyResponse type definition -seoTitle: RankingsDailyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/rankingsdailyresponse' -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyResponse Type | OpenRouter Go SDK -'og:description': >- - RankingsDailyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyResponse%20-%20Go%20SDK&description=RankingsDailyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.RankingsDailyItem](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/reason.mdx b/client-sdks/go/api-reference/models/reason.mdx deleted file mode 100644 index 41b5cd9e..00000000 --- a/client-sdks/go/api-reference/models/reason.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Reason - Go SDK -sidebarTitle: Reason -description: Reason type definition -seoTitle: Reason Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reason' -'og:site_name': OpenRouter Documentation -'og:title': Reason Type | OpenRouter Go SDK -'og:description': >- - Reason type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reason%20-%20Go%20SDK&description=Reason%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasonMaxOutputTokens - -// Open enum: custom values can be created with a direct type cast -custom := components.Reason("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `ReasonMaxOutputTokens` | max_output_tokens | -| `ReasonContentFilter` | content_filter | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningconfig.mdx b/client-sdks/go/api-reference/models/reasoningconfig.mdx deleted file mode 100644 index 7a35cff1..00000000 --- a/client-sdks/go/api-reference/models/reasoningconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ReasoningConfig - Go SDK -sidebarTitle: ReasoningConfig -description: ReasoningConfig type definition -seoTitle: ReasoningConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningconfig' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningConfig Type | OpenRouter Go SDK -'og:description': >- - ReasoningConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningConfig%20-%20Go%20SDK&description=ReasoningConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for reasoning mode in the response - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ReasoningEffort](/client-sdks/go/api-reference/models/reasoningeffort)] | :heavy_minus_sign: | N/A | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/reasoningdeltaevent.mdx b/client-sdks/go/api-reference/models/reasoningdeltaevent.mdx deleted file mode 100644 index 7511cfe2..00000000 --- a/client-sdks/go/api-reference/models/reasoningdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDeltaEvent - Go SDK -sidebarTitle: ReasoningDeltaEvent -description: ReasoningDeltaEvent type definition -seoTitle: ReasoningDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdeltaevent' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningDeltaEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDeltaEvent%20-%20Go%20SDK&description=ReasoningDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :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.ReasoningDeltaEventType](/client-sdks/go/api-reference/models/reasoningdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdeltaeventtype.mdx b/client-sdks/go/api-reference/models/reasoningdeltaeventtype.mdx deleted file mode 100644 index db9e916d..00000000 --- a/client-sdks/go/api-reference/models/reasoningdeltaeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningDeltaEventType - Go SDK -sidebarTitle: ReasoningDeltaEventType -description: ReasoningDeltaEventType type definition -seoTitle: ReasoningDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningDeltaEventType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDeltaEventType%20-%20Go%20SDK&description=ReasoningDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningDeltaEventTypeResponseReasoningTextDelta -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `ReasoningDeltaEventTypeResponseReasoningTextDelta` | response.reasoning_text.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailencrypted.mdx b/client-sdks/go/api-reference/models/reasoningdetailencrypted.mdx deleted file mode 100644 index e59cf679..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailencrypted.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDetailEncrypted - Go SDK -sidebarTitle: ReasoningDetailEncrypted -description: ReasoningDetailEncrypted type definition -seoTitle: ReasoningDetailEncrypted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningdetailencrypted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailEncrypted Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailEncrypted type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailEncrypted%20-%20Go%20SDK&description=ReasoningDetailEncrypted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning detail encrypted schema - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningdetailencryptedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailencryptedtype.mdx b/client-sdks/go/api-reference/models/reasoningdetailencryptedtype.mdx deleted file mode 100644 index eb7ac760..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailencryptedtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningDetailEncryptedType - Go SDK -sidebarTitle: ReasoningDetailEncryptedType -description: ReasoningDetailEncryptedType type definition -seoTitle: ReasoningDetailEncryptedType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningdetailencryptedtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailEncryptedType Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailEncryptedType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailEncryptedType%20-%20Go%20SDK&description=ReasoningDetailEncryptedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningDetailEncryptedTypeReasoningEncrypted -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `ReasoningDetailEncryptedTypeReasoningEncrypted` | reasoning.encrypted | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailsummary.mdx b/client-sdks/go/api-reference/models/reasoningdetailsummary.mdx deleted file mode 100644 index ff3b5543..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailsummary.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ReasoningDetailSummary - Go SDK -sidebarTitle: ReasoningDetailSummary -description: ReasoningDetailSummary type definition -seoTitle: ReasoningDetailSummary Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdetailsummary' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailSummary Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailSummary type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailSummary%20-%20Go%20SDK&description=ReasoningDetailSummary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning detail summary schema - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningdetailsummarytype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailsummarytype.mdx b/client-sdks/go/api-reference/models/reasoningdetailsummarytype.mdx deleted file mode 100644 index a11138ea..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailsummarytype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningDetailSummaryType - Go SDK -sidebarTitle: ReasoningDetailSummaryType -description: ReasoningDetailSummaryType type definition -seoTitle: ReasoningDetailSummaryType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningdetailsummarytype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailSummaryType Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailSummaryType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailSummaryType%20-%20Go%20SDK&description=ReasoningDetailSummaryType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningDetailSummaryTypeReasoningSummary -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `ReasoningDetailSummaryTypeReasoningSummary` | reasoning.summary | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailtext.mdx b/client-sdks/go/api-reference/models/reasoningdetailtext.mdx deleted file mode 100644 index ffb9ef80..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailtext.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDetailText - Go SDK -sidebarTitle: ReasoningDetailText -description: ReasoningDetailText type definition -seoTitle: ReasoningDetailText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdetailtext' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailText Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailText%20-%20Go%20SDK&description=ReasoningDetailText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning detail text schema - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningdetailtexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailtexttype.mdx b/client-sdks/go/api-reference/models/reasoningdetailtexttype.mdx deleted file mode 100644 index 53ce8363..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailtexttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningDetailTextType - Go SDK -sidebarTitle: ReasoningDetailTextType -description: ReasoningDetailTextType type definition -seoTitle: ReasoningDetailTextType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningdetailtexttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailTextType Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailTextType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailTextType%20-%20Go%20SDK&description=ReasoningDetailTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningDetailTextTypeReasoningText -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `ReasoningDetailTextTypeReasoningText` | reasoning.text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdetailunion.mdx b/client-sdks/go/api-reference/models/reasoningdetailunion.mdx deleted file mode 100644 index 0be46ec2..00000000 --- a/client-sdks/go/api-reference/models/reasoningdetailunion.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: ReasoningDetailUnion - Go SDK -sidebarTitle: ReasoningDetailUnion -description: ReasoningDetailUnion type definition -seoTitle: ReasoningDetailUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdetailunion' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailUnion Type | OpenRouter Go SDK -'og:description': >- - ReasoningDetailUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailUnion%20-%20Go%20SDK&description=ReasoningDetailUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning detail union schema - -## Supported Types - -### ReasoningDetailEncrypted - -```go lines -reasoningDetailUnion := components.CreateReasoningDetailUnionReasoningEncrypted(components.ReasoningDetailEncrypted{/* values here */}) -``` - -### ReasoningDetailSummary - -```go lines -reasoningDetailUnion := components.CreateReasoningDetailUnionReasoningSummary(components.ReasoningDetailSummary{/* values here */}) -``` - -### ReasoningDetailText - -```go lines -reasoningDetailUnion := components.CreateReasoningDetailUnionReasoningText(components.ReasoningDetailText{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch reasoningDetailUnion.Type { - case components.ReasoningDetailUnionTypeReasoningEncrypted: - // reasoningDetailUnion.ReasoningDetailEncrypted is populated - case components.ReasoningDetailUnionTypeReasoningSummary: - // reasoningDetailUnion.ReasoningDetailSummary is populated - case components.ReasoningDetailUnionTypeReasoningText: - // reasoningDetailUnion.ReasoningDetailText is populated - default: - // Unknown type - use reasoningDetailUnion.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdoneevent.mdx b/client-sdks/go/api-reference/models/reasoningdoneevent.mdx deleted file mode 100644 index 3f4e9de6..00000000 --- a/client-sdks/go/api-reference/models/reasoningdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDoneEvent - Go SDK -sidebarTitle: ReasoningDoneEvent -description: ReasoningDoneEvent type definition -seoTitle: ReasoningDoneEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdoneevent' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDoneEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningDoneEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDoneEvent%20-%20Go%20SDK&description=ReasoningDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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 | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningDoneEventType](/client-sdks/go/api-reference/models/reasoningdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningdoneeventtype.mdx b/client-sdks/go/api-reference/models/reasoningdoneeventtype.mdx deleted file mode 100644 index 6602b4a4..00000000 --- a/client-sdks/go/api-reference/models/reasoningdoneeventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ReasoningDoneEventType - Go SDK -sidebarTitle: ReasoningDoneEventType -description: ReasoningDoneEventType type definition -seoTitle: ReasoningDoneEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningdoneeventtype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDoneEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningDoneEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDoneEventType%20-%20Go%20SDK&description=ReasoningDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningDoneEventTypeResponseReasoningTextDone -``` - -## Values - -| Name | Value | -| ------------------------------------------------- | ------------------------------------------------- | -| `ReasoningDoneEventTypeResponseReasoningTextDone` | response.reasoning_text.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningeffort.mdx b/client-sdks/go/api-reference/models/reasoningeffort.mdx deleted file mode 100644 index 271995f6..00000000 --- a/client-sdks/go/api-reference/models/reasoningeffort.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ReasoningEffort - Go SDK -sidebarTitle: ReasoningEffort -description: ReasoningEffort type definition -seoTitle: ReasoningEffort Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningeffort' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningEffort Type | OpenRouter Go SDK -'og:description': >- - ReasoningEffort type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningEffort%20-%20Go%20SDK&description=ReasoningEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningEffortXhigh - -// Open enum: custom values can be created with a direct type cast -custom := components.ReasoningEffort("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ReasoningEffortXhigh` | xhigh | -| `ReasoningEffortHigh` | high | -| `ReasoningEffortMedium` | medium | -| `ReasoningEffortLow` | low | -| `ReasoningEffortMinimal` | minimal | -| `ReasoningEffortNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningformat.mdx b/client-sdks/go/api-reference/models/reasoningformat.mdx deleted file mode 100644 index 6663e2b2..00000000 --- a/client-sdks/go/api-reference/models/reasoningformat.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ReasoningFormat - Go SDK -sidebarTitle: ReasoningFormat -description: ReasoningFormat type definition -seoTitle: ReasoningFormat Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningformat' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningFormat Type | OpenRouter Go SDK -'og:description': >- - ReasoningFormat type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningFormat%20-%20Go%20SDK&description=ReasoningFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningFormatUnknown - -// Open enum: custom values can be created with a direct type cast -custom := components.ReasoningFormat("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `ReasoningFormatUnknown` | unknown | -| `ReasoningFormatOpenaiResponsesV1` | openai-responses-v1 | -| `ReasoningFormatAzureOpenaiResponsesV1` | azure-openai-responses-v1 | -| `ReasoningFormatXaiResponsesV1` | xai-responses-v1 | -| `ReasoningFormatAnthropicClaudeV1` | anthropic-claude-v1 | -| `ReasoningFormatGoogleGeminiV1` | google-gemini-v1 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningitem.mdx b/client-sdks/go/api-reference/models/reasoningitem.mdx deleted file mode 100644 index 42f2ba69..00000000 --- a/client-sdks/go/api-reference/models/reasoningitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItem - Go SDK -sidebarTitle: ReasoningItem -description: ReasoningItem type definition -seoTitle: ReasoningItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningitem' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItem Type | OpenRouter Go SDK -'og:description': >- - ReasoningItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItem%20-%20Go%20SDK&description=ReasoningItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Reasoning output item with signature and format extensions - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningitemstatusunion) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](/client-sdks/go/api-reference/models/reasoningsummarytext) | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningItemType](/client-sdks/go/api-reference/models/reasoningitemtype) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/reasoningitemstatuscompleted.mdx b/client-sdks/go/api-reference/models/reasoningitemstatuscompleted.mdx deleted file mode 100644 index e1fb0cc1..00000000 --- a/client-sdks/go/api-reference/models/reasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningItemStatusCompleted - Go SDK -sidebarTitle: ReasoningItemStatusCompleted -description: ReasoningItemStatusCompleted type definition -seoTitle: ReasoningItemStatusCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusCompleted Type | OpenRouter Go SDK -'og:description': >- - ReasoningItemStatusCompleted type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusCompleted%20-%20Go%20SDK&description=ReasoningItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningItemStatusCompletedCompleted -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `ReasoningItemStatusCompletedCompleted` | completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningitemstatusincomplete.mdx b/client-sdks/go/api-reference/models/reasoningitemstatusincomplete.mdx deleted file mode 100644 index df031564..00000000 --- a/client-sdks/go/api-reference/models/reasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningItemStatusIncomplete - Go SDK -sidebarTitle: ReasoningItemStatusIncomplete -description: ReasoningItemStatusIncomplete type definition -seoTitle: ReasoningItemStatusIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusIncomplete Type | OpenRouter Go SDK -'og:description': >- - ReasoningItemStatusIncomplete type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusIncomplete%20-%20Go%20SDK&description=ReasoningItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningItemStatusIncompleteIncomplete -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `ReasoningItemStatusIncompleteIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningitemstatusinprogress.mdx b/client-sdks/go/api-reference/models/reasoningitemstatusinprogress.mdx deleted file mode 100644 index 6e4306cc..00000000 --- a/client-sdks/go/api-reference/models/reasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningItemStatusInProgress - Go SDK -sidebarTitle: ReasoningItemStatusInProgress -description: ReasoningItemStatusInProgress type definition -seoTitle: ReasoningItemStatusInProgress Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusInProgress Type | OpenRouter Go SDK -'og:description': >- - ReasoningItemStatusInProgress type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusInProgress%20-%20Go%20SDK&description=ReasoningItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningItemStatusInProgressInProgress -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `ReasoningItemStatusInProgressInProgress` | in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningitemstatusunion.mdx b/client-sdks/go/api-reference/models/reasoningitemstatusunion.mdx deleted file mode 100644 index c0b7a164..00000000 --- a/client-sdks/go/api-reference/models/reasoningitemstatusunion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: ReasoningItemStatusUnion - Go SDK -sidebarTitle: ReasoningItemStatusUnion -description: ReasoningItemStatusUnion type definition -seoTitle: ReasoningItemStatusUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusUnion Type | OpenRouter Go SDK -'og:description': >- - ReasoningItemStatusUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusUnion%20-%20Go%20SDK&description=ReasoningItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ReasoningItemStatusCompleted - -```go lines -reasoningItemStatusUnion := components.CreateReasoningItemStatusUnionReasoningItemStatusCompleted(components.ReasoningItemStatusCompleted{/* values here */}) -``` - -### ReasoningItemStatusIncomplete - -```go lines -reasoningItemStatusUnion := components.CreateReasoningItemStatusUnionReasoningItemStatusIncomplete(components.ReasoningItemStatusIncomplete{/* values here */}) -``` - -### ReasoningItemStatusInProgress - -```go lines -reasoningItemStatusUnion := components.CreateReasoningItemStatusUnionReasoningItemStatusInProgress(components.ReasoningItemStatusInProgress{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch reasoningItemStatusUnion.Type { - case components.ReasoningItemStatusUnionTypeReasoningItemStatusCompleted: - // reasoningItemStatusUnion.ReasoningItemStatusCompleted is populated - case components.ReasoningItemStatusUnionTypeReasoningItemStatusIncomplete: - // reasoningItemStatusUnion.ReasoningItemStatusIncomplete is populated - case components.ReasoningItemStatusUnionTypeReasoningItemStatusInProgress: - // reasoningItemStatusUnion.ReasoningItemStatusInProgress is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningitemtype.mdx b/client-sdks/go/api-reference/models/reasoningitemtype.mdx deleted file mode 100644 index a6ac1a80..00000000 --- a/client-sdks/go/api-reference/models/reasoningitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ReasoningItemType - Go SDK -sidebarTitle: ReasoningItemType -description: ReasoningItemType type definition -seoTitle: ReasoningItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningitemtype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemType Type | OpenRouter Go SDK -'og:description': >- - ReasoningItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemType%20-%20Go%20SDK&description=ReasoningItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningItemTypeReasoning -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `ReasoningItemTypeReasoning` | reasoning | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarypartaddedevent.mdx b/client-sdks/go/api-reference/models/reasoningsummarypartaddedevent.mdx deleted file mode 100644 index f244e951..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarypartaddedevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryPartAddedEvent - Go SDK -sidebarTitle: ReasoningSummaryPartAddedEvent -description: ReasoningSummaryPartAddedEvent type definition -seoTitle: ReasoningSummaryPartAddedEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarypartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartAddedEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryPartAddedEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartAddedEvent%20-%20Go%20SDK&description=ReasoningSummaryPartAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is added - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningsummarypartaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarypartaddedeventtype.mdx b/client-sdks/go/api-reference/models/reasoningsummarypartaddedeventtype.mdx deleted file mode 100644 index 79109959..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarypartaddedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryPartAddedEventType - Go SDK -sidebarTitle: ReasoningSummaryPartAddedEventType -description: ReasoningSummaryPartAddedEventType type definition -seoTitle: ReasoningSummaryPartAddedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarypartaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartAddedEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryPartAddedEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartAddedEventType%20-%20Go%20SDK&description=ReasoningSummaryPartAddedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryPartAddedEventTypeResponseReasoningSummaryPartAdded -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `ReasoningSummaryPartAddedEventTypeResponseReasoningSummaryPartAdded` | response.reasoning_summary_part.added | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarypartdoneevent.mdx b/client-sdks/go/api-reference/models/reasoningsummarypartdoneevent.mdx deleted file mode 100644 index caa7c77f..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarypartdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryPartDoneEvent - Go SDK -sidebarTitle: ReasoningSummaryPartDoneEvent -description: ReasoningSummaryPartDoneEvent type definition -seoTitle: ReasoningSummaryPartDoneEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarypartdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartDoneEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryPartDoneEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartDoneEvent%20-%20Go%20SDK&description=ReasoningSummaryPartDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is complete - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/reasoningsummarypartdoneeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarypartdoneeventtype.mdx b/client-sdks/go/api-reference/models/reasoningsummarypartdoneeventtype.mdx deleted file mode 100644 index a3c368ab..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarypartdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryPartDoneEventType - Go SDK -sidebarTitle: ReasoningSummaryPartDoneEventType -description: ReasoningSummaryPartDoneEventType type definition -seoTitle: ReasoningSummaryPartDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarypartdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartDoneEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryPartDoneEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartDoneEventType%20-%20Go%20SDK&description=ReasoningSummaryPartDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryPartDoneEventTypeResponseReasoningSummaryPartDone -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `ReasoningSummaryPartDoneEventTypeResponseReasoningSummaryPartDone` | response.reasoning_summary_part.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytext.mdx b/client-sdks/go/api-reference/models/reasoningsummarytext.mdx deleted file mode 100644 index cce6b651..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryText - Go SDK -sidebarTitle: ReasoningSummaryText -description: ReasoningSummaryText type definition -seoTitle: ReasoningSummaryText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningsummarytext' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryText Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryText%20-%20Go%20SDK&description=ReasoningSummaryText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextType](/client-sdks/go/api-reference/models/reasoningsummarytexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytextdeltaevent.mdx b/client-sdks/go/api-reference/models/reasoningsummarytextdeltaevent.mdx deleted file mode 100644 index ac4d1fa7..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytextdeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryTextDeltaEvent - Go SDK -sidebarTitle: ReasoningSummaryTextDeltaEvent -description: ReasoningSummaryTextDeltaEvent type definition -seoTitle: ReasoningSummaryTextDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarytextdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryTextDeltaEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDeltaEvent%20-%20Go%20SDK&description=ReasoningSummaryTextDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Delta` | `string` | :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 | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDeltaEventType](/client-sdks/go/api-reference/models/reasoningsummarytextdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytextdeltaeventtype.mdx b/client-sdks/go/api-reference/models/reasoningsummarytextdeltaeventtype.mdx deleted file mode 100644 index f0631a8f..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytextdeltaeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryTextDeltaEventType - Go SDK -sidebarTitle: ReasoningSummaryTextDeltaEventType -description: ReasoningSummaryTextDeltaEventType type definition -seoTitle: ReasoningSummaryTextDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarytextdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryTextDeltaEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDeltaEventType%20-%20Go%20SDK&description=ReasoningSummaryTextDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryTextDeltaEventTypeResponseReasoningSummaryTextDelta -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `ReasoningSummaryTextDeltaEventTypeResponseReasoningSummaryTextDelta` | response.reasoning_summary_text.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytextdoneevent.mdx b/client-sdks/go/api-reference/models/reasoningsummarytextdoneevent.mdx deleted file mode 100644 index 83df778f..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytextdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryTextDoneEvent - Go SDK -sidebarTitle: ReasoningSummaryTextDoneEvent -description: ReasoningSummaryTextDoneEvent type definition -seoTitle: ReasoningSummaryTextDoneEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarytextdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDoneEvent Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryTextDoneEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDoneEvent%20-%20Go%20SDK&description=ReasoningSummaryTextDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDoneEventType](/client-sdks/go/api-reference/models/reasoningsummarytextdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytextdoneeventtype.mdx b/client-sdks/go/api-reference/models/reasoningsummarytextdoneeventtype.mdx deleted file mode 100644 index b08f880d..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytextdoneeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryTextDoneEventType - Go SDK -sidebarTitle: ReasoningSummaryTextDoneEventType -description: ReasoningSummaryTextDoneEventType type definition -seoTitle: ReasoningSummaryTextDoneEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarytextdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDoneEventType Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryTextDoneEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDoneEventType%20-%20Go%20SDK&description=ReasoningSummaryTextDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryTextDoneEventTypeResponseReasoningSummaryTextDone -``` - -## Values - -| Name | Value | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `ReasoningSummaryTextDoneEventTypeResponseReasoningSummaryTextDone` | response.reasoning_summary_text.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummarytexttype.mdx b/client-sdks/go/api-reference/models/reasoningsummarytexttype.mdx deleted file mode 100644 index 6dfafd14..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummarytexttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryTextType - Go SDK -sidebarTitle: ReasoningSummaryTextType -description: ReasoningSummaryTextType type definition -seoTitle: ReasoningSummaryTextType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummarytexttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextType Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryTextType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextType%20-%20Go%20SDK&description=ReasoningSummaryTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryTextTypeSummaryText -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ReasoningSummaryTextTypeSummaryText` | summary_text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningsummaryverbosity.mdx b/client-sdks/go/api-reference/models/reasoningsummaryverbosity.mdx deleted file mode 100644 index 88e471b7..00000000 --- a/client-sdks/go/api-reference/models/reasoningsummaryverbosity.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ReasoningSummaryVerbosity - Go SDK -sidebarTitle: ReasoningSummaryVerbosity -description: ReasoningSummaryVerbosity type definition -seoTitle: ReasoningSummaryVerbosity Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningsummaryverbosity -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryVerbosity Type | OpenRouter Go SDK -'og:description': >- - ReasoningSummaryVerbosity type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryVerbosity%20-%20Go%20SDK&description=ReasoningSummaryVerbosity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningSummaryVerbosityAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ReasoningSummaryVerbosity("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ReasoningSummaryVerbosityAuto` | auto | -| `ReasoningSummaryVerbosityConcise` | concise | -| `ReasoningSummaryVerbosityDetailed` | detailed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningtextcontent.mdx b/client-sdks/go/api-reference/models/reasoningtextcontent.mdx deleted file mode 100644 index 01c2a2e0..00000000 --- a/client-sdks/go/api-reference/models/reasoningtextcontent.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningTextContent - Go SDK -sidebarTitle: ReasoningTextContent -description: ReasoningTextContent type definition -seoTitle: ReasoningTextContent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/reasoningtextcontent' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContent Type | OpenRouter Go SDK -'og:description': >- - ReasoningTextContent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContent%20-%20Go%20SDK&description=ReasoningTextContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningTextContentType](/client-sdks/go/api-reference/models/reasoningtextcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/reasoningtextcontenttype.mdx b/client-sdks/go/api-reference/models/reasoningtextcontenttype.mdx deleted file mode 100644 index f943a410..00000000 --- a/client-sdks/go/api-reference/models/reasoningtextcontenttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningTextContentType - Go SDK -sidebarTitle: ReasoningTextContentType -description: ReasoningTextContentType type definition -seoTitle: ReasoningTextContentType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/reasoningtextcontenttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContentType Type | OpenRouter Go SDK -'og:description': >- - ReasoningTextContentType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContentType%20-%20Go%20SDK&description=ReasoningTextContentType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ReasoningTextContentTypeReasoningText -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `ReasoningTextContentTypeReasoningText` | reasoning_text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/refusaldeltaevent.mdx b/client-sdks/go/api-reference/models/refusaldeltaevent.mdx deleted file mode 100644 index 0c584672..00000000 --- a/client-sdks/go/api-reference/models/refusaldeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: RefusalDeltaEvent - Go SDK -sidebarTitle: RefusalDeltaEvent -description: RefusalDeltaEvent type definition -seoTitle: RefusalDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/refusaldeltaevent' -'og:site_name': OpenRouter Documentation -'og:title': RefusalDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - RefusalDeltaEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDeltaEvent%20-%20Go%20SDK&description=RefusalDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a refusal delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :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.RefusalDeltaEventType](/client-sdks/go/api-reference/models/refusaldeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/refusaldeltaeventtype.mdx b/client-sdks/go/api-reference/models/refusaldeltaeventtype.mdx deleted file mode 100644 index 287c3bfd..00000000 --- a/client-sdks/go/api-reference/models/refusaldeltaeventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RefusalDeltaEventType - Go SDK -sidebarTitle: RefusalDeltaEventType -description: RefusalDeltaEventType type definition -seoTitle: RefusalDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/refusaldeltaeventtype' -'og:site_name': OpenRouter Documentation -'og:title': RefusalDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - RefusalDeltaEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDeltaEventType%20-%20Go%20SDK&description=RefusalDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RefusalDeltaEventTypeResponseRefusalDelta -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `RefusalDeltaEventTypeResponseRefusalDelta` | response.refusal.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/refusaldoneevent.mdx b/client-sdks/go/api-reference/models/refusaldoneevent.mdx deleted file mode 100644 index 329bd8a6..00000000 --- a/client-sdks/go/api-reference/models/refusaldoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: RefusalDoneEvent - Go SDK -sidebarTitle: RefusalDoneEvent -description: RefusalDoneEvent type definition -seoTitle: RefusalDoneEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/refusaldoneevent' -'og:site_name': OpenRouter Documentation -'og:title': RefusalDoneEvent Type | OpenRouter Go SDK -'og:description': >- - RefusalDoneEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDoneEvent%20-%20Go%20SDK&description=RefusalDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when refusal streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Refusal` | `string` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.RefusalDoneEventType](/client-sdks/go/api-reference/models/refusaldoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/refusaldoneeventtype.mdx b/client-sdks/go/api-reference/models/refusaldoneeventtype.mdx deleted file mode 100644 index 44bf957c..00000000 --- a/client-sdks/go/api-reference/models/refusaldoneeventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RefusalDoneEventType - Go SDK -sidebarTitle: RefusalDoneEventType -description: RefusalDoneEventType type definition -seoTitle: RefusalDoneEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/refusaldoneeventtype' -'og:site_name': OpenRouter Documentation -'og:title': RefusalDoneEventType Type | OpenRouter Go SDK -'og:description': >- - RefusalDoneEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDoneEventType%20-%20Go%20SDK&description=RefusalDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RefusalDoneEventTypeResponseRefusalDone -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `RefusalDoneEventTypeResponseRefusalDone` | response.refusal.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/region.mdx b/client-sdks/go/api-reference/models/region.mdx deleted file mode 100644 index 606f43fa..00000000 --- a/client-sdks/go/api-reference/models/region.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Region - Go SDK -sidebarTitle: Region -description: Region type definition -seoTitle: Region Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/region' -'og:site_name': OpenRouter Documentation -'og:title': Region Type | OpenRouter Go SDK -'og:description': >- - Region type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Region%20-%20Go%20SDK&description=Region%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RegionUs - -// Open enum: custom values can be created with a direct type cast -custom := components.Region("custom_value") -``` - -## Values - -| Name | Value | -| ---------- | ---------- | -| `RegionUs` | us | -| `RegionEu` | eu | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/requesttimeoutresponseerror.mdx b/client-sdks/go/api-reference/models/requesttimeoutresponseerror.mdx deleted file mode 100644 index 100567cd..00000000 --- a/client-sdks/go/api-reference/models/requesttimeoutresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: RequestTimeoutResponseError - Go SDK -sidebarTitle: RequestTimeoutResponseError -description: RequestTimeoutResponseError type definition -seoTitle: RequestTimeoutResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/requesttimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseError Type | OpenRouter Go SDK -'og:description': >- - RequestTimeoutResponseError type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseError%20-%20Go%20SDK&description=RequestTimeoutResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Request Timeout - Operation exceeded time limit - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.RequestTimeoutResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/requesttimeoutresponseerrordata.mdx b/client-sdks/go/api-reference/models/requesttimeoutresponseerrordata.mdx deleted file mode 100644 index a9cf8d92..00000000 --- a/client-sdks/go/api-reference/models/requesttimeoutresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: RequestTimeoutResponseErrorData - Go SDK -sidebarTitle: RequestTimeoutResponseErrorData -description: RequestTimeoutResponseErrorData type definition -seoTitle: RequestTimeoutResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/requesttimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - RequestTimeoutResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseErrorData%20-%20Go%20SDK&description=RequestTimeoutResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for RequestTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/requireapproval.mdx b/client-sdks/go/api-reference/models/requireapproval.mdx deleted file mode 100644 index cdc1741f..00000000 --- a/client-sdks/go/api-reference/models/requireapproval.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RequireApproval - Go SDK -sidebarTitle: RequireApproval -description: RequireApproval type definition -seoTitle: RequireApproval Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/requireapproval' -'og:site_name': OpenRouter Documentation -'og:title': RequireApproval Type | OpenRouter Go SDK -'og:description': >- - RequireApproval type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApproval%20-%20Go%20SDK&description=RequireApproval%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Always` | [*components.Always](/client-sdks/go/api-reference/models/always) | :heavy_minus_sign: | N/A | -| `Never` | [*components.Never](/client-sdks/go/api-reference/models/never) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/requireapprovalalways.mdx b/client-sdks/go/api-reference/models/requireapprovalalways.mdx deleted file mode 100644 index 9f5125ba..00000000 --- a/client-sdks/go/api-reference/models/requireapprovalalways.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RequireApprovalAlways - Go SDK -sidebarTitle: RequireApprovalAlways -description: RequireApprovalAlways type definition -seoTitle: RequireApprovalAlways Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/requireapprovalalways' -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalAlways Type | OpenRouter Go SDK -'og:description': >- - RequireApprovalAlways type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalAlways%20-%20Go%20SDK&description=RequireApprovalAlways%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RequireApprovalAlwaysAlways -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `RequireApprovalAlwaysAlways` | always | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/requireapprovalnever.mdx b/client-sdks/go/api-reference/models/requireapprovalnever.mdx deleted file mode 100644 index 9666fbfa..00000000 --- a/client-sdks/go/api-reference/models/requireapprovalnever.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RequireApprovalNever - Go SDK -sidebarTitle: RequireApprovalNever -description: RequireApprovalNever type definition -seoTitle: RequireApprovalNever Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/requireapprovalnever' -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalNever Type | OpenRouter Go SDK -'og:description': >- - RequireApprovalNever type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalNever%20-%20Go%20SDK&description=RequireApprovalNever%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RequireApprovalNeverNever -``` - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `RequireApprovalNeverNever` | never | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/requireapprovalunion.mdx b/client-sdks/go/api-reference/models/requireapprovalunion.mdx deleted file mode 100644 index 9595177d..00000000 --- a/client-sdks/go/api-reference/models/requireapprovalunion.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: RequireApprovalUnion - Go SDK -sidebarTitle: RequireApprovalUnion -description: RequireApprovalUnion type definition -seoTitle: RequireApprovalUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/requireapprovalunion' -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalUnion Type | OpenRouter Go SDK -'og:description': >- - RequireApprovalUnion type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalUnion%20-%20Go%20SDK&description=RequireApprovalUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### RequireApproval - -```go lines -requireApprovalUnion := components.CreateRequireApprovalUnionRequireApproval(components.RequireApproval{/* values here */}) -``` - -### RequireApprovalAlways - -```go lines -requireApprovalUnion := components.CreateRequireApprovalUnionRequireApprovalAlways(components.RequireApprovalAlways{/* values here */}) -``` - -### RequireApprovalNever - -```go lines -requireApprovalUnion := components.CreateRequireApprovalUnionRequireApprovalNever(components.RequireApprovalNever{/* values here */}) -``` - -### - -```go lines -requireApprovalUnion := components.CreateRequireApprovalUnionAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch requireApprovalUnion.Type { - case components.RequireApprovalUnionTypeRequireApproval: - // requireApprovalUnion.RequireApproval is populated - case components.RequireApprovalUnionTypeRequireApprovalAlways: - // requireApprovalUnion.RequireApprovalAlways is populated - case components.RequireApprovalUnionTypeRequireApprovalNever: - // requireApprovalUnion.RequireApprovalNever is populated - case components.RequireApprovalUnionTypeAny: - // requireApprovalUnion.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/resolution.mdx b/client-sdks/go/api-reference/models/resolution.mdx deleted file mode 100644 index 8a6ba25f..00000000 --- a/client-sdks/go/api-reference/models/resolution.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Resolution - Go SDK -sidebarTitle: Resolution -description: Resolution type definition -seoTitle: Resolution Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/resolution' -'og:site_name': OpenRouter Documentation -'og:title': Resolution Type | OpenRouter Go SDK -'og:description': >- - Resolution type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Resolution%20-%20Go%20SDK&description=Resolution%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Resolution of the generated video - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResolutionFourHundredAndEightyp - -// Open enum: custom values can be created with a direct type cast -custom := components.Resolution("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ResolutionFourHundredAndEightyp` | 480p | -| `ResolutionSevenHundredAndTwentyp` | 720p | -| `ResolutionOneThousandAndEightyp` | 1080p | -| `ResolutionOneK` | 1K | -| `ResolutionTwoK` | 2K | -| `ResolutionFourK` | 4K | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/response.mdx b/client-sdks/go/api-reference/models/response.mdx deleted file mode 100644 index 14b80235..00000000 --- a/client-sdks/go/api-reference/models/response.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Response - Go SDK -sidebarTitle: Response -description: Response type definition -seoTitle: Response Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/response' -'og:site_name': OpenRouter Documentation -'og:title': Response Type | OpenRouter Go SDK -'og:description': >- - Response type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Response%20-%20Go%20SDK&description=Response%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseformat.mdx b/client-sdks/go/api-reference/models/responseformat.mdx deleted file mode 100644 index 3aea9638..00000000 --- a/client-sdks/go/api-reference/models/responseformat.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: ResponseFormat - Go SDK -sidebarTitle: ResponseFormat -description: ResponseFormat type definition -seoTitle: ResponseFormat Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseformat' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormat Type | OpenRouter Go SDK -'og:description': >- - ResponseFormat type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormat%20-%20Go%20SDK&description=ResponseFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Response format configuration - -## Supported Types - -### ChatFormatGrammarConfig - -```go lines -responseFormat := components.CreateResponseFormatGrammar(components.ChatFormatGrammarConfig{/* values here */}) -``` - -### FormatJSONObjectConfig - -```go lines -responseFormat := components.CreateResponseFormatJSONObject(components.FormatJSONObjectConfig{/* values here */}) -``` - -### ChatFormatJSONSchemaConfig - -```go lines -responseFormat := components.CreateResponseFormatJSONSchema(components.ChatFormatJSONSchemaConfig{/* values here */}) -``` - -### ChatFormatPythonConfig - -```go lines -responseFormat := components.CreateResponseFormatPython(components.ChatFormatPythonConfig{/* values here */}) -``` - -### ChatFormatTextConfig - -```go lines -responseFormat := components.CreateResponseFormatText(components.ChatFormatTextConfig{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch responseFormat.Type { - case components.ResponseFormatTypeGrammar: - // responseFormat.ChatFormatGrammarConfig is populated - case components.ResponseFormatTypeJSONObject: - // responseFormat.FormatJSONObjectConfig is populated - case components.ResponseFormatTypeJSONSchema: - // responseFormat.ChatFormatJSONSchemaConfig is populated - case components.ResponseFormatTypePython: - // responseFormat.ChatFormatPythonConfig is populated - case components.ResponseFormatTypeText: - // responseFormat.ChatFormatTextConfig is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseformatenum.mdx b/client-sdks/go/api-reference/models/responseformatenum.mdx deleted file mode 100644 index 4f75a63d..00000000 --- a/client-sdks/go/api-reference/models/responseformatenum.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ResponseFormatEnum - Go SDK -sidebarTitle: ResponseFormatEnum -description: ResponseFormatEnum type definition -seoTitle: ResponseFormatEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseformatenum' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatEnum Type | OpenRouter Go SDK -'og:description': >- - ResponseFormatEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatEnum%20-%20Go%20SDK&description=ResponseFormatEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Audio output format - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponseFormatEnumMp3 - -// Open enum: custom values can be created with a direct type cast -custom := components.ResponseFormatEnum("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `ResponseFormatEnumMp3` | mp3 | -| `ResponseFormatEnumPcm` | pcm | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsehealingplugin.mdx b/client-sdks/go/api-reference/models/responsehealingplugin.mdx deleted file mode 100644 index 1c123473..00000000 --- a/client-sdks/go/api-reference/models/responsehealingplugin.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseHealingPlugin - Go SDK -sidebarTitle: ResponseHealingPlugin -description: ResponseHealingPlugin type definition -seoTitle: ResponseHealingPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responsehealingplugin' -'og:site_name': OpenRouter Documentation -'og:title': ResponseHealingPlugin Type | OpenRouter Go SDK -'og:description': >- - ResponseHealingPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseHealingPlugin%20-%20Go%20SDK&description=ResponseHealingPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/responsehealingpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsehealingpluginid.mdx b/client-sdks/go/api-reference/models/responsehealingpluginid.mdx deleted file mode 100644 index 1f8ef437..00000000 --- a/client-sdks/go/api-reference/models/responsehealingpluginid.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponseHealingPluginID - Go SDK -sidebarTitle: ResponseHealingPluginID -description: ResponseHealingPluginID type definition -seoTitle: ResponseHealingPluginID Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responsehealingpluginid -'og:site_name': OpenRouter Documentation -'og:title': ResponseHealingPluginID Type | OpenRouter Go SDK -'og:description': >- - ResponseHealingPluginID type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseHealingPluginID%20-%20Go%20SDK&description=ResponseHealingPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponseHealingPluginIDResponseHealing -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `ResponseHealingPluginIDResponseHealing` | response-healing | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseincludesenum.mdx b/client-sdks/go/api-reference/models/responseincludesenum.mdx deleted file mode 100644 index 085797b1..00000000 --- a/client-sdks/go/api-reference/models/responseincludesenum.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ResponseIncludesEnum - Go SDK -sidebarTitle: ResponseIncludesEnum -description: ResponseIncludesEnum type definition -seoTitle: ResponseIncludesEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseincludesenum' -'og:site_name': OpenRouter Documentation -'og:title': ResponseIncludesEnum Type | OpenRouter Go SDK -'og:description': >- - ResponseIncludesEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseIncludesEnum%20-%20Go%20SDK&description=ResponseIncludesEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponseIncludesEnumFileSearchCallResults - -// Open enum: custom values can be created with a direct type cast -custom := components.ResponseIncludesEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `ResponseIncludesEnumFileSearchCallResults` | file_search_call.results | -| `ResponseIncludesEnumMessageInputImageImageURL` | message.input_image.image_url | -| `ResponseIncludesEnumComputerCallOutputOutputImageURL` | computer_call_output.output.image_url | -| `ResponseIncludesEnumReasoningEncryptedContent` | reasoning.encrypted_content | -| `ResponseIncludesEnumCodeInterpreterCallOutputs` | code_interpreter_call.outputs | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseoutputtext.mdx b/client-sdks/go/api-reference/models/responseoutputtext.mdx deleted file mode 100644 index 00bceef0..00000000 --- a/client-sdks/go/api-reference/models/responseoutputtext.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponseOutputText - Go SDK -sidebarTitle: ResponseOutputText -description: ResponseOutputText type definition -seoTitle: ResponseOutputText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseoutputtext' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputText Type | OpenRouter Go SDK -'og:description': >- - ResponseOutputText type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputText%20-%20Go%20SDK&description=ResponseOutputText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.OpenAIResponsesAnnotation](/client-sdks/go/api-reference/models/openairesponsesannotation) | :heavy_minus_sign: | N/A | -| `Logprobs` | [][components.Logprob](/client-sdks/go/api-reference/models/logprob) | :heavy_minus_sign: | N/A | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ResponseOutputTextType](/client-sdks/go/api-reference/models/responseoutputtexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseoutputtexttoplogprob.mdx b/client-sdks/go/api-reference/models/responseoutputtexttoplogprob.mdx deleted file mode 100644 index da5a1802..00000000 --- a/client-sdks/go/api-reference/models/responseoutputtexttoplogprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponseOutputTextTopLogprob - Go SDK -sidebarTitle: ResponseOutputTextTopLogprob -description: ResponseOutputTextTopLogprob type definition -seoTitle: ResponseOutputTextTopLogprob Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responseoutputtexttoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextTopLogprob Type | OpenRouter Go SDK -'og:description': >- - ResponseOutputTextTopLogprob type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextTopLogprob%20-%20Go%20SDK&description=ResponseOutputTextTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_check_mark: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseoutputtexttype.mdx b/client-sdks/go/api-reference/models/responseoutputtexttype.mdx deleted file mode 100644 index 524ce35a..00000000 --- a/client-sdks/go/api-reference/models/responseoutputtexttype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ResponseOutputTextType - Go SDK -sidebarTitle: ResponseOutputTextType -description: ResponseOutputTextType type definition -seoTitle: ResponseOutputTextType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseoutputtexttype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextType Type | OpenRouter Go SDK -'og:description': >- - ResponseOutputTextType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextType%20-%20Go%20SDK&description=ResponseOutputTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponseOutputTextTypeOutputText -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `ResponseOutputTextTypeOutputText` | output_text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responseserrorfield.mdx b/client-sdks/go/api-reference/models/responseserrorfield.mdx deleted file mode 100644 index 35fd2831..00000000 --- a/client-sdks/go/api-reference/models/responseserrorfield.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponsesErrorField - Go SDK -sidebarTitle: ResponsesErrorField -description: ResponsesErrorField type definition -seoTitle: ResponsesErrorField Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responseserrorfield' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesErrorField Type | OpenRouter Go SDK -'og:description': >- - ResponsesErrorField type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesErrorField%20-%20Go%20SDK&description=ResponsesErrorField%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error information returned from the API - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Code` | [components.Code](/client-sdks/go/api-reference/models/code) | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesrequest.mdx b/client-sdks/go/api-reference/models/responsesrequest.mdx deleted file mode 100644 index 00fa8bd7..00000000 --- a/client-sdks/go/api-reference/models/responsesrequest.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: ResponsesRequest - Go SDK -sidebarTitle: ResponsesRequest -description: ResponsesRequest type definition -seoTitle: ResponsesRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responsesrequest' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequest Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequest%20-%20Go%20SDK&description=ResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Request schema for Responses endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `ImageConfig` | map[string][components.ImageConfig](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/responseincludesenum)] | :heavy_minus_sign: | N/A | | -| `Input` | [*components.InputsUnion](/client-sdks/go/api-reference/models/inputsunion) | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
`{"content": "What is the weather today?","role": "user"}`
] | -| `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](/client-sdks/go/api-reference/models/storedprompttemplate)] | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](/client-sdks/go/api-reference/models/providerpreferences)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](/client-sdks/go/api-reference/models/reasoningconfig)] | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"enabled": true,"summary": "auto"}` | -| `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/stopservertoolswhencondition) | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"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](/client-sdks/go/api-reference/models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`
\} | -| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](/client-sdks/go/api-reference/models/openairesponsestoolchoiceunion) | :heavy_minus_sign: | N/A | auto | -| `Tools` | [][components.ResponsesRequestToolUnion](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/responsesrequestplugin.mdx b/client-sdks/go/api-reference/models/responsesrequestplugin.mdx deleted file mode 100644 index 7e85e125..00000000 --- a/client-sdks/go/api-reference/models/responsesrequestplugin.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: ResponsesRequestPlugin - Go SDK -sidebarTitle: ResponsesRequestPlugin -description: ResponsesRequestPlugin type definition -seoTitle: ResponsesRequestPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responsesrequestplugin' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestPlugin Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequestPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestPlugin%20-%20Go%20SDK&description=ResponsesRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AutoRouterPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginAutoRouter(components.AutoRouterPlugin{/* values here */}) -``` - -### ContextCompressionPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginContextCompression(components.ContextCompressionPlugin{/* values here */}) -``` - -### FileParserPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginFileParser(components.FileParserPlugin{/* values here */}) -``` - -### FusionPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginFusion(components.FusionPlugin{/* values here */}) -``` - -### ModerationPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginModeration(components.ModerationPlugin{/* values here */}) -``` - -### ParetoRouterPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginParetoRouter(components.ParetoRouterPlugin{/* values here */}) -``` - -### ResponseHealingPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginResponseHealing(components.ResponseHealingPlugin{/* values here */}) -``` - -### WebSearchPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginWeb(components.WebSearchPlugin{/* values here */}) -``` - -### WebFetchPlugin - -```go lines -responsesRequestPlugin := components.CreateResponsesRequestPluginWebFetch(components.WebFetchPlugin{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch responsesRequestPlugin.Type { - case components.ResponsesRequestPluginTypeAutoRouter: - // responsesRequestPlugin.AutoRouterPlugin is populated - case components.ResponsesRequestPluginTypeContextCompression: - // responsesRequestPlugin.ContextCompressionPlugin is populated - case components.ResponsesRequestPluginTypeFileParser: - // responsesRequestPlugin.FileParserPlugin is populated - case components.ResponsesRequestPluginTypeFusion: - // responsesRequestPlugin.FusionPlugin is populated - case components.ResponsesRequestPluginTypeModeration: - // responsesRequestPlugin.ModerationPlugin is populated - case components.ResponsesRequestPluginTypeParetoRouter: - // responsesRequestPlugin.ParetoRouterPlugin is populated - case components.ResponsesRequestPluginTypeResponseHealing: - // responsesRequestPlugin.ResponseHealingPlugin is populated - case components.ResponsesRequestPluginTypeWeb: - // responsesRequestPlugin.WebSearchPlugin is populated - case components.ResponsesRequestPluginTypeWebFetch: - // responsesRequestPlugin.WebFetchPlugin is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesrequestservicetier.mdx b/client-sdks/go/api-reference/models/responsesrequestservicetier.mdx deleted file mode 100644 index 0dc1150d..00000000 --- a/client-sdks/go/api-reference/models/responsesrequestservicetier.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ResponsesRequestServiceTier - Go SDK -sidebarTitle: ResponsesRequestServiceTier -description: ResponsesRequestServiceTier type definition -seoTitle: ResponsesRequestServiceTier Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responsesrequestservicetier -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestServiceTier Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequestServiceTier type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestServiceTier%20-%20Go%20SDK&description=ResponsesRequestServiceTier%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponsesRequestServiceTierAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.ResponsesRequestServiceTier("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ResponsesRequestServiceTierAuto` | auto | -| `ResponsesRequestServiceTierDefault` | default | -| `ResponsesRequestServiceTierFlex` | flex | -| `ResponsesRequestServiceTierPriority` | priority | -| `ResponsesRequestServiceTierScale` | scale | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesrequesttoolfunction.mdx b/client-sdks/go/api-reference/models/responsesrequesttoolfunction.mdx deleted file mode 100644 index b67349e6..00000000 --- a/client-sdks/go/api-reference/models/responsesrequesttoolfunction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponsesRequestToolFunction - Go SDK -sidebarTitle: ResponsesRequestToolFunction -description: ResponsesRequestToolFunction type definition -seoTitle: ResponsesRequestToolFunction Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responsesrequesttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolFunction Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequestToolFunction type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolFunction%20-%20Go%20SDK&description=ResponsesRequestToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/responsesrequesttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesrequesttoolunion.mdx b/client-sdks/go/api-reference/models/responsesrequesttoolunion.mdx deleted file mode 100644 index 4fa22385..00000000 --- a/client-sdks/go/api-reference/models/responsesrequesttoolunion.mdx +++ /dev/null @@ -1,207 +0,0 @@ ---- -title: ResponsesRequestToolUnion - Go SDK -sidebarTitle: ResponsesRequestToolUnion -description: ResponsesRequestToolUnion type definition -seoTitle: ResponsesRequestToolUnion Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responsesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolUnion Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequestToolUnion type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolUnion%20-%20Go%20SDK&description=ResponsesRequestToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ResponsesRequestToolFunction - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionFunction(components.ResponsesRequestToolFunction{/* values here */}) -``` - -### PreviewWebSearchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionWebSearchPreview(components.PreviewWebSearchServerTool{/* values here */}) -``` - -### Preview20250311WebSearchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionWebSearchPreview20250311(components.Preview20250311WebSearchServerTool{/* values here */}) -``` - -### LegacyWebSearchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionWebSearch(components.LegacyWebSearchServerTool{/* values here */}) -``` - -### WebSearchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionWebSearch20250826(components.WebSearchServerTool{/* values here */}) -``` - -### FileSearchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionFileSearch(components.FileSearchServerTool{/* values here */}) -``` - -### ComputerUseServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionComputerUsePreview(components.ComputerUseServerTool{/* values here */}) -``` - -### CodeInterpreterServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionCodeInterpreter(components.CodeInterpreterServerTool{/* values here */}) -``` - -### McpServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionMcp(components.McpServerTool{/* values here */}) -``` - -### ImageGenerationServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionImageGeneration(components.ImageGenerationServerTool{/* values here */}) -``` - -### CodexLocalShellTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionLocalShell(components.CodexLocalShellTool{/* values here */}) -``` - -### ShellServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionShell(components.ShellServerTool{/* values here */}) -``` - -### ApplyPatchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionApplyPatch(components.ApplyPatchServerTool{/* values here */}) -``` - -### CustomTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionCustom(components.CustomTool{/* values here */}) -``` - -### DatetimeServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterDatetime(components.DatetimeServerTool{/* values here */}) -``` - -### FusionServerToolOpenRouter - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterFusion(components.FusionServerToolOpenRouter{/* values here */}) -``` - -### ImageGenerationServerToolOpenRouter - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterImageGeneration(components.ImageGenerationServerToolOpenRouter{/* values here */}) -``` - -### ChatSearchModelsServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterExperimentalSearchModels(components.ChatSearchModelsServerTool{/* values here */}) -``` - -### WebFetchServerTool - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterWebFetch(components.WebFetchServerTool{/* values here */}) -``` - -### WebSearchServerToolOpenRouter - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterWebSearch(components.WebSearchServerToolOpenRouter{/* values here */}) -``` - -### ApplyPatchServerToolOpenRouter - -```go lines -responsesRequestToolUnion := components.CreateResponsesRequestToolUnionOpenrouterApplyPatch(components.ApplyPatchServerToolOpenRouter{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch responsesRequestToolUnion.Type { - case components.ResponsesRequestToolUnionTypeFunction: - // responsesRequestToolUnion.ResponsesRequestToolFunction is populated - case components.ResponsesRequestToolUnionTypeWebSearchPreview: - // responsesRequestToolUnion.PreviewWebSearchServerTool is populated - case components.ResponsesRequestToolUnionTypeWebSearchPreview20250311: - // responsesRequestToolUnion.Preview20250311WebSearchServerTool is populated - case components.ResponsesRequestToolUnionTypeWebSearch: - // responsesRequestToolUnion.LegacyWebSearchServerTool is populated - case components.ResponsesRequestToolUnionTypeWebSearch20250826: - // responsesRequestToolUnion.WebSearchServerTool is populated - case components.ResponsesRequestToolUnionTypeFileSearch: - // responsesRequestToolUnion.FileSearchServerTool is populated - case components.ResponsesRequestToolUnionTypeComputerUsePreview: - // responsesRequestToolUnion.ComputerUseServerTool is populated - case components.ResponsesRequestToolUnionTypeCodeInterpreter: - // responsesRequestToolUnion.CodeInterpreterServerTool is populated - case components.ResponsesRequestToolUnionTypeMcp: - // responsesRequestToolUnion.McpServerTool is populated - case components.ResponsesRequestToolUnionTypeImageGeneration: - // responsesRequestToolUnion.ImageGenerationServerTool is populated - case components.ResponsesRequestToolUnionTypeLocalShell: - // responsesRequestToolUnion.CodexLocalShellTool is populated - case components.ResponsesRequestToolUnionTypeShell: - // responsesRequestToolUnion.ShellServerTool is populated - case components.ResponsesRequestToolUnionTypeApplyPatch: - // responsesRequestToolUnion.ApplyPatchServerTool is populated - case components.ResponsesRequestToolUnionTypeCustom: - // responsesRequestToolUnion.CustomTool is populated - case components.ResponsesRequestToolUnionTypeOpenrouterDatetime: - // responsesRequestToolUnion.DatetimeServerTool is populated - case components.ResponsesRequestToolUnionTypeOpenrouterFusion: - // responsesRequestToolUnion.FusionServerToolOpenRouter is populated - case components.ResponsesRequestToolUnionTypeOpenrouterImageGeneration: - // responsesRequestToolUnion.ImageGenerationServerToolOpenRouter is populated - case components.ResponsesRequestToolUnionTypeOpenrouterExperimentalSearchModels: - // responsesRequestToolUnion.ChatSearchModelsServerTool is populated - case components.ResponsesRequestToolUnionTypeOpenrouterWebFetch: - // responsesRequestToolUnion.WebFetchServerTool is populated - case components.ResponsesRequestToolUnionTypeOpenrouterWebSearch: - // responsesRequestToolUnion.WebSearchServerToolOpenRouter is populated - case components.ResponsesRequestToolUnionTypeOpenrouterApplyPatch: - // responsesRequestToolUnion.ApplyPatchServerToolOpenRouter is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesrequesttype.mdx b/client-sdks/go/api-reference/models/responsesrequesttype.mdx deleted file mode 100644 index c9691c92..00000000 --- a/client-sdks/go/api-reference/models/responsesrequesttype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ResponsesRequestType - Go SDK -sidebarTitle: ResponsesRequestType -description: ResponsesRequestType type definition -seoTitle: ResponsesRequestType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/responsesrequesttype' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestType Type | OpenRouter Go SDK -'og:description': >- - ResponsesRequestType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestType%20-%20Go%20SDK&description=ResponsesRequestType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ResponsesRequestTypeFunction -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `ResponsesRequestTypeFunction` | function | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/responsesstreamingresponse.mdx b/client-sdks/go/api-reference/models/responsesstreamingresponse.mdx deleted file mode 100644 index 76e9f78c..00000000 --- a/client-sdks/go/api-reference/models/responsesstreamingresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesStreamingResponse - Go SDK -sidebarTitle: ResponsesStreamingResponse -description: ResponsesStreamingResponse type definition -seoTitle: ResponsesStreamingResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/responsesstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': ResponsesStreamingResponse Type | OpenRouter Go SDK -'og:description': >- - ResponsesStreamingResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesStreamingResponse%20-%20Go%20SDK&description=ResponsesStreamingResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.StreamEvents](/client-sdks/go/api-reference/models/streamevents) | :heavy_check_mark: | Union of all possible event types emitted during response streaming | `{"response": {"created_at": 1704067200,"error": 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,"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/client-sdks/go/api-reference/models/routerattempt.mdx b/client-sdks/go/api-reference/models/routerattempt.mdx deleted file mode 100644 index 635f3814..00000000 --- a/client-sdks/go/api-reference/models/routerattempt.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RouterAttempt - Go SDK -sidebarTitle: RouterAttempt -description: RouterAttempt type definition -seoTitle: RouterAttempt Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/routerattempt' -'og:site_name': OpenRouter Documentation -'og:title': RouterAttempt Type | OpenRouter Go SDK -'og:description': >- - RouterAttempt type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterAttempt%20-%20Go%20SDK&description=RouterAttempt%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Provider` | `string` | :heavy_check_mark: | N/A | -| `Status` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/routerparams.mdx b/client-sdks/go/api-reference/models/routerparams.mdx deleted file mode 100644 index 618add34..00000000 --- a/client-sdks/go/api-reference/models/routerparams.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: RouterParams - Go SDK -sidebarTitle: RouterParams -description: RouterParams type definition -seoTitle: RouterParams Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/routerparams' -'og:site_name': OpenRouter Documentation -'og:title': RouterParams Type | OpenRouter Go SDK -'og:description': >- - RouterParams type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterParams%20-%20Go%20SDK&description=RouterParams%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `QualityFloor` | `*float64` | :heavy_minus_sign: | N/A | | -| `ThroughputFloor` | `*float64` | :heavy_minus_sign: | N/A | | -| `VersionGroup` | `*string` | :heavy_minus_sign: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/routingstrategy.mdx b/client-sdks/go/api-reference/models/routingstrategy.mdx deleted file mode 100644 index 3f7514f7..00000000 --- a/client-sdks/go/api-reference/models/routingstrategy.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: RoutingStrategy - Go SDK -sidebarTitle: RoutingStrategy -description: RoutingStrategy type definition -seoTitle: RoutingStrategy Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/routingstrategy' -'og:site_name': OpenRouter Documentation -'og:title': RoutingStrategy Type | OpenRouter Go SDK -'og:description': >- - RoutingStrategy type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RoutingStrategy%20-%20Go%20SDK&description=RoutingStrategy%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.RoutingStrategyDirect - -// Open enum: custom values can be created with a direct type cast -custom := components.RoutingStrategy("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RoutingStrategyDirect` | direct | -| `RoutingStrategyAuto` | auto | -| `RoutingStrategyFree` | free | -| `RoutingStrategyLatest` | latest | -| `RoutingStrategyAlias` | alias | -| `RoutingStrategyFallback` | fallback | -| `RoutingStrategyPareto` | pareto | -| `RoutingStrategyBodybuilder` | bodybuilder | -| `RoutingStrategyFusion` | fusion | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/rule.mdx b/client-sdks/go/api-reference/models/rule.mdx deleted file mode 100644 index 747115a1..00000000 --- a/client-sdks/go/api-reference/models/rule.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Rule - Go SDK -sidebarTitle: Rule -description: Rule type definition -seoTitle: Rule Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/rule' -'og:site_name': OpenRouter Documentation -'og:title': Rule Type | OpenRouter Go SDK -'og:description': >- - Rule type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rule%20-%20Go%20SDK&description=Rule%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `Field` | [components.Field](/client-sdks/go/api-reference/models/field) | :heavy_check_mark: | N/A | -| `Operator` | [components.Operator](/client-sdks/go/api-reference/models/operator) | :heavy_check_mark: | N/A | -| `Value` | [*components.ObservabilityFilterRulesConfigValue](/client-sdks/go/api-reference/models/observabilityfilterrulesconfigvalue) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/searchcontextsizeenum.mdx b/client-sdks/go/api-reference/models/searchcontextsizeenum.mdx deleted file mode 100644 index 10f6b815..00000000 --- a/client-sdks/go/api-reference/models/searchcontextsizeenum.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: SearchContextSizeEnum - Go SDK -sidebarTitle: SearchContextSizeEnum -description: SearchContextSizeEnum type definition -seoTitle: SearchContextSizeEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/searchcontextsizeenum' -'og:site_name': OpenRouter Documentation -'og:title': SearchContextSizeEnum Type | OpenRouter Go SDK -'og:description': >- - SearchContextSizeEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchContextSizeEnum%20-%20Go%20SDK&description=SearchContextSizeEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Size of the search context for web search tools - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SearchContextSizeEnumLow - -// Open enum: custom values can be created with a direct type cast -custom := components.SearchContextSizeEnum("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `SearchContextSizeEnumLow` | low | -| `SearchContextSizeEnumMedium` | medium | -| `SearchContextSizeEnumHigh` | high | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/searchmodelsservertoolconfig.mdx b/client-sdks/go/api-reference/models/searchmodelsservertoolconfig.mdx deleted file mode 100644 index 26ddeba3..00000000 --- a/client-sdks/go/api-reference/models/searchmodelsservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SearchModelsServerToolConfig - Go SDK -sidebarTitle: SearchModelsServerToolConfig -description: SearchModelsServerToolConfig type definition -seoTitle: SearchModelsServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/searchmodelsservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': SearchModelsServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - SearchModelsServerToolConfig type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchModelsServerToolConfig%20-%20Go%20SDK&description=SearchModelsServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:experimental__search_models server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/searchqualitylevel.mdx b/client-sdks/go/api-reference/models/searchqualitylevel.mdx deleted file mode 100644 index 8751539f..00000000 --- a/client-sdks/go/api-reference/models/searchqualitylevel.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: SearchQualityLevel - Go SDK -sidebarTitle: SearchQualityLevel -description: SearchQualityLevel type definition -seoTitle: SearchQualityLevel Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/searchqualitylevel' -'og:site_name': OpenRouter Documentation -'og:title': SearchQualityLevel Type | OpenRouter Go SDK -'og:description': >- - SearchQualityLevel type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchQualityLevel%20-%20Go%20SDK&description=SearchQualityLevel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -How much context to retrieve per result. Applies to Exa and Parallel 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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SearchQualityLevelLow - -// Open enum: custom values can be created with a direct type cast -custom := components.SearchQualityLevel("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `SearchQualityLevelLow` | low | -| `SearchQualityLevelMedium` | medium | -| `SearchQualityLevelHigh` | high | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/security.mdx b/client-sdks/go/api-reference/models/security.mdx deleted file mode 100644 index 1e50e955..00000000 --- a/client-sdks/go/api-reference/models/security.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Security - Go SDK -sidebarTitle: Security -description: Security type definition -seoTitle: Security Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/security' -'og:site_name': OpenRouter Documentation -'og:title': Security Type | OpenRouter Go SDK -'og:description': >- - Security type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Security%20-%20Go%20SDK&description=Security%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `APIKey` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/serviceunavailableresponseerror.mdx b/client-sdks/go/api-reference/models/serviceunavailableresponseerror.mdx deleted file mode 100644 index 99b9d4dd..00000000 --- a/client-sdks/go/api-reference/models/serviceunavailableresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ServiceUnavailableResponseError - Go SDK -sidebarTitle: ServiceUnavailableResponseError -description: ServiceUnavailableResponseError type definition -seoTitle: ServiceUnavailableResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/serviceunavailableresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseError Type | OpenRouter Go SDK -'og:description': >- - ServiceUnavailableResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseError%20-%20Go%20SDK&description=ServiceUnavailableResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Service Unavailable - Service temporarily unavailable - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ServiceUnavailableResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/serviceunavailableresponseerrordata.mdx b/client-sdks/go/api-reference/models/serviceunavailableresponseerrordata.mdx deleted file mode 100644 index 40e2287f..00000000 --- a/client-sdks/go/api-reference/models/serviceunavailableresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ServiceUnavailableResponseErrorData - Go SDK -sidebarTitle: ServiceUnavailableResponseErrorData -description: ServiceUnavailableResponseErrorData type definition -seoTitle: ServiceUnavailableResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/serviceunavailableresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - ServiceUnavailableResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseErrorData%20-%20Go%20SDK&description=ServiceUnavailableResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for ServiceUnavailableResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcallitem.mdx b/client-sdks/go/api-reference/models/shellcallitem.mdx deleted file mode 100644 index 60b23a6f..00000000 --- a/client-sdks/go/api-reference/models/shellcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ShellCallItem - Go SDK -sidebarTitle: ShellCallItem -description: ShellCallItem type definition -seoTitle: ShellCallItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellcallitem' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItem Type | OpenRouter Go SDK -'og:description': >- - ShellCallItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItem%20-%20Go%20SDK&description=ShellCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A shell command execution call (newer variant) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ShellCallItemAction](/client-sdks/go/api-reference/models/shellcallitemaction) | :heavy_check_mark: | N/A | | -| `CallID` | `string` | :heavy_check_mark: | N/A | | -| `Environment` | optionalnullable.OptionalNullable[`any`] | :heavy_minus_sign: | N/A | | -| `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ShellCallItemStatus](/client-sdks/go/api-reference/models/shellcallitemstatus)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallItemType](/client-sdks/go/api-reference/models/shellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcallitemaction.mdx b/client-sdks/go/api-reference/models/shellcallitemaction.mdx deleted file mode 100644 index 97070e3c..00000000 --- a/client-sdks/go/api-reference/models/shellcallitemaction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ShellCallItemAction - Go SDK -sidebarTitle: ShellCallItemAction -description: ShellCallItemAction type definition -seoTitle: ShellCallItemAction Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellcallitemaction' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemAction Type | OpenRouter Go SDK -'og:description': >- - ShellCallItemAction type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemAction%20-%20Go%20SDK&description=ShellCallItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `Commands` | []`string` | :heavy_check_mark: | N/A | -| `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcallitemstatus.mdx b/client-sdks/go/api-reference/models/shellcallitemstatus.mdx deleted file mode 100644 index d87165e2..00000000 --- a/client-sdks/go/api-reference/models/shellcallitemstatus.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ShellCallItemStatus - Go SDK -sidebarTitle: ShellCallItemStatus -description: ShellCallItemStatus type definition -seoTitle: ShellCallItemStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellcallitemstatus' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemStatus Type | OpenRouter Go SDK -'og:description': >- - ShellCallItemStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemStatus%20-%20Go%20SDK&description=ShellCallItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ShellCallItemStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.ShellCallItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `ShellCallItemStatusInProgress` | in_progress | -| `ShellCallItemStatusCompleted` | completed | -| `ShellCallItemStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcallitemtype.mdx b/client-sdks/go/api-reference/models/shellcallitemtype.mdx deleted file mode 100644 index 90df9b4f..00000000 --- a/client-sdks/go/api-reference/models/shellcallitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ShellCallItemType - Go SDK -sidebarTitle: ShellCallItemType -description: ShellCallItemType type definition -seoTitle: ShellCallItemType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellcallitemtype' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemType Type | OpenRouter Go SDK -'og:description': >- - ShellCallItemType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemType%20-%20Go%20SDK&description=ShellCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ShellCallItemTypeShellCall -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `ShellCallItemTypeShellCall` | shell_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcalloutputitem.mdx b/client-sdks/go/api-reference/models/shellcalloutputitem.mdx deleted file mode 100644 index 8dd4564a..00000000 --- a/client-sdks/go/api-reference/models/shellcalloutputitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ShellCallOutputItem - Go SDK -sidebarTitle: ShellCallOutputItem -description: ShellCallOutputItem type definition -seoTitle: ShellCallOutputItem Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellcalloutputitem' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItem Type | OpenRouter Go SDK -'og:description': >- - ShellCallOutputItem type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItem%20-%20Go%20SDK&description=ShellCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Output from a shell command execution (newer variant) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/shellcalloutputitemoutput) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ShellCallOutputItemStatus](/client-sdks/go/api-reference/models/shellcalloutputitemstatus)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallOutputItemType](/client-sdks/go/api-reference/models/shellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcalloutputitemoutput.mdx b/client-sdks/go/api-reference/models/shellcalloutputitemoutput.mdx deleted file mode 100644 index 5ef410ce..00000000 --- a/client-sdks/go/api-reference/models/shellcalloutputitemoutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ShellCallOutputItemOutput - Go SDK -sidebarTitle: ShellCallOutputItemOutput -description: ShellCallOutputItemOutput type definition -seoTitle: ShellCallOutputItemOutput Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/shellcalloutputitemoutput -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemOutput Type | OpenRouter Go SDK -'og:description': >- - ShellCallOutputItemOutput type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemOutput%20-%20Go%20SDK&description=ShellCallOutputItemOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `ExitCode` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `Type` | `string` | :heavy_check_mark: | N/A | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcalloutputitemstatus.mdx b/client-sdks/go/api-reference/models/shellcalloutputitemstatus.mdx deleted file mode 100644 index 200206ed..00000000 --- a/client-sdks/go/api-reference/models/shellcalloutputitemstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ShellCallOutputItemStatus - Go SDK -sidebarTitle: ShellCallOutputItemStatus -description: ShellCallOutputItemStatus type definition -seoTitle: ShellCallOutputItemStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/shellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemStatus Type | OpenRouter Go SDK -'og:description': >- - ShellCallOutputItemStatus type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemStatus%20-%20Go%20SDK&description=ShellCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ShellCallOutputItemStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.ShellCallOutputItemStatus("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------- | ------------------------------------- | -| `ShellCallOutputItemStatusInProgress` | in_progress | -| `ShellCallOutputItemStatusCompleted` | completed | -| `ShellCallOutputItemStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellcalloutputitemtype.mdx b/client-sdks/go/api-reference/models/shellcalloutputitemtype.mdx deleted file mode 100644 index 1043f0f1..00000000 --- a/client-sdks/go/api-reference/models/shellcalloutputitemtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ShellCallOutputItemType - Go SDK -sidebarTitle: ShellCallOutputItemType -description: ShellCallOutputItemType type definition -seoTitle: ShellCallOutputItemType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/shellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemType Type | OpenRouter Go SDK -'og:description': >- - ShellCallOutputItemType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemType%20-%20Go%20SDK&description=ShellCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ShellCallOutputItemTypeShellCallOutput -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `ShellCallOutputItemTypeShellCallOutput` | shell_call_output | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellservertool.mdx b/client-sdks/go/api-reference/models/shellservertool.mdx deleted file mode 100644 index 91dfbd69..00000000 --- a/client-sdks/go/api-reference/models/shellservertool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ShellServerTool - Go SDK -sidebarTitle: ShellServerTool -description: ShellServerTool type definition -seoTitle: ShellServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellservertool' -'og:site_name': OpenRouter Documentation -'og:title': ShellServerTool Type | OpenRouter Go SDK -'og:description': >- - ShellServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellServerTool%20-%20Go%20SDK&description=ShellServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Shell tool configuration - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.ShellServerToolType](/client-sdks/go/api-reference/models/shellservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/shellservertooltype.mdx b/client-sdks/go/api-reference/models/shellservertooltype.mdx deleted file mode 100644 index 4ac30950..00000000 --- a/client-sdks/go/api-reference/models/shellservertooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ShellServerToolType - Go SDK -sidebarTitle: ShellServerToolType -description: ShellServerToolType type definition -seoTitle: ShellServerToolType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/shellservertooltype' -'og:site_name': OpenRouter Documentation -'og:title': ShellServerToolType Type | OpenRouter Go SDK -'og:description': >- - ShellServerToolType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellServerToolType%20-%20Go%20SDK&description=ShellServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ShellServerToolTypeShell -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `ShellServerToolTypeShell` | shell | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/size.mdx b/client-sdks/go/api-reference/models/size.mdx deleted file mode 100644 index fb52e24b..00000000 --- a/client-sdks/go/api-reference/models/size.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Size - Go SDK -sidebarTitle: Size -description: Size type definition -seoTitle: Size Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/size' -'og:site_name': OpenRouter Documentation -'og:title': Size Type | OpenRouter Go SDK -'og:description': >- - Size type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Size%20-%20Go%20SDK&description=Size%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SizeOneThousandAndTwentyFourx1024 - -// Open enum: custom values can be created with a direct type cast -custom := components.Size("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `SizeOneThousandAndTwentyFourx1024` | 1024x1024 | -| `SizeOneThousandAndTwentyFourx1536` | 1024x1536 | -| `SizeOneThousandFiveHundredAndThirtySixx1024` | 1536x1024 | -| `SizeAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sort.mdx b/client-sdks/go/api-reference/models/sort.mdx deleted file mode 100644 index 0863c3c0..00000000 --- a/client-sdks/go/api-reference/models/sort.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Sort - Go SDK -sidebarTitle: Sort -description: Sort type definition -seoTitle: Sort Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sort' -'og:site_name': OpenRouter Documentation -'og:title': Sort Type | OpenRouter Go SDK -'og:description': >- - Sort type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Sort%20-%20Go%20SDK&description=Sort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### ProviderSort - -```go lines -sort := components.CreateSortProviderSort(components.ProviderSort{/* values here */}) -``` - -### ProviderSortConfig - -```go lines -sort := components.CreateSortProviderSortConfig(components.ProviderSortConfig{/* values here */}) -``` - -### - -```go lines -sort := components.CreateSortAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch sort.Type { - case components.SortTypeProviderSort: - // sort.ProviderSort is populated - case components.SortTypeProviderSortConfig: - // sort.ProviderSortConfig is populated - case components.SortTypeAny: - // sort.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sourcecontent.mdx b/client-sdks/go/api-reference/models/sourcecontent.mdx deleted file mode 100644 index e13ae84c..00000000 --- a/client-sdks/go/api-reference/models/sourcecontent.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SourceContent - Go SDK -sidebarTitle: SourceContent -description: SourceContent type definition -seoTitle: SourceContent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sourcecontent' -'og:site_name': OpenRouter Documentation -'og:title': SourceContent Type | OpenRouter Go SDK -'og:description': >- - SourceContent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SourceContent%20-%20Go%20SDK&description=SourceContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlockParamContent2](/client-sdks/go/api-reference/models/anthropicdocumentblockparamcontent2) | :heavy_check_mark: | N/A | -| `Type` | [components.SourceType](/client-sdks/go/api-reference/models/sourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sourcetype.mdx b/client-sdks/go/api-reference/models/sourcetype.mdx deleted file mode 100644 index e004d639..00000000 --- a/client-sdks/go/api-reference/models/sourcetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: SourceType - Go SDK -sidebarTitle: SourceType -description: SourceType type definition -seoTitle: SourceType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sourcetype' -'og:site_name': OpenRouter Documentation -'og:title': SourceType Type | OpenRouter Go SDK -'og:description': >- - SourceType type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SourceType%20-%20Go%20SDK&description=SourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SourceTypeContent -``` - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `SourceTypeContent` | content | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/speechrequest.mdx b/client-sdks/go/api-reference/models/speechrequest.mdx deleted file mode 100644 index cad2094b..00000000 --- a/client-sdks/go/api-reference/models/speechrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: SpeechRequest - Go SDK -sidebarTitle: SpeechRequest -description: SpeechRequest type definition -seoTitle: SpeechRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/speechrequest' -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequest Type | OpenRouter Go SDK -'og:description': >- - SpeechRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequest%20-%20Go%20SDK&description=SpeechRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text-to-speech request input - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Input` | `string` | :heavy_check_mark: | Text to synthesize | Hello world | -| `Model` | `string` | :heavy_check_mark: | TTS model identifier | elevenlabs/eleven-turbo-v2 | -| `Provider` | [*components.SpeechRequestProvider](/client-sdks/go/api-reference/models/speechrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `ResponseFormat` | [*components.ResponseFormatEnum](/client-sdks/go/api-reference/models/responseformatenum) | :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). | alloy | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/speechrequestprovider.mdx b/client-sdks/go/api-reference/models/speechrequestprovider.mdx deleted file mode 100644 index a4fe1299..00000000 --- a/client-sdks/go/api-reference/models/speechrequestprovider.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SpeechRequestProvider - Go SDK -sidebarTitle: SpeechRequestProvider -description: SpeechRequestProvider type definition -seoTitle: SpeechRequestProvider Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/speechrequestprovider' -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequestProvider Type | OpenRouter Go SDK -'og:description': >- - SpeechRequestProvider type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequestProvider%20-%20Go%20SDK&description=SpeechRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `Options` | [*components.ProviderOptions](/client-sdks/go/api-reference/models/provideroptions) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/speed.mdx b/client-sdks/go/api-reference/models/speed.mdx deleted file mode 100644 index f35ba1a4..00000000 --- a/client-sdks/go/api-reference/models/speed.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Speed - Go SDK -sidebarTitle: Speed -description: Speed type definition -seoTitle: Speed Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/speed' -'og:site_name': OpenRouter Documentation -'og:title': Speed Type | OpenRouter Go SDK -'og:description': >- - Speed type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speed%20-%20Go%20SDK&description=Speed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Controls output generation speed. When set to `fast`, uses a higher-speed inference configuration at premium pricing. Defaults to `standard` when omitted. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SpeedFast - -// Open enum: custom values can be created with a direct type cast -custom := components.Speed("custom_value") -``` - -## Values - -| Name | Value | -| --------------- | --------------- | -| `SpeedFast` | fast | -| `SpeedStandard` | standard | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stance.mdx b/client-sdks/go/api-reference/models/stance.mdx deleted file mode 100644 index 38ddd1f7..00000000 --- a/client-sdks/go/api-reference/models/stance.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Stance - Go SDK -sidebarTitle: Stance -description: Stance type definition -seoTitle: Stance Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/stance' -'og:site_name': OpenRouter Documentation -'og:title': Stance Type | OpenRouter Go SDK -'og:description': >- - Stance type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stance%20-%20Go%20SDK&description=Stance%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Model` | `string` | :heavy_check_mark: | N/A | -| `Stance` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stop.mdx b/client-sdks/go/api-reference/models/stop.mdx deleted file mode 100644 index 804cecea..00000000 --- a/client-sdks/go/api-reference/models/stop.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Stop - Go SDK -sidebarTitle: Stop -description: Stop type definition -seoTitle: Stop Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/stop' -'og:site_name': OpenRouter Documentation -'og:title': Stop Type | OpenRouter Go SDK -'og:description': >- - Stop type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stop%20-%20Go%20SDK&description=Stop%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop sequences (up to 4) - -## Supported Types - -### - -```go lines -stop := components.CreateStopStr(string{/* values here */}) -``` - -### - -```go lines -stop := components.CreateStopArrayOfStr([]string{/* values here */}) -``` - -### - -```go lines -stop := components.CreateStopAny(any{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch stop.Type { - case components.StopTypeStr: - // stop.Str is populated - case components.StopTypeArrayOfStr: - // stop.ArrayOfStr is populated - case components.StopTypeAny: - // stop.Any is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhencondition.mdx b/client-sdks/go/api-reference/models/stopservertoolswhencondition.mdx deleted file mode 100644 index 1950a543..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhencondition.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: StopServerToolsWhenCondition - Go SDK -sidebarTitle: StopServerToolsWhenCondition -description: StopServerToolsWhenCondition type definition -seoTitle: StopServerToolsWhenCondition Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhencondition -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenCondition Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenCondition type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenCondition%20-%20Go%20SDK&description=StopServerToolsWhenCondition%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A single condition that, when met, halts the server-tool agent loop. - -## Supported Types - -### StopServerToolsWhenFinishReasonIs - -```go lines -stopServerToolsWhenCondition := components.CreateStopServerToolsWhenConditionFinishReasonIs(components.StopServerToolsWhenFinishReasonIs{/* values here */}) -``` - -### StopServerToolsWhenHasToolCall - -```go lines -stopServerToolsWhenCondition := components.CreateStopServerToolsWhenConditionHasToolCall(components.StopServerToolsWhenHasToolCall{/* values here */}) -``` - -### StopServerToolsWhenMaxCost - -```go lines -stopServerToolsWhenCondition := components.CreateStopServerToolsWhenConditionMaxCost(components.StopServerToolsWhenMaxCost{/* values here */}) -``` - -### StopServerToolsWhenMaxTokensUsed - -```go lines -stopServerToolsWhenCondition := components.CreateStopServerToolsWhenConditionMaxTokensUsed(components.StopServerToolsWhenMaxTokensUsed{/* values here */}) -``` - -### StopServerToolsWhenStepCountIs - -```go lines -stopServerToolsWhenCondition := components.CreateStopServerToolsWhenConditionStepCountIs(components.StopServerToolsWhenStepCountIs{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch stopServerToolsWhenCondition.Type { - case components.StopServerToolsWhenConditionTypeFinishReasonIs: - // stopServerToolsWhenCondition.StopServerToolsWhenFinishReasonIs is populated - case components.StopServerToolsWhenConditionTypeHasToolCall: - // stopServerToolsWhenCondition.StopServerToolsWhenHasToolCall is populated - case components.StopServerToolsWhenConditionTypeMaxCost: - // stopServerToolsWhenCondition.StopServerToolsWhenMaxCost is populated - case components.StopServerToolsWhenConditionTypeMaxTokensUsed: - // stopServerToolsWhenCondition.StopServerToolsWhenMaxTokensUsed is populated - case components.StopServerToolsWhenConditionTypeStepCountIs: - // stopServerToolsWhenCondition.StopServerToolsWhenStepCountIs is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonis.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonis.mdx deleted file mode 100644 index def0ef0f..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonis.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenFinishReasonIs - Go SDK -sidebarTitle: StopServerToolsWhenFinishReasonIs -description: StopServerToolsWhenFinishReasonIs type definition -seoTitle: StopServerToolsWhenFinishReasonIs Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenfinishreasonis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenFinishReasonIs Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenFinishReasonIs type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenFinishReasonIs%20-%20Go%20SDK&description=StopServerToolsWhenFinishReasonIs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop when the upstream model emits this finish reason (e.g. `length`). - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `Reason` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenFinishReasonIsType](/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonistype.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonistype.mdx deleted file mode 100644 index 906d627a..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenfinishreasonistype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StopServerToolsWhenFinishReasonIsType - Go SDK -sidebarTitle: StopServerToolsWhenFinishReasonIsType -description: StopServerToolsWhenFinishReasonIsType type definition -seoTitle: StopServerToolsWhenFinishReasonIsType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenfinishreasonistype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenFinishReasonIsType Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenFinishReasonIsType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenFinishReasonIsType%20-%20Go%20SDK&description=StopServerToolsWhenFinishReasonIsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StopServerToolsWhenFinishReasonIsTypeFinishReasonIs -``` - -## Values - -| Name | Value | -| ----------------------------------------------------- | ----------------------------------------------------- | -| `StopServerToolsWhenFinishReasonIsTypeFinishReasonIs` | finish_reason_is | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcall.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcall.mdx deleted file mode 100644 index 320c29e4..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenHasToolCall - Go SDK -sidebarTitle: StopServerToolsWhenHasToolCall -description: StopServerToolsWhenHasToolCall type definition -seoTitle: StopServerToolsWhenHasToolCall Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenhastoolcall -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenHasToolCall Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenHasToolCall type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenHasToolCall%20-%20Go%20SDK&description=StopServerToolsWhenHasToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop after a tool with this name has been called. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenHasToolCallType](/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcalltype.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcalltype.mdx deleted file mode 100644 index b13b0a9f..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenhastoolcalltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StopServerToolsWhenHasToolCallType - Go SDK -sidebarTitle: StopServerToolsWhenHasToolCallType -description: StopServerToolsWhenHasToolCallType type definition -seoTitle: StopServerToolsWhenHasToolCallType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenhastoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenHasToolCallType Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenHasToolCallType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenHasToolCallType%20-%20Go%20SDK&description=StopServerToolsWhenHasToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StopServerToolsWhenHasToolCallTypeHasToolCall -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `StopServerToolsWhenHasToolCallTypeHasToolCall` | has_tool_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenmaxcost.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenmaxcost.mdx deleted file mode 100644 index c164d2a4..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenmaxcost.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenMaxCost - Go SDK -sidebarTitle: StopServerToolsWhenMaxCost -description: StopServerToolsWhenMaxCost type definition -seoTitle: StopServerToolsWhenMaxCost Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenmaxcost -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxCost Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenMaxCost type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxCost%20-%20Go%20SDK&description=StopServerToolsWhenMaxCost%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop once cumulative cost across the loop exceeds this dollar threshold. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `MaxCostInDollars` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxCostType](/client-sdks/go/api-reference/models/stopservertoolswhenmaxcosttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenmaxcosttype.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenmaxcosttype.mdx deleted file mode 100644 index c9a8e8b6..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenmaxcosttype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StopServerToolsWhenMaxCostType - Go SDK -sidebarTitle: StopServerToolsWhenMaxCostType -description: StopServerToolsWhenMaxCostType type definition -seoTitle: StopServerToolsWhenMaxCostType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenmaxcosttype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxCostType Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenMaxCostType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxCostType%20-%20Go%20SDK&description=StopServerToolsWhenMaxCostType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StopServerToolsWhenMaxCostTypeMaxCost -``` - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `StopServerToolsWhenMaxCostTypeMaxCost` | max_cost | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensused.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensused.mdx deleted file mode 100644 index 45cc4e16..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensused.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenMaxTokensUsed - Go SDK -sidebarTitle: StopServerToolsWhenMaxTokensUsed -description: StopServerToolsWhenMaxTokensUsed type definition -seoTitle: StopServerToolsWhenMaxTokensUsed Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenmaxtokensused -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxTokensUsed Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenMaxTokensUsed type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxTokensUsed%20-%20Go%20SDK&description=StopServerToolsWhenMaxTokensUsed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop once cumulative token usage across the loop exceeds this threshold. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `MaxTokens` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensusedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensusedtype.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensusedtype.mdx deleted file mode 100644 index bfec58de..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenmaxtokensusedtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StopServerToolsWhenMaxTokensUsedType - Go SDK -sidebarTitle: StopServerToolsWhenMaxTokensUsedType -description: StopServerToolsWhenMaxTokensUsedType type definition -seoTitle: StopServerToolsWhenMaxTokensUsedType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenmaxtokensusedtype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxTokensUsedType Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenMaxTokensUsedType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxTokensUsedType%20-%20Go%20SDK&description=StopServerToolsWhenMaxTokensUsedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StopServerToolsWhenMaxTokensUsedTypeMaxTokensUsed -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `StopServerToolsWhenMaxTokensUsedTypeMaxTokensUsed` | max_tokens_used | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenstepcountis.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenstepcountis.mdx deleted file mode 100644 index 97deafd2..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenstepcountis.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenStepCountIs - Go SDK -sidebarTitle: StopServerToolsWhenStepCountIs -description: StopServerToolsWhenStepCountIs type definition -seoTitle: StopServerToolsWhenStepCountIs Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenstepcountis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenStepCountIs Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenStepCountIs type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenStepCountIs%20-%20Go%20SDK&description=StopServerToolsWhenStepCountIs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Stop after the agent loop has executed this many steps. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `StepCount` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenStepCountIsType](/client-sdks/go/api-reference/models/stopservertoolswhenstepcountistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/stopservertoolswhenstepcountistype.mdx b/client-sdks/go/api-reference/models/stopservertoolswhenstepcountistype.mdx deleted file mode 100644 index ae4629ed..00000000 --- a/client-sdks/go/api-reference/models/stopservertoolswhenstepcountistype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StopServerToolsWhenStepCountIsType - Go SDK -sidebarTitle: StopServerToolsWhenStepCountIsType -description: StopServerToolsWhenStepCountIsType type definition -seoTitle: StopServerToolsWhenStepCountIsType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/stopservertoolswhenstepcountistype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenStepCountIsType Type | OpenRouter Go SDK -'og:description': >- - StopServerToolsWhenStepCountIsType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenStepCountIsType%20-%20Go%20SDK&description=StopServerToolsWhenStepCountIsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StopServerToolsWhenStepCountIsTypeStepCountIs -``` - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `StopServerToolsWhenStepCountIsTypeStepCountIs` | step_count_is | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/storedprompttemplate.mdx b/client-sdks/go/api-reference/models/storedprompttemplate.mdx deleted file mode 100644 index 3c3e08cd..00000000 --- a/client-sdks/go/api-reference/models/storedprompttemplate.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StoredPromptTemplate - Go SDK -sidebarTitle: StoredPromptTemplate -description: StoredPromptTemplate type definition -seoTitle: StoredPromptTemplate Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/storedprompttemplate' -'og:site_name': OpenRouter Documentation -'og:title': StoredPromptTemplate Type | OpenRouter Go SDK -'og:description': >- - StoredPromptTemplate type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StoredPromptTemplate%20-%20Go%20SDK&description=StoredPromptTemplate%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | N/A | -| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](/client-sdks/go/api-reference/models/variables)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streamevents.mdx b/client-sdks/go/api-reference/models/streamevents.mdx deleted file mode 100644 index 12bbfa7c..00000000 --- a/client-sdks/go/api-reference/models/streamevents.mdx +++ /dev/null @@ -1,314 +0,0 @@ ---- -title: StreamEvents - Go SDK -sidebarTitle: StreamEvents -description: StreamEvents type definition -seoTitle: StreamEvents Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/streamevents' -'og:site_name': OpenRouter Documentation -'og:title': StreamEvents Type | OpenRouter Go SDK -'og:description': >- - StreamEvents type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEvents%20-%20Go%20SDK&description=StreamEvents%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Union of all possible event types emitted during response streaming - -## Supported Types - -### ErrorEvent - -```go lines -streamEvents := components.CreateStreamEventsError(components.ErrorEvent{/* values here */}) -``` - -### ApplyPatchCallOperationDiffDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseApplyPatchCallOperationDiffDelta(components.ApplyPatchCallOperationDiffDeltaEvent{/* values here */}) -``` - -### ApplyPatchCallOperationDiffDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseApplyPatchCallOperationDiffDone(components.ApplyPatchCallOperationDiffDoneEvent{/* values here */}) -``` - -### StreamEventsResponseCompleted - -```go lines -streamEvents := components.CreateStreamEventsResponseCompleted(components.StreamEventsResponseCompleted{/* values here */}) -``` - -### ContentPartAddedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseContentPartAdded(components.ContentPartAddedEvent{/* values here */}) -``` - -### ContentPartDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseContentPartDone(components.ContentPartDoneEvent{/* values here */}) -``` - -### OpenResponsesCreatedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseCreated(components.OpenResponsesCreatedEvent{/* values here */}) -``` - -### CustomToolCallInputDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseCustomToolCallInputDelta(components.CustomToolCallInputDeltaEvent{/* values here */}) -``` - -### CustomToolCallInputDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseCustomToolCallInputDone(components.CustomToolCallInputDoneEvent{/* values here */}) -``` - -### StreamEventsResponseFailed - -```go lines -streamEvents := components.CreateStreamEventsResponseFailed(components.StreamEventsResponseFailed{/* values here */}) -``` - -### FunctionCallArgsDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseFunctionCallArgumentsDelta(components.FunctionCallArgsDeltaEvent{/* values here */}) -``` - -### FunctionCallArgsDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseFunctionCallArgumentsDone(components.FunctionCallArgsDoneEvent{/* values here */}) -``` - -### ImageGenCallCompletedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseImageGenerationCallCompleted(components.ImageGenCallCompletedEvent{/* values here */}) -``` - -### ImageGenCallGeneratingEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseImageGenerationCallGenerating(components.ImageGenCallGeneratingEvent{/* values here */}) -``` - -### ImageGenCallInProgressEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseImageGenerationCallInProgress(components.ImageGenCallInProgressEvent{/* values here */}) -``` - -### ImageGenCallPartialImageEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseImageGenerationCallPartialImage(components.ImageGenCallPartialImageEvent{/* values here */}) -``` - -### OpenResponsesInProgressEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseInProgress(components.OpenResponsesInProgressEvent{/* values here */}) -``` - -### StreamEventsResponseIncomplete - -```go lines -streamEvents := components.CreateStreamEventsResponseIncomplete(components.StreamEventsResponseIncomplete{/* values here */}) -``` - -### StreamEventsResponseOutputItemAdded - -```go lines -streamEvents := components.CreateStreamEventsResponseOutputItemAdded(components.StreamEventsResponseOutputItemAdded{/* values here */}) -``` - -### StreamEventsResponseOutputItemDone - -```go lines -streamEvents := components.CreateStreamEventsResponseOutputItemDone(components.StreamEventsResponseOutputItemDone{/* values here */}) -``` - -### AnnotationAddedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseOutputTextAnnotationAdded(components.AnnotationAddedEvent{/* values here */}) -``` - -### TextDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseOutputTextDelta(components.TextDeltaEvent{/* values here */}) -``` - -### TextDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseOutputTextDone(components.TextDoneEvent{/* values here */}) -``` - -### ReasoningSummaryPartAddedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningSummaryPartAdded(components.ReasoningSummaryPartAddedEvent{/* values here */}) -``` - -### ReasoningSummaryPartDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningSummaryPartDone(components.ReasoningSummaryPartDoneEvent{/* values here */}) -``` - -### ReasoningSummaryTextDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningSummaryTextDelta(components.ReasoningSummaryTextDeltaEvent{/* values here */}) -``` - -### ReasoningSummaryTextDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningSummaryTextDone(components.ReasoningSummaryTextDoneEvent{/* values here */}) -``` - -### ReasoningDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningTextDelta(components.ReasoningDeltaEvent{/* values here */}) -``` - -### ReasoningDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseReasoningTextDone(components.ReasoningDoneEvent{/* values here */}) -``` - -### RefusalDeltaEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseRefusalDelta(components.RefusalDeltaEvent{/* values here */}) -``` - -### RefusalDoneEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseRefusalDone(components.RefusalDoneEvent{/* values here */}) -``` - -### WebSearchCallCompletedEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseWebSearchCallCompleted(components.WebSearchCallCompletedEvent{/* values here */}) -``` - -### WebSearchCallInProgressEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseWebSearchCallInProgress(components.WebSearchCallInProgressEvent{/* values here */}) -``` - -### WebSearchCallSearchingEvent - -```go lines -streamEvents := components.CreateStreamEventsResponseWebSearchCallSearching(components.WebSearchCallSearchingEvent{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go expandable lines -switch streamEvents.Type { - case components.StreamEventsTypeError: - // streamEvents.ErrorEvent is populated - case components.StreamEventsTypeResponseApplyPatchCallOperationDiffDelta: - // streamEvents.ApplyPatchCallOperationDiffDeltaEvent is populated - case components.StreamEventsTypeResponseApplyPatchCallOperationDiffDone: - // streamEvents.ApplyPatchCallOperationDiffDoneEvent is populated - case components.StreamEventsTypeResponseCompleted: - // streamEvents.StreamEventsResponseCompleted is populated - case components.StreamEventsTypeResponseContentPartAdded: - // streamEvents.ContentPartAddedEvent is populated - case components.StreamEventsTypeResponseContentPartDone: - // streamEvents.ContentPartDoneEvent is populated - case components.StreamEventsTypeResponseCreated: - // streamEvents.OpenResponsesCreatedEvent is populated - case components.StreamEventsTypeResponseCustomToolCallInputDelta: - // streamEvents.CustomToolCallInputDeltaEvent is populated - case components.StreamEventsTypeResponseCustomToolCallInputDone: - // streamEvents.CustomToolCallInputDoneEvent is populated - case components.StreamEventsTypeResponseFailed: - // streamEvents.StreamEventsResponseFailed is populated - case components.StreamEventsTypeResponseFunctionCallArgumentsDelta: - // streamEvents.FunctionCallArgsDeltaEvent is populated - case components.StreamEventsTypeResponseFunctionCallArgumentsDone: - // streamEvents.FunctionCallArgsDoneEvent is populated - case components.StreamEventsTypeResponseImageGenerationCallCompleted: - // streamEvents.ImageGenCallCompletedEvent is populated - case components.StreamEventsTypeResponseImageGenerationCallGenerating: - // streamEvents.ImageGenCallGeneratingEvent is populated - case components.StreamEventsTypeResponseImageGenerationCallInProgress: - // streamEvents.ImageGenCallInProgressEvent is populated - case components.StreamEventsTypeResponseImageGenerationCallPartialImage: - // streamEvents.ImageGenCallPartialImageEvent is populated - case components.StreamEventsTypeResponseInProgress: - // streamEvents.OpenResponsesInProgressEvent is populated - case components.StreamEventsTypeResponseIncomplete: - // streamEvents.StreamEventsResponseIncomplete is populated - case components.StreamEventsTypeResponseOutputItemAdded: - // streamEvents.StreamEventsResponseOutputItemAdded is populated - case components.StreamEventsTypeResponseOutputItemDone: - // streamEvents.StreamEventsResponseOutputItemDone is populated - case components.StreamEventsTypeResponseOutputTextAnnotationAdded: - // streamEvents.AnnotationAddedEvent is populated - case components.StreamEventsTypeResponseOutputTextDelta: - // streamEvents.TextDeltaEvent is populated - case components.StreamEventsTypeResponseOutputTextDone: - // streamEvents.TextDoneEvent is populated - case components.StreamEventsTypeResponseReasoningSummaryPartAdded: - // streamEvents.ReasoningSummaryPartAddedEvent is populated - case components.StreamEventsTypeResponseReasoningSummaryPartDone: - // streamEvents.ReasoningSummaryPartDoneEvent is populated - case components.StreamEventsTypeResponseReasoningSummaryTextDelta: - // streamEvents.ReasoningSummaryTextDeltaEvent is populated - case components.StreamEventsTypeResponseReasoningSummaryTextDone: - // streamEvents.ReasoningSummaryTextDoneEvent is populated - case components.StreamEventsTypeResponseReasoningTextDelta: - // streamEvents.ReasoningDeltaEvent is populated - case components.StreamEventsTypeResponseReasoningTextDone: - // streamEvents.ReasoningDoneEvent is populated - case components.StreamEventsTypeResponseRefusalDelta: - // streamEvents.RefusalDeltaEvent is populated - case components.StreamEventsTypeResponseRefusalDone: - // streamEvents.RefusalDoneEvent is populated - case components.StreamEventsTypeResponseWebSearchCallCompleted: - // streamEvents.WebSearchCallCompletedEvent is populated - case components.StreamEventsTypeResponseWebSearchCallInProgress: - // streamEvents.WebSearchCallInProgressEvent is populated - case components.StreamEventsTypeResponseWebSearchCallSearching: - // streamEvents.WebSearchCallSearchingEvent is populated - default: - // Unknown type - use streamEvents.GetUnknownRaw() for raw JSON -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponsecompleted.mdx b/client-sdks/go/api-reference/models/streameventsresponsecompleted.mdx deleted file mode 100644 index 4396648b..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponsecompleted.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseCompleted - Go SDK -sidebarTitle: StreamEventsResponseCompleted -description: StreamEventsResponseCompleted type definition -seoTitle: StreamEventsResponseCompleted Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponsecompleted -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseCompleted Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseCompleted type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseCompleted%20-%20Go%20SDK&description=StreamEventsResponseCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has completed successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](/client-sdks/go/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"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](/client-sdks/go/api-reference/models/streameventsresponsecompletedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponsecompletedtype.mdx b/client-sdks/go/api-reference/models/streameventsresponsecompletedtype.mdx deleted file mode 100644 index e8b198fa..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponsecompletedtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StreamEventsResponseCompletedType - Go SDK -sidebarTitle: StreamEventsResponseCompletedType -description: StreamEventsResponseCompletedType type definition -seoTitle: StreamEventsResponseCompletedType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponsecompletedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseCompletedType Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseCompletedType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseCompletedType%20-%20Go%20SDK&description=StreamEventsResponseCompletedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StreamEventsResponseCompletedTypeResponseCompleted -``` - -## Values - -| Name | Value | -| ---------------------------------------------------- | ---------------------------------------------------- | -| `StreamEventsResponseCompletedTypeResponseCompleted` | response.completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponsefailed.mdx b/client-sdks/go/api-reference/models/streameventsresponsefailed.mdx deleted file mode 100644 index 82f76bc7..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponsefailed.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseFailed - Go SDK -sidebarTitle: StreamEventsResponseFailed -description: StreamEventsResponseFailed type definition -seoTitle: StreamEventsResponseFailed Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponsefailed -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseFailed Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseFailed type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseFailed%20-%20Go%20SDK&description=StreamEventsResponseFailed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has failed - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](/client-sdks/go/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"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](/client-sdks/go/api-reference/models/streameventsresponsefailedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponsefailedtype.mdx b/client-sdks/go/api-reference/models/streameventsresponsefailedtype.mdx deleted file mode 100644 index e0910824..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponsefailedtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StreamEventsResponseFailedType - Go SDK -sidebarTitle: StreamEventsResponseFailedType -description: StreamEventsResponseFailedType type definition -seoTitle: StreamEventsResponseFailedType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponsefailedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseFailedType Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseFailedType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseFailedType%20-%20Go%20SDK&description=StreamEventsResponseFailedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StreamEventsResponseFailedTypeResponseFailed -``` - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `StreamEventsResponseFailedTypeResponseFailed` | response.failed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseincomplete.mdx b/client-sdks/go/api-reference/models/streameventsresponseincomplete.mdx deleted file mode 100644 index 969ca9ce..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseincomplete.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseIncomplete - Go SDK -sidebarTitle: StreamEventsResponseIncomplete -description: StreamEventsResponseIncomplete type definition -seoTitle: StreamEventsResponseIncomplete Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseincomplete -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseIncomplete Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseIncomplete type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseIncomplete%20-%20Go%20SDK&description=StreamEventsResponseIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is incomplete - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](/client-sdks/go/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"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](/client-sdks/go/api-reference/models/streameventsresponseincompletetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseincompletetype.mdx b/client-sdks/go/api-reference/models/streameventsresponseincompletetype.mdx deleted file mode 100644 index f341bdf5..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseincompletetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StreamEventsResponseIncompleteType - Go SDK -sidebarTitle: StreamEventsResponseIncompleteType -description: StreamEventsResponseIncompleteType type definition -seoTitle: StreamEventsResponseIncompleteType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseincompletetype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseIncompleteType Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseIncompleteType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseIncompleteType%20-%20Go%20SDK&description=StreamEventsResponseIncompleteType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StreamEventsResponseIncompleteTypeResponseIncomplete -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `StreamEventsResponseIncompleteTypeResponseIncomplete` | response.incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseoutputitemadded.mdx b/client-sdks/go/api-reference/models/streameventsresponseoutputitemadded.mdx deleted file mode 100644 index 34174d99..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseoutputitemadded.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: StreamEventsResponseOutputItemAdded - Go SDK -sidebarTitle: StreamEventsResponseOutputItemAdded -description: StreamEventsResponseOutputItemAdded type definition -seoTitle: StreamEventsResponseOutputItemAdded Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseoutputitemadded -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemAdded Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseOutputItemAdded type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemAdded%20-%20Go%20SDK&description=StreamEventsResponseOutputItemAdded%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a new output item is added to the response - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](/client-sdks/go/api-reference/models/outputitems) | :heavy_check_mark: | An output item from the response | `{"content": [{"text": "Hello! How can I help you today?","type": "output_text"}`
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
\} | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemAddedType](/client-sdks/go/api-reference/models/streameventsresponseoutputitemaddedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseoutputitemaddedtype.mdx b/client-sdks/go/api-reference/models/streameventsresponseoutputitemaddedtype.mdx deleted file mode 100644 index f93bd05e..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseoutputitemaddedtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StreamEventsResponseOutputItemAddedType - Go SDK -sidebarTitle: StreamEventsResponseOutputItemAddedType -description: StreamEventsResponseOutputItemAddedType type definition -seoTitle: StreamEventsResponseOutputItemAddedType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseoutputitemaddedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemAddedType Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseOutputItemAddedType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemAddedType%20-%20Go%20SDK&description=StreamEventsResponseOutputItemAddedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StreamEventsResponseOutputItemAddedTypeResponseOutputItemAdded -``` - -## Values - -| Name | Value | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `StreamEventsResponseOutputItemAddedTypeResponseOutputItemAdded` | response.output_item.added | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseoutputitemdone.mdx b/client-sdks/go/api-reference/models/streameventsresponseoutputitemdone.mdx deleted file mode 100644 index 67366975..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseoutputitemdone.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: StreamEventsResponseOutputItemDone - Go SDK -sidebarTitle: StreamEventsResponseOutputItemDone -description: StreamEventsResponseOutputItemDone type definition -seoTitle: StreamEventsResponseOutputItemDone Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseoutputitemdone -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemDone Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseOutputItemDone type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemDone%20-%20Go%20SDK&description=StreamEventsResponseOutputItemDone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when an output item is complete - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](/client-sdks/go/api-reference/models/outputitems) | :heavy_check_mark: | An output item from the response | `{"content": [{"text": "Hello! How can I help you today?","type": "output_text"}`
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
\} | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemDoneType](/client-sdks/go/api-reference/models/streameventsresponseoutputitemdonetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streameventsresponseoutputitemdonetype.mdx b/client-sdks/go/api-reference/models/streameventsresponseoutputitemdonetype.mdx deleted file mode 100644 index adfaf94f..00000000 --- a/client-sdks/go/api-reference/models/streameventsresponseoutputitemdonetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: StreamEventsResponseOutputItemDoneType - Go SDK -sidebarTitle: StreamEventsResponseOutputItemDoneType -description: StreamEventsResponseOutputItemDoneType type definition -seoTitle: StreamEventsResponseOutputItemDoneType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streameventsresponseoutputitemdonetype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemDoneType Type | OpenRouter Go SDK -'og:description': >- - StreamEventsResponseOutputItemDoneType type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemDoneType%20-%20Go%20SDK&description=StreamEventsResponseOutputItemDoneType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.StreamEventsResponseOutputItemDoneTypeResponseOutputItemDone -``` - -## Values - -| Name | Value | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -| `StreamEventsResponseOutputItemDoneTypeResponseOutputItemDone` | response.output_item.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streamlogprob.mdx b/client-sdks/go/api-reference/models/streamlogprob.mdx deleted file mode 100644 index 5054bfca..00000000 --- a/client-sdks/go/api-reference/models/streamlogprob.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamLogprob - Go SDK -sidebarTitle: StreamLogprob -description: StreamLogprob type definition -seoTitle: StreamLogprob Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/streamlogprob' -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprob Type | OpenRouter Go SDK -'og:description': >- - StreamLogprob type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprob%20-%20Go%20SDK&description=StreamLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Log probability information for a token - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | -| `Logprob` | `float64` | :heavy_check_mark: | N/A | -| `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.StreamLogprobTopLogprob](/client-sdks/go/api-reference/models/streamlogprobtoplogprob) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/streamlogprobtoplogprob.mdx b/client-sdks/go/api-reference/models/streamlogprobtoplogprob.mdx deleted file mode 100644 index c240e6e5..00000000 --- a/client-sdks/go/api-reference/models/streamlogprobtoplogprob.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamLogprobTopLogprob - Go SDK -sidebarTitle: StreamLogprobTopLogprob -description: StreamLogprobTopLogprob type definition -seoTitle: StreamLogprobTopLogprob Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/streamlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprobTopLogprob Type | OpenRouter Go SDK -'og:description': >- - StreamLogprobTopLogprob type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprobTopLogprob%20-%20Go%20SDK&description=StreamLogprobTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Alternative token with its log probability - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Bytes` | []`int64` | :heavy_minus_sign: | N/A | -| `Logprob` | `*float64` | :heavy_minus_sign: | N/A | -| `Token` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sttinputaudio.mdx b/client-sdks/go/api-reference/models/sttinputaudio.mdx deleted file mode 100644 index a65a3088..00000000 --- a/client-sdks/go/api-reference/models/sttinputaudio.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: STTInputAudio - Go SDK -sidebarTitle: STTInputAudio -description: STTInputAudio type definition -seoTitle: STTInputAudio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sttinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': STTInputAudio Type | OpenRouter Go SDK -'og:description': >- - STTInputAudio type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTInputAudio%20-%20Go%20SDK&description=STTInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Base64-encoded audio to transcribe - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Data` | `string` | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `Format` | `string` | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sttrequest.mdx b/client-sdks/go/api-reference/models/sttrequest.mdx deleted file mode 100644 index 88a2a1a4..00000000 --- a/client-sdks/go/api-reference/models/sttrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: STTRequest - Go SDK -sidebarTitle: STTRequest -description: STTRequest type definition -seoTitle: STTRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sttrequest' -'og:site_name': OpenRouter Documentation -'og:title': STTRequest Type | OpenRouter Go SDK -'og:description': >- - STTRequest type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequest%20-%20Go%20SDK&description=STTRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Speech-to-text request input. Accepts a JSON body with input_audio containing base64-encoded audio. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `InputAudio` | [components.STTInputAudio](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/sttrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature for transcription | 0 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sttrequestprovider.mdx b/client-sdks/go/api-reference/models/sttrequestprovider.mdx deleted file mode 100644 index dbe42dfc..00000000 --- a/client-sdks/go/api-reference/models/sttrequestprovider.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: STTRequestProvider - Go SDK -sidebarTitle: STTRequestProvider -description: STTRequestProvider type definition -seoTitle: STTRequestProvider Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sttrequestprovider' -'og:site_name': OpenRouter Documentation -'og:title': STTRequestProvider Type | OpenRouter Go SDK -'og:description': >- - STTRequestProvider type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequestProvider%20-%20Go%20SDK&description=STTRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `Options` | [*components.ProviderOptions](/client-sdks/go/api-reference/models/provideroptions) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sttresponse.mdx b/client-sdks/go/api-reference/models/sttresponse.mdx deleted file mode 100644 index f9edb69d..00000000 --- a/client-sdks/go/api-reference/models/sttresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: STTResponse - Go SDK -sidebarTitle: STTResponse -description: STTResponse type definition -seoTitle: STTResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sttresponse' -'og:site_name': OpenRouter Documentation -'og:title': STTResponse Type | OpenRouter Go SDK -'og:description': >- - STTResponse type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTResponse%20-%20Go%20SDK&description=STTResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -STT response containing transcribed text and optional usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/sttusage.mdx b/client-sdks/go/api-reference/models/sttusage.mdx deleted file mode 100644 index fd4b13ea..00000000 --- a/client-sdks/go/api-reference/models/sttusage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: STTUsage - Go SDK -sidebarTitle: STTUsage -description: STTUsage type definition -seoTitle: STTUsage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/sttusage' -'og:site_name': OpenRouter Documentation -'og:title': STTUsage Type | OpenRouter Go SDK -'og:description': >- - STTUsage type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTUsage%20-%20Go%20SDK&description=STTUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Aggregated usage statistics for the request - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `Cost` | `*float64` | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `InputTokens` | `*int64` | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `OutputTokens` | `*int64` | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `Seconds` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/supportedaspectratio.mdx b/client-sdks/go/api-reference/models/supportedaspectratio.mdx deleted file mode 100644 index 716bb97d..00000000 --- a/client-sdks/go/api-reference/models/supportedaspectratio.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: SupportedAspectRatio - Go SDK -sidebarTitle: SupportedAspectRatio -description: SupportedAspectRatio type definition -seoTitle: SupportedAspectRatio Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/supportedaspectratio' -'og:site_name': OpenRouter Documentation -'og:title': SupportedAspectRatio Type | OpenRouter Go SDK -'og:description': >- - SupportedAspectRatio type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedAspectRatio%20-%20Go%20SDK&description=SupportedAspectRatio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SupportedAspectRatioOneHundredAndSixtyNine - -// Open enum: custom values can be created with a direct type cast -custom := components.SupportedAspectRatio("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `SupportedAspectRatioOneHundredAndSixtyNine` | 16:9 | -| `SupportedAspectRatioNineHundredAndSixteen` | 9:16 | -| `SupportedAspectRatioEleven` | 1:1 | -| `SupportedAspectRatioFortyThree` | 4:3 | -| `SupportedAspectRatioThirtyFour` | 3:4 | -| `SupportedAspectRatioThirtyTwo` | 3:2 | -| `SupportedAspectRatioTwentyThree` | 2:3 | -| `SupportedAspectRatioTwoHundredAndNineteen` | 21:9 | -| `SupportedAspectRatioNineHundredAndTwentyOne` | 9:21 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/supportedframeimage.mdx b/client-sdks/go/api-reference/models/supportedframeimage.mdx deleted file mode 100644 index 828e223f..00000000 --- a/client-sdks/go/api-reference/models/supportedframeimage.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: SupportedFrameImage - Go SDK -sidebarTitle: SupportedFrameImage -description: SupportedFrameImage type definition -seoTitle: SupportedFrameImage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/supportedframeimage' -'og:site_name': OpenRouter Documentation -'og:title': SupportedFrameImage Type | OpenRouter Go SDK -'og:description': >- - SupportedFrameImage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedFrameImage%20-%20Go%20SDK&description=SupportedFrameImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SupportedFrameImageFirstFrame - -// Open enum: custom values can be created with a direct type cast -custom := components.SupportedFrameImage("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `SupportedFrameImageFirstFrame` | first_frame | -| `SupportedFrameImageLastFrame` | last_frame | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/supportedresolution.mdx b/client-sdks/go/api-reference/models/supportedresolution.mdx deleted file mode 100644 index 6a0fa5da..00000000 --- a/client-sdks/go/api-reference/models/supportedresolution.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: SupportedResolution - Go SDK -sidebarTitle: SupportedResolution -description: SupportedResolution type definition -seoTitle: SupportedResolution Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/supportedresolution' -'og:site_name': OpenRouter Documentation -'og:title': SupportedResolution Type | OpenRouter Go SDK -'og:description': >- - SupportedResolution type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedResolution%20-%20Go%20SDK&description=SupportedResolution%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SupportedResolutionFourHundredAndEightyp - -// Open enum: custom values can be created with a direct type cast -custom := components.SupportedResolution("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `SupportedResolutionFourHundredAndEightyp` | 480p | -| `SupportedResolutionSevenHundredAndTwentyp` | 720p | -| `SupportedResolutionOneThousandAndEightyp` | 1080p | -| `SupportedResolutionOneK` | 1K | -| `SupportedResolutionTwoK` | 2K | -| `SupportedResolutionFourK` | 4K | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/supportedsize.mdx b/client-sdks/go/api-reference/models/supportedsize.mdx deleted file mode 100644 index df268bce..00000000 --- a/client-sdks/go/api-reference/models/supportedsize.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: SupportedSize - Go SDK -sidebarTitle: SupportedSize -description: SupportedSize type definition -seoTitle: SupportedSize Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/supportedsize' -'og:site_name': OpenRouter Documentation -'og:title': SupportedSize Type | OpenRouter Go SDK -'og:description': >- - SupportedSize type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedSize%20-%20Go%20SDK&description=SupportedSize%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SupportedSizeFourHundredAndEightyx480 - -// Open enum: custom values can be created with a direct type cast -custom := components.SupportedSize("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------------------------- | ----------------------------------------------------- | -| `SupportedSizeFourHundredAndEightyx480` | 480x480 | -| `SupportedSizeFourHundredAndEightyx640` | 480x640 | -| `SupportedSizeFourHundredAndEightyx720` | 480x720 | -| `SupportedSizeFourHundredAndEightyx854` | 480x854 | -| `SupportedSizeFourHundredAndEightyx1120` | 480x1120 | -| `SupportedSizeSixHundredAndFortyx480` | 640x480 | -| `SupportedSizeSevenHundredAndTwentyx480` | 720x480 | -| `SupportedSizeSevenHundredAndTwentyx720` | 720x720 | -| `SupportedSizeSevenHundredAndTwentyx960` | 720x960 | -| `SupportedSizeSevenHundredAndTwentyx1080` | 720x1080 | -| `SupportedSizeSevenHundredAndTwentyx1280` | 720x1280 | -| `SupportedSizeSevenHundredAndTwentyx1680` | 720x1680 | -| `SupportedSizeEightHundredAndFiftyFourx480` | 854x480 | -| `SupportedSizeNineHundredAndSixtyx720` | 960x720 | -| `SupportedSizeOneThousandAndEightyx720` | 1080x720 | -| `SupportedSizeOneThousandAndEightyx1080` | 1080x1080 | -| `SupportedSizeOneThousandAndEightyx1440` | 1080x1440 | -| `SupportedSizeOneThousandAndEightyx1620` | 1080x1620 | -| `SupportedSizeOneThousandAndEightyx1920` | 1080x1920 | -| `SupportedSizeOneThousandAndEightyx2520` | 1080x2520 | -| `SupportedSizeOneThousandOneHundredAndTwentyx480` | 1120x480 | -| `SupportedSizeOneThousandTwoHundredAndEightyx720` | 1280x720 | -| `SupportedSizeOneThousandFourHundredAndFortyx1080` | 1440x1080 | -| `SupportedSizeOneThousandSixHundredAndTwentyx1080` | 1620x1080 | -| `SupportedSizeOneThousandSixHundredAndEightyx720` | 1680x720 | -| `SupportedSizeOneThousandNineHundredAndTwentyx1080` | 1920x1080 | -| `SupportedSizeTwoThousandOneHundredAndSixtyx2160` | 2160x2160 | -| `SupportedSizeTwoThousandOneHundredAndSixtyx2880` | 2160x2880 | -| `SupportedSizeTwoThousandOneHundredAndSixtyx3240` | 2160x3240 | -| `SupportedSizeTwoThousandOneHundredAndSixtyx3840` | 2160x3840 | -| `SupportedSizeTwoThousandOneHundredAndSixtyx5040` | 2160x5040 | -| `SupportedSizeTwoThousandFiveHundredAndTwentyx1080` | 2520x1080 | -| `SupportedSizeTwoThousandEightHundredAndEightyx2160` | 2880x2160 | -| `SupportedSizeThreeThousandTwoHundredAndFortyx2160` | 3240x2160 | -| `SupportedSizeThreeThousandEightHundredAndFortyx2160` | 3840x2160 | -| `SupportedSizeFiveThousandAndFortyx2160` | 5040x2160 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/syntax.mdx b/client-sdks/go/api-reference/models/syntax.mdx deleted file mode 100644 index 70b83e73..00000000 --- a/client-sdks/go/api-reference/models/syntax.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Syntax - Go SDK -sidebarTitle: Syntax -description: Syntax type definition -seoTitle: Syntax Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/syntax' -'og:site_name': OpenRouter Documentation -'og:title': Syntax Type | OpenRouter Go SDK -'og:description': >- - Syntax type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Syntax%20-%20Go%20SDK&description=Syntax%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.SyntaxLark - -// Open enum: custom values can be created with a direct type cast -custom := components.Syntax("custom_value") -``` - -## Values - -| Name | Value | -| ------------- | ------------- | -| `SyntaxLark` | lark | -| `SyntaxRegex` | regex | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/system.mdx b/client-sdks/go/api-reference/models/system.mdx deleted file mode 100644 index 209091e6..00000000 --- a/client-sdks/go/api-reference/models/system.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: System - Go SDK -sidebarTitle: System -description: System type definition -seoTitle: System Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/system' -'og:site_name': OpenRouter Documentation -'og:title': System Type | OpenRouter Go SDK -'og:description': >- - System type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=System%20-%20Go%20SDK&description=System%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -system := components.CreateSystemStr(string{/* values here */}) -``` - -### - -```go lines -system := components.CreateSystemArrayOfAnthropicTextBlockParam([]components.AnthropicTextBlockParam{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch system.Type { - case components.SystemTypeStr: - // system.Str is populated - case components.SystemTypeArrayOfAnthropicTextBlockParam: - // system.ArrayOfAnthropicTextBlockParam is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/taskbudget.mdx b/client-sdks/go/api-reference/models/taskbudget.mdx deleted file mode 100644 index 830f0805..00000000 --- a/client-sdks/go/api-reference/models/taskbudget.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TaskBudget - Go SDK -sidebarTitle: TaskBudget -description: TaskBudget type definition -seoTitle: TaskBudget Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/taskbudget' -'og:site_name': OpenRouter Documentation -'og:title': TaskBudget Type | OpenRouter Go SDK -'og:description': >- - TaskBudget type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TaskBudget%20-%20Go%20SDK&description=TaskBudget%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Remaining` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `Total` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTokens](/client-sdks/go/api-reference/models/typetokens) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/textdeltaevent.mdx b/client-sdks/go/api-reference/models/textdeltaevent.mdx deleted file mode 100644 index 8d6ca5c2..00000000 --- a/client-sdks/go/api-reference/models/textdeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TextDeltaEvent - Go SDK -sidebarTitle: TextDeltaEvent -description: TextDeltaEvent type definition -seoTitle: TextDeltaEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/textdeltaevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDeltaEvent Type | OpenRouter Go SDK -'og:description': >- - TextDeltaEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDeltaEvent%20-%20Go%20SDK&description=TextDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when a text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `Delta` | `string` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](/client-sdks/go/api-reference/models/streamlogprob) | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TextDeltaEventType](/client-sdks/go/api-reference/models/textdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/textdeltaeventtype.mdx b/client-sdks/go/api-reference/models/textdeltaeventtype.mdx deleted file mode 100644 index 76b78a73..00000000 --- a/client-sdks/go/api-reference/models/textdeltaeventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TextDeltaEventType - Go SDK -sidebarTitle: TextDeltaEventType -description: TextDeltaEventType type definition -seoTitle: TextDeltaEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/textdeltaeventtype' -'og:site_name': OpenRouter Documentation -'og:title': TextDeltaEventType Type | OpenRouter Go SDK -'og:description': >- - TextDeltaEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDeltaEventType%20-%20Go%20SDK&description=TextDeltaEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TextDeltaEventTypeResponseOutputTextDelta -``` - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `TextDeltaEventTypeResponseOutputTextDelta` | response.output_text.delta | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/textdoneevent.mdx b/client-sdks/go/api-reference/models/textdoneevent.mdx deleted file mode 100644 index 7a1d2bbb..00000000 --- a/client-sdks/go/api-reference/models/textdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TextDoneEvent - Go SDK -sidebarTitle: TextDoneEvent -description: TextDoneEvent type definition -seoTitle: TextDoneEvent Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/textdoneevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDoneEvent Type | OpenRouter Go SDK -'og:description': >- - TextDoneEvent type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDoneEvent%20-%20Go%20SDK&description=TextDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Event emitted when text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `ContentIndex` | `int64` | :heavy_check_mark: | N/A | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/textdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/textdoneeventtype.mdx b/client-sdks/go/api-reference/models/textdoneeventtype.mdx deleted file mode 100644 index 410da326..00000000 --- a/client-sdks/go/api-reference/models/textdoneeventtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TextDoneEventType - Go SDK -sidebarTitle: TextDoneEventType -description: TextDoneEventType type definition -seoTitle: TextDoneEventType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/textdoneeventtype' -'og:site_name': OpenRouter Documentation -'og:title': TextDoneEventType Type | OpenRouter Go SDK -'og:description': >- - TextDoneEventType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDoneEventType%20-%20Go%20SDK&description=TextDoneEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TextDoneEventTypeResponseOutputTextDone -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `TextDoneEventTypeResponseOutputTextDone` | response.output_text.done | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/textextendedconfig.mdx b/client-sdks/go/api-reference/models/textextendedconfig.mdx deleted file mode 100644 index 6927c2cf..00000000 --- a/client-sdks/go/api-reference/models/textextendedconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: TextExtendedConfig - Go SDK -sidebarTitle: TextExtendedConfig -description: TextExtendedConfig type definition -seoTitle: TextExtendedConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/textextendedconfig' -'og:site_name': OpenRouter Documentation -'og:title': TextExtendedConfig Type | OpenRouter Go SDK -'og:description': >- - TextExtendedConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextExtendedConfig%20-%20Go%20SDK&description=TextExtendedConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Format` | [*components.Formats](/client-sdks/go/api-reference/models/formats) | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](/client-sdks/go/api-reference/models/verbosity)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/thinking.mdx b/client-sdks/go/api-reference/models/thinking.mdx deleted file mode 100644 index 81da1a91..00000000 --- a/client-sdks/go/api-reference/models/thinking.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Thinking - Go SDK -sidebarTitle: Thinking -description: Thinking type definition -seoTitle: Thinking Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/thinking' -'og:site_name': OpenRouter Documentation -'og:title': Thinking Type | OpenRouter Go SDK -'og:description': >- - Thinking type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Thinking%20-%20Go%20SDK&description=Thinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ThinkingEnabled - -```go lines -thinking := components.CreateThinkingEnabled(components.ThinkingEnabled{/* values here */}) -``` - -### ThinkingDisabled - -```go lines -thinking := components.CreateThinkingDisabled(components.ThinkingDisabled{/* values here */}) -``` - -### ThinkingAdaptive - -```go lines -thinking := components.CreateThinkingAdaptive(components.ThinkingAdaptive{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch thinking.Type { - case components.ThinkingTypeEnabled: - // thinking.ThinkingEnabled is populated - case components.ThinkingTypeDisabled: - // thinking.ThinkingDisabled is populated - case components.ThinkingTypeAdaptive: - // thinking.ThinkingAdaptive is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/thinkingadaptive.mdx b/client-sdks/go/api-reference/models/thinkingadaptive.mdx deleted file mode 100644 index 4d41e237..00000000 --- a/client-sdks/go/api-reference/models/thinkingadaptive.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ThinkingAdaptive - Go SDK -sidebarTitle: ThinkingAdaptive -description: ThinkingAdaptive type definition -seoTitle: ThinkingAdaptive Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/thinkingadaptive' -'og:site_name': OpenRouter Documentation -'og:title': ThinkingAdaptive Type | OpenRouter Go SDK -'og:description': >- - ThinkingAdaptive type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingAdaptive%20-%20Go%20SDK&description=ThinkingAdaptive%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](/client-sdks/go/api-reference/models/anthropicthinkingdisplay)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeAdaptive](/client-sdks/go/api-reference/models/typeadaptive) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/thinkingdisabled.mdx b/client-sdks/go/api-reference/models/thinkingdisabled.mdx deleted file mode 100644 index fb174b05..00000000 --- a/client-sdks/go/api-reference/models/thinkingdisabled.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ThinkingDisabled - Go SDK -sidebarTitle: ThinkingDisabled -description: ThinkingDisabled type definition -seoTitle: ThinkingDisabled Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/thinkingdisabled' -'og:site_name': OpenRouter Documentation -'og:title': ThinkingDisabled Type | OpenRouter Go SDK -'og:description': >- - ThinkingDisabled type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingDisabled%20-%20Go%20SDK&description=ThinkingDisabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Type` | [components.TypeDisabled](/client-sdks/go/api-reference/models/typedisabled) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/thinkingenabled.mdx b/client-sdks/go/api-reference/models/thinkingenabled.mdx deleted file mode 100644 index ef809fbd..00000000 --- a/client-sdks/go/api-reference/models/thinkingenabled.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ThinkingEnabled - Go SDK -sidebarTitle: ThinkingEnabled -description: ThinkingEnabled type definition -seoTitle: ThinkingEnabled Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/thinkingenabled' -'og:site_name': OpenRouter Documentation -'og:title': ThinkingEnabled Type | OpenRouter Go SDK -'og:description': >- - ThinkingEnabled type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingEnabled%20-%20Go%20SDK&description=ThinkingEnabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `BudgetTokens` | `int64` | :heavy_check_mark: | N/A | | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](/client-sdks/go/api-reference/models/anthropicthinkingdisplay)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeEnabled](/client-sdks/go/api-reference/models/typeenabled) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/tokenizer.mdx b/client-sdks/go/api-reference/models/tokenizer.mdx deleted file mode 100644 index 0e18c175..00000000 --- a/client-sdks/go/api-reference/models/tokenizer.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Tokenizer - Go SDK -sidebarTitle: Tokenizer -description: Tokenizer type definition -seoTitle: Tokenizer Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/tokenizer' -'og:site_name': OpenRouter Documentation -'og:title': Tokenizer Type | OpenRouter Go SDK -'og:description': >- - Tokenizer type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Tokenizer%20-%20Go%20SDK&description=Tokenizer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TokenizerRouter - -// Open enum: custom values can be created with a direct type cast -custom := components.Tokenizer("custom_value") -``` - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `TokenizerRouter` | Router | -| `TokenizerMedia` | Media | -| `TokenizerOther` | Other | -| `TokenizerGpt` | GPT | -| `TokenizerClaude` | Claude | -| `TokenizerGemini` | Gemini | -| `TokenizerGemma` | Gemma | -| `TokenizerGrok` | Grok | -| `TokenizerCohere` | Cohere | -| `TokenizerNova` | Nova | -| `TokenizerQwen` | Qwen | -| `TokenizerYi` | Yi | -| `TokenizerDeepSeek` | DeepSeek | -| `TokenizerMistral` | Mistral | -| `TokenizerLlama2` | Llama2 | -| `TokenizerLlama3` | Llama3 | -| `TokenizerLlama4` | Llama4 | -| `TokenizerPaLm` | PaLM | -| `TokenizerRwkv` | RWKV | -| `TokenizerQwen3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/tooladvisor20260301.mdx b/client-sdks/go/api-reference/models/tooladvisor20260301.mdx deleted file mode 100644 index 9e690605..00000000 --- a/client-sdks/go/api-reference/models/tooladvisor20260301.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ToolAdvisor20260301 - Go SDK -sidebarTitle: ToolAdvisor20260301 -description: ToolAdvisor20260301 type definition -seoTitle: ToolAdvisor20260301 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/tooladvisor20260301' -'og:site_name': OpenRouter Documentation -'og:title': ToolAdvisor20260301 Type | OpenRouter Go SDK -'og:description': >- - ToolAdvisor20260301 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolAdvisor20260301%20-%20Go%20SDK&description=ToolAdvisor20260301%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](/client-sdks/go/api-reference/models/anthropicallowedcallers) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Caching` | optionalnullable.OptionalNullable[[components.Caching](/client-sdks/go/api-reference/models/caching)] | :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](/client-sdks/go/api-reference/models/nameadvisor) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeAdvisor20260301](/client-sdks/go/api-reference/models/typeadvisor20260301) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolbash20250124.mdx b/client-sdks/go/api-reference/models/toolbash20250124.mdx deleted file mode 100644 index 6640858f..00000000 --- a/client-sdks/go/api-reference/models/toolbash20250124.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolBash20250124 - Go SDK -sidebarTitle: ToolBash20250124 -description: ToolBash20250124 type definition -seoTitle: ToolBash20250124 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolbash20250124' -'og:site_name': OpenRouter Documentation -'og:title': ToolBash20250124 Type | OpenRouter Go SDK -'og:description': >- - ToolBash20250124 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolBash20250124%20-%20Go%20SDK&description=ToolBash20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Name` | [components.NameBash](/client-sdks/go/api-reference/models/namebash) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeBash20250124](/client-sdks/go/api-reference/models/typebash20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolcallstatus.mdx b/client-sdks/go/api-reference/models/toolcallstatus.mdx deleted file mode 100644 index 448d22d2..00000000 --- a/client-sdks/go/api-reference/models/toolcallstatus.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ToolCallStatus - Go SDK -sidebarTitle: ToolCallStatus -description: ToolCallStatus type definition -seoTitle: ToolCallStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ToolCallStatus Type | OpenRouter Go SDK -'og:description': >- - ToolCallStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCallStatus%20-%20Go%20SDK&description=ToolCallStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ToolCallStatusInProgress - -// Open enum: custom values can be created with a direct type cast -custom := components.ToolCallStatus("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `ToolCallStatusInProgress` | in_progress | -| `ToolCallStatusCompleted` | completed | -| `ToolCallStatusIncomplete` | incomplete | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoice.mdx b/client-sdks/go/api-reference/models/toolchoice.mdx deleted file mode 100644 index 0e412283..00000000 --- a/client-sdks/go/api-reference/models/toolchoice.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ToolChoice - Go SDK -sidebarTitle: ToolChoice -description: ToolChoice type definition -seoTitle: ToolChoice Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoice Type | OpenRouter Go SDK -'og:description': >- - ToolChoice type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoice%20-%20Go%20SDK&description=ToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ToolChoiceAuto - -```go lines -toolChoice := components.CreateToolChoiceAuto(components.ToolChoiceAuto{/* values here */}) -``` - -### ToolChoiceAny - -```go lines -toolChoice := components.CreateToolChoiceAny(components.ToolChoiceAny{/* values here */}) -``` - -### ToolChoiceNone - -```go lines -toolChoice := components.CreateToolChoiceNone(components.ToolChoiceNone{/* values here */}) -``` - -### ToolChoiceTool - -```go lines -toolChoice := components.CreateToolChoiceTool(components.ToolChoiceTool{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch toolChoice.Type { - case components.ToolChoiceTypeAutoValue: - // toolChoice.ToolChoiceAuto is populated - case components.ToolChoiceTypeAny: - // toolChoice.ToolChoiceAny is populated - case components.ToolChoiceTypeNone: - // toolChoice.ToolChoiceNone is populated - case components.ToolChoiceTypeTool: - // toolChoice.ToolChoiceTool is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoiceallowed.mdx b/client-sdks/go/api-reference/models/toolchoiceallowed.mdx deleted file mode 100644 index fa68f910..00000000 --- a/client-sdks/go/api-reference/models/toolchoiceallowed.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ToolChoiceAllowed - Go SDK -sidebarTitle: ToolChoiceAllowed -description: ToolChoiceAllowed type definition -seoTitle: ToolChoiceAllowed Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoiceallowed' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowed Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceAllowed type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowed%20-%20Go%20SDK&description=ToolChoiceAllowed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Constrains the model to a pre-defined set of allowed tools - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Mode` | [components.Mode](/client-sdks/go/api-reference/models/mode) | :heavy_check_mark: | N/A | -| `Tools` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.ToolChoiceAllowedType](/client-sdks/go/api-reference/models/toolchoiceallowedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoiceallowedtype.mdx b/client-sdks/go/api-reference/models/toolchoiceallowedtype.mdx deleted file mode 100644 index 51984207..00000000 --- a/client-sdks/go/api-reference/models/toolchoiceallowedtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolChoiceAllowedType - Go SDK -sidebarTitle: ToolChoiceAllowedType -description: ToolChoiceAllowedType type definition -seoTitle: ToolChoiceAllowedType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoiceallowedtype' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowedType Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceAllowedType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowedType%20-%20Go%20SDK&description=ToolChoiceAllowedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ToolChoiceAllowedTypeAllowedTools -``` - -## Values - -| Name | Value | -| ----------------------------------- | ----------------------------------- | -| `ToolChoiceAllowedTypeAllowedTools` | allowed_tools | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoiceany.mdx b/client-sdks/go/api-reference/models/toolchoiceany.mdx deleted file mode 100644 index 61d4ae82..00000000 --- a/client-sdks/go/api-reference/models/toolchoiceany.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceAny - Go SDK -sidebarTitle: ToolChoiceAny -description: ToolChoiceAny type definition -seoTitle: ToolChoiceAny Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoiceany' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAny Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceAny type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAny%20-%20Go%20SDK&description=ToolChoiceAny%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeAny](/client-sdks/go/api-reference/models/typeany) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoiceauto.mdx b/client-sdks/go/api-reference/models/toolchoiceauto.mdx deleted file mode 100644 index 62e723e1..00000000 --- a/client-sdks/go/api-reference/models/toolchoiceauto.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceAuto - Go SDK -sidebarTitle: ToolChoiceAuto -description: ToolChoiceAuto type definition -seoTitle: ToolChoiceAuto Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoiceauto' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAuto Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceAuto type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAuto%20-%20Go%20SDK&description=ToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.ToolChoiceTypeAuto](/client-sdks/go/api-reference/models/toolchoicetypeauto) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoicenone.mdx b/client-sdks/go/api-reference/models/toolchoicenone.mdx deleted file mode 100644 index 2bd99e48..00000000 --- a/client-sdks/go/api-reference/models/toolchoicenone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ToolChoiceNone - Go SDK -sidebarTitle: ToolChoiceNone -description: ToolChoiceNone type definition -seoTitle: ToolChoiceNone Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoicenone' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceNone Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceNone type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceNone%20-%20Go%20SDK&description=ToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.TypeNone](/client-sdks/go/api-reference/models/typenone) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoicetool.mdx b/client-sdks/go/api-reference/models/toolchoicetool.mdx deleted file mode 100644 index d81654d8..00000000 --- a/client-sdks/go/api-reference/models/toolchoicetool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolChoiceTool - Go SDK -sidebarTitle: ToolChoiceTool -description: ToolChoiceTool type definition -seoTitle: ToolChoiceTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoicetool' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceTool Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceTool%20-%20Go%20SDK&description=ToolChoiceTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTool](/client-sdks/go/api-reference/models/typetool) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolchoicetypeauto.mdx b/client-sdks/go/api-reference/models/toolchoicetypeauto.mdx deleted file mode 100644 index 35044c36..00000000 --- a/client-sdks/go/api-reference/models/toolchoicetypeauto.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolChoiceTypeAuto - Go SDK -sidebarTitle: ToolChoiceTypeAuto -description: ToolChoiceTypeAuto type definition -seoTitle: ToolChoiceTypeAuto Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolchoicetypeauto' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceTypeAuto Type | OpenRouter Go SDK -'og:description': >- - ToolChoiceTypeAuto type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceTypeAuto%20-%20Go%20SDK&description=ToolChoiceTypeAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ToolChoiceTypeAutoAuto -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `ToolChoiceTypeAutoAuto` | auto | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolcustom.mdx b/client-sdks/go/api-reference/models/toolcustom.mdx deleted file mode 100644 index 1dc0401f..00000000 --- a/client-sdks/go/api-reference/models/toolcustom.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ToolCustom - Go SDK -sidebarTitle: ToolCustom -description: ToolCustom type definition -seoTitle: ToolCustom Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolcustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolCustom Type | OpenRouter Go SDK -'og:description': >- - ToolCustom type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCustom%20-%20Go%20SDK&description=ToolCustom%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Description` | `*string` | :heavy_minus_sign: | N/A | | -| `InputSchema` | [components.InputSchema](/client-sdks/go/api-reference/models/inputschema) | :heavy_check_mark: | N/A | | -| `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [*components.ToolTypeCustom](/client-sdks/go/api-reference/models/tooltypecustom) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/tooltexteditor20250124.mdx b/client-sdks/go/api-reference/models/tooltexteditor20250124.mdx deleted file mode 100644 index 7d55e7df..00000000 --- a/client-sdks/go/api-reference/models/tooltexteditor20250124.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolTextEditor20250124 - Go SDK -sidebarTitle: ToolTextEditor20250124 -description: ToolTextEditor20250124 type definition -seoTitle: ToolTextEditor20250124 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/tooltexteditor20250124' -'og:site_name': OpenRouter Documentation -'og:title': ToolTextEditor20250124 Type | OpenRouter Go SDK -'og:description': >- - ToolTextEditor20250124 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTextEditor20250124%20-%20Go%20SDK&description=ToolTextEditor20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `Name` | [components.NameStrReplaceEditor](/client-sdks/go/api-reference/models/namestrreplaceeditor) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeTextEditor20250124](/client-sdks/go/api-reference/models/typetexteditor20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/tooltypecustom.mdx b/client-sdks/go/api-reference/models/tooltypecustom.mdx deleted file mode 100644 index ebb64393..00000000 --- a/client-sdks/go/api-reference/models/tooltypecustom.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolTypeCustom - Go SDK -sidebarTitle: ToolTypeCustom -description: ToolTypeCustom type definition -seoTitle: ToolTypeCustom Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/tooltypecustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeCustom Type | OpenRouter Go SDK -'og:description': >- - ToolTypeCustom type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeCustom%20-%20Go%20SDK&description=ToolTypeCustom%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ToolTypeCustomCustom -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `ToolTypeCustomCustom` | custom | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/tooltypeephemeral.mdx b/client-sdks/go/api-reference/models/tooltypeephemeral.mdx deleted file mode 100644 index 0e9fd72c..00000000 --- a/client-sdks/go/api-reference/models/tooltypeephemeral.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolTypeEphemeral - Go SDK -sidebarTitle: ToolTypeEphemeral -description: ToolTypeEphemeral type definition -seoTitle: ToolTypeEphemeral Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/tooltypeephemeral' -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeEphemeral Type | OpenRouter Go SDK -'og:description': >- - ToolTypeEphemeral type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeEphemeral%20-%20Go%20SDK&description=ToolTypeEphemeral%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.ToolTypeEphemeralEphemeral -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `ToolTypeEphemeralEphemeral` | ephemeral | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/toolwebsearch20250305.mdx b/client-sdks/go/api-reference/models/toolwebsearch20250305.mdx deleted file mode 100644 index 7698b512..00000000 --- a/client-sdks/go/api-reference/models/toolwebsearch20250305.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ToolWebSearch20250305 - Go SDK -sidebarTitle: ToolWebSearch20250305 -description: ToolWebSearch20250305 type definition -seoTitle: ToolWebSearch20250305 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolwebsearch20250305' -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20250305 Type | OpenRouter Go SDK -'og:description': >- - ToolWebSearch20250305 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20250305%20-%20Go%20SDK&description=ToolWebSearch20250305%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch1](/client-sdks/go/api-reference/models/namewebsearch1) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20250305](/client-sdks/go/api-reference/models/typewebsearch20250305) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/toolwebsearch20260209.mdx b/client-sdks/go/api-reference/models/toolwebsearch20260209.mdx deleted file mode 100644 index 5307c60f..00000000 --- a/client-sdks/go/api-reference/models/toolwebsearch20260209.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ToolWebSearch20260209 - Go SDK -sidebarTitle: ToolWebSearch20260209 -description: ToolWebSearch20260209 type definition -seoTitle: ToolWebSearch20260209 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/toolwebsearch20260209' -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20260209 Type | OpenRouter Go SDK -'og:description': >- - ToolWebSearch20260209 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20260209%20-%20Go%20SDK&description=ToolWebSearch20260209%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `MaxUses` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch2](/client-sdks/go/api-reference/models/namewebsearch2) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20260209](/client-sdks/go/api-reference/models/typewebsearch20260209) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/toomanyrequestsresponseerror.mdx b/client-sdks/go/api-reference/models/toomanyrequestsresponseerror.mdx deleted file mode 100644 index 94d156d8..00000000 --- a/client-sdks/go/api-reference/models/toomanyrequestsresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: TooManyRequestsResponseError - Go SDK -sidebarTitle: TooManyRequestsResponseError -description: TooManyRequestsResponseError type definition -seoTitle: TooManyRequestsResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/toomanyrequestsresponseerror -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseError Type | OpenRouter Go SDK -'og:description': >- - TooManyRequestsResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseError%20-%20Go%20SDK&description=TooManyRequestsResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Too Many Requests - Rate limit exceeded - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.TooManyRequestsResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/toomanyrequestsresponseerrordata.mdx b/client-sdks/go/api-reference/models/toomanyrequestsresponseerrordata.mdx deleted file mode 100644 index 9d423afa..00000000 --- a/client-sdks/go/api-reference/models/toomanyrequestsresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: TooManyRequestsResponseErrorData - Go SDK -sidebarTitle: TooManyRequestsResponseErrorData -description: TooManyRequestsResponseErrorData type definition -seoTitle: TooManyRequestsResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/toomanyrequestsresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - TooManyRequestsResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseErrorData%20-%20Go%20SDK&description=TooManyRequestsResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for TooManyRequestsResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/topproviderinfo.mdx b/client-sdks/go/api-reference/models/topproviderinfo.mdx deleted file mode 100644 index cb94fb4b..00000000 --- a/client-sdks/go/api-reference/models/topproviderinfo.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TopProviderInfo - Go SDK -sidebarTitle: TopProviderInfo -description: TopProviderInfo type definition -seoTitle: TopProviderInfo Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/topproviderinfo' -'og:site_name': OpenRouter Documentation -'og:title': TopProviderInfo Type | OpenRouter Go SDK -'og:description': >- - TopProviderInfo type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TopProviderInfo%20-%20Go%20SDK&description=TopProviderInfo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Information about the top provider for this model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `ContextLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `IsModerated` | `bool` | :heavy_check_mark: | Whether the top provider moderates content | true | -| `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum completion tokens from the top provider | 4096 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/traceconfig.mdx b/client-sdks/go/api-reference/models/traceconfig.mdx deleted file mode 100644 index 27b59b5b..00000000 --- a/client-sdks/go/api-reference/models/traceconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: TraceConfig - Go SDK -sidebarTitle: TraceConfig -description: TraceConfig type definition -seoTitle: TraceConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/traceconfig' -'og:site_name': OpenRouter Documentation -'og:title': TraceConfig Type | OpenRouter Go SDK -'og:description': >- - TraceConfig type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TraceConfig%20-%20Go%20SDK&description=TraceConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `GenerationName` | `*string` | :heavy_minus_sign: | N/A | | -| `ParentSpanID` | `*string` | :heavy_minus_sign: | N/A | | -| `SpanName` | `*string` | :heavy_minus_sign: | N/A | | -| `TraceID` | `*string` | :heavy_minus_sign: | N/A | | -| `TraceName` | `*string` | :heavy_minus_sign: | N/A | | -| `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | `{"trace_id": "trace-abc123","trace_name": "my-app-trace"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/trigger.mdx b/client-sdks/go/api-reference/models/trigger.mdx deleted file mode 100644 index 4b608f30..00000000 --- a/client-sdks/go/api-reference/models/trigger.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Trigger - Go SDK -sidebarTitle: Trigger -description: Trigger type definition -seoTitle: Trigger Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/trigger' -'og:site_name': OpenRouter Documentation -'og:title': Trigger Type | OpenRouter Go SDK -'og:description': >- - Trigger type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Trigger%20-%20Go%20SDK&description=Trigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### AnthropicInputTokensTrigger - -```go lines -trigger := components.CreateTriggerInputTokens(components.AnthropicInputTokensTrigger{/* values here */}) -``` - -### AnthropicToolUsesTrigger - -```go lines -trigger := components.CreateTriggerToolUses(components.AnthropicToolUsesTrigger{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch trigger.Type { - case components.TriggerTypeInputTokens: - // trigger.AnthropicInputTokensTrigger is populated - case components.TriggerTypeToolUses: - // trigger.AnthropicToolUsesTrigger is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/triggerinputtokens.mdx b/client-sdks/go/api-reference/models/triggerinputtokens.mdx deleted file mode 100644 index 4cc39055..00000000 --- a/client-sdks/go/api-reference/models/triggerinputtokens.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TriggerInputTokens - Go SDK -sidebarTitle: TriggerInputTokens -description: TriggerInputTokens type definition -seoTitle: TriggerInputTokens Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/triggerinputtokens' -'og:site_name': OpenRouter Documentation -'og:title': TriggerInputTokens Type | OpenRouter Go SDK -'og:description': >- - TriggerInputTokens type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TriggerInputTokens%20-%20Go%20SDK&description=TriggerInputTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.EditTypeInputTokens](/client-sdks/go/api-reference/models/edittypeinputtokens) | :heavy_check_mark: | N/A | -| `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/truncation.mdx b/client-sdks/go/api-reference/models/truncation.mdx deleted file mode 100644 index e6b2c2f1..00000000 --- a/client-sdks/go/api-reference/models/truncation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Truncation - Go SDK -sidebarTitle: Truncation -description: Truncation type definition -seoTitle: Truncation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/truncation' -'og:site_name': OpenRouter Documentation -'og:title': Truncation Type | OpenRouter Go SDK -'og:description': >- - Truncation type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Truncation%20-%20Go%20SDK&description=Truncation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TruncationAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.Truncation("custom_value") -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `TruncationAuto` | auto | -| `TruncationDisabled` | disabled | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/type.mdx b/client-sdks/go/api-reference/models/type.mdx deleted file mode 100644 index 813b8fef..00000000 --- a/client-sdks/go/api-reference/models/type.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Type - Go SDK -sidebarTitle: Type -description: Type type definition -seoTitle: Type Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/type' -'og:site_name': OpenRouter Documentation -'og:title': Type Type | OpenRouter Go SDK -'og:description': >- - Type type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Type%20-%20Go%20SDK&description=Type%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - -```go lines -type := components.CreateTypeOpenAIResponsesToolChoiceTypeWebSearchPreview20250311(components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311{/* values here */}) -``` - -### OpenAIResponsesToolChoiceTypeWebSearchPreview - -```go lines -type := components.CreateTypeOpenAIResponsesToolChoiceTypeWebSearchPreview(components.OpenAIResponsesToolChoiceTypeWebSearchPreview{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch type.Type { - case components.TypeTypeOpenAIResponsesToolChoiceTypeWebSearchPreview20250311: - // type.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 is populated - case components.TypeTypeOpenAIResponsesToolChoiceTypeWebSearchPreview: - // type.OpenAIResponsesToolChoiceTypeWebSearchPreview is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeadaptive.mdx b/client-sdks/go/api-reference/models/typeadaptive.mdx deleted file mode 100644 index 5425b169..00000000 --- a/client-sdks/go/api-reference/models/typeadaptive.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeAdaptive - Go SDK -sidebarTitle: TypeAdaptive -description: TypeAdaptive type definition -seoTitle: TypeAdaptive Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeadaptive' -'og:site_name': OpenRouter Documentation -'og:title': TypeAdaptive Type | OpenRouter Go SDK -'og:description': >- - TypeAdaptive type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAdaptive%20-%20Go%20SDK&description=TypeAdaptive%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeAdaptiveAdaptive -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeAdaptiveAdaptive` | adaptive | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeadvisor20260301.mdx b/client-sdks/go/api-reference/models/typeadvisor20260301.mdx deleted file mode 100644 index 345a8f26..00000000 --- a/client-sdks/go/api-reference/models/typeadvisor20260301.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeAdvisor20260301 - Go SDK -sidebarTitle: TypeAdvisor20260301 -description: TypeAdvisor20260301 type definition -seoTitle: TypeAdvisor20260301 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeadvisor20260301' -'og:site_name': OpenRouter Documentation -'og:title': TypeAdvisor20260301 Type | OpenRouter Go SDK -'og:description': >- - TypeAdvisor20260301 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAdvisor20260301%20-%20Go%20SDK&description=TypeAdvisor20260301%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeAdvisor20260301Advisor20260301 -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `TypeAdvisor20260301Advisor20260301` | advisor_20260301 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeany.mdx b/client-sdks/go/api-reference/models/typeany.mdx deleted file mode 100644 index 1bb20c86..00000000 --- a/client-sdks/go/api-reference/models/typeany.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeAny - Go SDK -sidebarTitle: TypeAny -description: TypeAny type definition -seoTitle: TypeAny Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeany' -'og:site_name': OpenRouter Documentation -'og:title': TypeAny Type | OpenRouter Go SDK -'og:description': >- - TypeAny type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAny%20-%20Go%20SDK&description=TypeAny%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeAnyAny -``` - -## Values - -| Name | Value | -| ------------ | ------------ | -| `TypeAnyAny` | any | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typebash20250124.mdx b/client-sdks/go/api-reference/models/typebash20250124.mdx deleted file mode 100644 index 7e100920..00000000 --- a/client-sdks/go/api-reference/models/typebash20250124.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeBash20250124 - Go SDK -sidebarTitle: TypeBash20250124 -description: TypeBash20250124 type definition -seoTitle: TypeBash20250124 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typebash20250124' -'og:site_name': OpenRouter Documentation -'og:title': TypeBash20250124 Type | OpenRouter Go SDK -'og:description': >- - TypeBash20250124 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeBash20250124%20-%20Go%20SDK&description=TypeBash20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeBash20250124Bash20250124 -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `TypeBash20250124Bash20250124` | bash_20250124 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeclearthinking20251015.mdx b/client-sdks/go/api-reference/models/typeclearthinking20251015.mdx deleted file mode 100644 index 7607ab6a..00000000 --- a/client-sdks/go/api-reference/models/typeclearthinking20251015.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TypeClearThinking20251015 - Go SDK -sidebarTitle: TypeClearThinking20251015 -description: TypeClearThinking20251015 type definition -seoTitle: TypeClearThinking20251015 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/typeclearthinking20251015 -'og:site_name': OpenRouter Documentation -'og:title': TypeClearThinking20251015 Type | OpenRouter Go SDK -'og:description': >- - TypeClearThinking20251015 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeClearThinking20251015%20-%20Go%20SDK&description=TypeClearThinking20251015%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeClearThinking20251015ClearThinking20251015 -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `TypeClearThinking20251015ClearThinking20251015` | clear_thinking_20251015 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typecleartooluses20250919.mdx b/client-sdks/go/api-reference/models/typecleartooluses20250919.mdx deleted file mode 100644 index e4c53bec..00000000 --- a/client-sdks/go/api-reference/models/typecleartooluses20250919.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TypeClearToolUses20250919 - Go SDK -sidebarTitle: TypeClearToolUses20250919 -description: TypeClearToolUses20250919 type definition -seoTitle: TypeClearToolUses20250919 Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/typecleartooluses20250919 -'og:site_name': OpenRouter Documentation -'og:title': TypeClearToolUses20250919 Type | OpenRouter Go SDK -'og:description': >- - TypeClearToolUses20250919 type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeClearToolUses20250919%20-%20Go%20SDK&description=TypeClearToolUses20250919%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeClearToolUses20250919ClearToolUses20250919 -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `TypeClearToolUses20250919ClearToolUses20250919` | clear_tool_uses_20250919 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typecodeinterpreter.mdx b/client-sdks/go/api-reference/models/typecodeinterpreter.mdx deleted file mode 100644 index 2a54bf6f..00000000 --- a/client-sdks/go/api-reference/models/typecodeinterpreter.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeCodeInterpreter - Go SDK -sidebarTitle: TypeCodeInterpreter -description: TypeCodeInterpreter type definition -seoTitle: TypeCodeInterpreter Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typecodeinterpreter' -'og:site_name': OpenRouter Documentation -'og:title': TypeCodeInterpreter Type | OpenRouter Go SDK -'og:description': >- - TypeCodeInterpreter type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCodeInterpreter%20-%20Go%20SDK&description=TypeCodeInterpreter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeCodeInterpreterCodeInterpreter -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `TypeCodeInterpreterCodeInterpreter` | code_interpreter | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typecodeinterpretercall.mdx b/client-sdks/go/api-reference/models/typecodeinterpretercall.mdx deleted file mode 100644 index 6f143181..00000000 --- a/client-sdks/go/api-reference/models/typecodeinterpretercall.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TypeCodeInterpreterCall - Go SDK -sidebarTitle: TypeCodeInterpreterCall -description: TypeCodeInterpreterCall type definition -seoTitle: TypeCodeInterpreterCall Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/typecodeinterpretercall -'og:site_name': OpenRouter Documentation -'og:title': TypeCodeInterpreterCall Type | OpenRouter Go SDK -'og:description': >- - TypeCodeInterpreterCall type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCodeInterpreterCall%20-%20Go%20SDK&description=TypeCodeInterpreterCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeCodeInterpreterCallCodeInterpreterCall -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `TypeCodeInterpreterCallCodeInterpreterCall` | code_interpreter_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typecompact20260112.mdx b/client-sdks/go/api-reference/models/typecompact20260112.mdx deleted file mode 100644 index 6fc1798e..00000000 --- a/client-sdks/go/api-reference/models/typecompact20260112.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeCompact20260112 - Go SDK -sidebarTitle: TypeCompact20260112 -description: TypeCompact20260112 type definition -seoTitle: TypeCompact20260112 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typecompact20260112' -'og:site_name': OpenRouter Documentation -'og:title': TypeCompact20260112 Type | OpenRouter Go SDK -'og:description': >- - TypeCompact20260112 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCompact20260112%20-%20Go%20SDK&description=TypeCompact20260112%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeCompact20260112Compact20260112 -``` - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `TypeCompact20260112Compact20260112` | compact_20260112 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typedisabled.mdx b/client-sdks/go/api-reference/models/typedisabled.mdx deleted file mode 100644 index ae2f5931..00000000 --- a/client-sdks/go/api-reference/models/typedisabled.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeDisabled - Go SDK -sidebarTitle: TypeDisabled -description: TypeDisabled type definition -seoTitle: TypeDisabled Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typedisabled' -'og:site_name': OpenRouter Documentation -'og:title': TypeDisabled Type | OpenRouter Go SDK -'og:description': >- - TypeDisabled type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeDisabled%20-%20Go%20SDK&description=TypeDisabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeDisabledDisabled -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeDisabledDisabled` | disabled | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typedocument.mdx b/client-sdks/go/api-reference/models/typedocument.mdx deleted file mode 100644 index 94c1a73a..00000000 --- a/client-sdks/go/api-reference/models/typedocument.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeDocument - Go SDK -sidebarTitle: TypeDocument -description: TypeDocument type definition -seoTitle: TypeDocument Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typedocument' -'og:site_name': OpenRouter Documentation -'og:title': TypeDocument Type | OpenRouter Go SDK -'og:description': >- - TypeDocument type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeDocument%20-%20Go%20SDK&description=TypeDocument%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeDocumentDocument -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeDocumentDocument` | document | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeenabled.mdx b/client-sdks/go/api-reference/models/typeenabled.mdx deleted file mode 100644 index 927300b7..00000000 --- a/client-sdks/go/api-reference/models/typeenabled.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeEnabled - Go SDK -sidebarTitle: TypeEnabled -description: TypeEnabled type definition -seoTitle: TypeEnabled Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeenabled' -'og:site_name': OpenRouter Documentation -'og:title': TypeEnabled Type | OpenRouter Go SDK -'og:description': >- - TypeEnabled type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeEnabled%20-%20Go%20SDK&description=TypeEnabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeEnabledEnabled -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `TypeEnabledEnabled` | enabled | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeexec.mdx b/client-sdks/go/api-reference/models/typeexec.mdx deleted file mode 100644 index 3c322c04..00000000 --- a/client-sdks/go/api-reference/models/typeexec.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeExec - Go SDK -sidebarTitle: TypeExec -description: TypeExec type definition -seoTitle: TypeExec Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeexec' -'og:site_name': OpenRouter Documentation -'og:title': TypeExec Type | OpenRouter Go SDK -'og:description': >- - TypeExec type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeExec%20-%20Go%20SDK&description=TypeExec%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeExecExec -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `TypeExecExec` | exec | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typefilesearch.mdx b/client-sdks/go/api-reference/models/typefilesearch.mdx deleted file mode 100644 index a97f3491..00000000 --- a/client-sdks/go/api-reference/models/typefilesearch.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeFileSearch - Go SDK -sidebarTitle: TypeFileSearch -description: TypeFileSearch type definition -seoTitle: TypeFileSearch Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typefilesearch' -'og:site_name': OpenRouter Documentation -'og:title': TypeFileSearch Type | OpenRouter Go SDK -'og:description': >- - TypeFileSearch type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeFileSearch%20-%20Go%20SDK&description=TypeFileSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeFileSearchFileSearch -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `TypeFileSearchFileSearch` | file_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typefindinpage.mdx b/client-sdks/go/api-reference/models/typefindinpage.mdx deleted file mode 100644 index fcad9061..00000000 --- a/client-sdks/go/api-reference/models/typefindinpage.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeFindInPage - Go SDK -sidebarTitle: TypeFindInPage -description: TypeFindInPage type definition -seoTitle: TypeFindInPage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typefindinpage' -'og:site_name': OpenRouter Documentation -'og:title': TypeFindInPage Type | OpenRouter Go SDK -'og:description': >- - TypeFindInPage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeFindInPage%20-%20Go%20SDK&description=TypeFindInPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeFindInPageFindInPage -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `TypeFindInPageFindInPage` | find_in_page | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typelocalshellcall.mdx b/client-sdks/go/api-reference/models/typelocalshellcall.mdx deleted file mode 100644 index 2bb966bd..00000000 --- a/client-sdks/go/api-reference/models/typelocalshellcall.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeLocalShellCall - Go SDK -sidebarTitle: TypeLocalShellCall -description: TypeLocalShellCall type definition -seoTitle: TypeLocalShellCall Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typelocalshellcall' -'og:site_name': OpenRouter Documentation -'og:title': TypeLocalShellCall Type | OpenRouter Go SDK -'og:description': >- - TypeLocalShellCall type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeLocalShellCall%20-%20Go%20SDK&description=TypeLocalShellCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeLocalShellCallLocalShellCall -``` - -## Values - -| Name | Value | -| ---------------------------------- | ---------------------------------- | -| `TypeLocalShellCallLocalShellCall` | local_shell_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typelogs.mdx b/client-sdks/go/api-reference/models/typelogs.mdx deleted file mode 100644 index ad3a3b6a..00000000 --- a/client-sdks/go/api-reference/models/typelogs.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeLogs - Go SDK -sidebarTitle: TypeLogs -description: TypeLogs type definition -seoTitle: TypeLogs Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typelogs' -'og:site_name': OpenRouter Documentation -'og:title': TypeLogs Type | OpenRouter Go SDK -'og:description': >- - TypeLogs type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeLogs%20-%20Go%20SDK&description=TypeLogs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeLogsLogs -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `TypeLogsLogs` | logs | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typenone.mdx b/client-sdks/go/api-reference/models/typenone.mdx deleted file mode 100644 index f3bbaf3e..00000000 --- a/client-sdks/go/api-reference/models/typenone.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeNone - Go SDK -sidebarTitle: TypeNone -description: TypeNone type definition -seoTitle: TypeNone Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typenone' -'og:site_name': OpenRouter Documentation -'og:title': TypeNone Type | OpenRouter Go SDK -'og:description': >- - TypeNone type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeNone%20-%20Go%20SDK&description=TypeNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeNoneNone -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `TypeNoneNone` | none | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeopenpage.mdx b/client-sdks/go/api-reference/models/typeopenpage.mdx deleted file mode 100644 index 04111f39..00000000 --- a/client-sdks/go/api-reference/models/typeopenpage.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeOpenPage - Go SDK -sidebarTitle: TypeOpenPage -description: TypeOpenPage type definition -seoTitle: TypeOpenPage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeopenpage' -'og:site_name': OpenRouter Documentation -'og:title': TypeOpenPage Type | OpenRouter Go SDK -'og:description': >- - TypeOpenPage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeOpenPage%20-%20Go%20SDK&description=TypeOpenPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeOpenPageOpenPage -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeOpenPageOpenPage` | open_page | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeredactedthinking.mdx b/client-sdks/go/api-reference/models/typeredactedthinking.mdx deleted file mode 100644 index 30070974..00000000 --- a/client-sdks/go/api-reference/models/typeredactedthinking.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeRedactedThinking - Go SDK -sidebarTitle: TypeRedactedThinking -description: TypeRedactedThinking type definition -seoTitle: TypeRedactedThinking Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeredactedthinking' -'og:site_name': OpenRouter Documentation -'og:title': TypeRedactedThinking Type | OpenRouter Go SDK -'og:description': >- - TypeRedactedThinking type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeRedactedThinking%20-%20Go%20SDK&description=TypeRedactedThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeRedactedThinkingRedactedThinking -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `TypeRedactedThinkingRedactedThinking` | redacted_thinking | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typeservertooluse.mdx b/client-sdks/go/api-reference/models/typeservertooluse.mdx deleted file mode 100644 index 59d2c6cf..00000000 --- a/client-sdks/go/api-reference/models/typeservertooluse.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeServerToolUse - Go SDK -sidebarTitle: TypeServerToolUse -description: TypeServerToolUse type definition -seoTitle: TypeServerToolUse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typeservertooluse' -'og:site_name': OpenRouter Documentation -'og:title': TypeServerToolUse Type | OpenRouter Go SDK -'og:description': >- - TypeServerToolUse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeServerToolUse%20-%20Go%20SDK&description=TypeServerToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeServerToolUseServerToolUse -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `TypeServerToolUseServerToolUse` | server_tool_use | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetexteditor20250124.mdx b/client-sdks/go/api-reference/models/typetexteditor20250124.mdx deleted file mode 100644 index ae052b25..00000000 --- a/client-sdks/go/api-reference/models/typetexteditor20250124.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeTextEditor20250124 - Go SDK -sidebarTitle: TypeTextEditor20250124 -description: TypeTextEditor20250124 type definition -seoTitle: TypeTextEditor20250124 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetexteditor20250124' -'og:site_name': OpenRouter Documentation -'og:title': TypeTextEditor20250124 Type | OpenRouter Go SDK -'og:description': >- - TypeTextEditor20250124 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTextEditor20250124%20-%20Go%20SDK&description=TypeTextEditor20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeTextEditor20250124TextEditor20250124 -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `TypeTextEditor20250124TextEditor20250124` | text_editor_20250124 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typethinking.mdx b/client-sdks/go/api-reference/models/typethinking.mdx deleted file mode 100644 index 15f528da..00000000 --- a/client-sdks/go/api-reference/models/typethinking.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeThinking - Go SDK -sidebarTitle: TypeThinking -description: TypeThinking type definition -seoTitle: TypeThinking Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typethinking' -'og:site_name': OpenRouter Documentation -'og:title': TypeThinking Type | OpenRouter Go SDK -'og:description': >- - TypeThinking type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeThinking%20-%20Go%20SDK&description=TypeThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeThinkingThinking -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeThinkingThinking` | thinking | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetokens.mdx b/client-sdks/go/api-reference/models/typetokens.mdx deleted file mode 100644 index a9597860..00000000 --- a/client-sdks/go/api-reference/models/typetokens.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeTokens - Go SDK -sidebarTitle: TypeTokens -description: TypeTokens type definition -seoTitle: TypeTokens Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetokens' -'og:site_name': OpenRouter Documentation -'og:title': TypeTokens Type | OpenRouter Go SDK -'og:description': >- - TypeTokens type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTokens%20-%20Go%20SDK&description=TypeTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeTokensTokens -``` - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `TypeTokensTokens` | tokens | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetool.mdx b/client-sdks/go/api-reference/models/typetool.mdx deleted file mode 100644 index 9b5e5950..00000000 --- a/client-sdks/go/api-reference/models/typetool.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeTool - Go SDK -sidebarTitle: TypeTool -description: TypeTool type definition -seoTitle: TypeTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetool' -'og:site_name': OpenRouter Documentation -'og:title': TypeTool Type | OpenRouter Go SDK -'og:description': >- - TypeTool type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTool%20-%20Go%20SDK&description=TypeTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeToolTool -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `TypeToolTool` | tool | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetoolreference.mdx b/client-sdks/go/api-reference/models/typetoolreference.mdx deleted file mode 100644 index d4a7a5d6..00000000 --- a/client-sdks/go/api-reference/models/typetoolreference.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeToolReference - Go SDK -sidebarTitle: TypeToolReference -description: TypeToolReference type definition -seoTitle: TypeToolReference Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetoolreference' -'og:site_name': OpenRouter Documentation -'og:title': TypeToolReference Type | OpenRouter Go SDK -'og:description': >- - TypeToolReference type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolReference%20-%20Go%20SDK&description=TypeToolReference%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeToolReferenceToolReference -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `TypeToolReferenceToolReference` | tool_reference | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetoolresult.mdx b/client-sdks/go/api-reference/models/typetoolresult.mdx deleted file mode 100644 index c183be6e..00000000 --- a/client-sdks/go/api-reference/models/typetoolresult.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeToolResult - Go SDK -sidebarTitle: TypeToolResult -description: TypeToolResult type definition -seoTitle: TypeToolResult Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetoolresult' -'og:site_name': OpenRouter Documentation -'og:title': TypeToolResult Type | OpenRouter Go SDK -'og:description': >- - TypeToolResult type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolResult%20-%20Go%20SDK&description=TypeToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeToolResultToolResult -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `TypeToolResultToolResult` | tool_result | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typetooluse.mdx b/client-sdks/go/api-reference/models/typetooluse.mdx deleted file mode 100644 index 87743733..00000000 --- a/client-sdks/go/api-reference/models/typetooluse.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeToolUse - Go SDK -sidebarTitle: TypeToolUse -description: TypeToolUse type definition -seoTitle: TypeToolUse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typetooluse' -'og:site_name': OpenRouter Documentation -'og:title': TypeToolUse Type | OpenRouter Go SDK -'og:description': >- - TypeToolUse type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolUse%20-%20Go%20SDK&description=TypeToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeToolUseToolUse -``` - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `TypeToolUseToolUse` | tool_use | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typewebsearch20250305.mdx b/client-sdks/go/api-reference/models/typewebsearch20250305.mdx deleted file mode 100644 index c9856a31..00000000 --- a/client-sdks/go/api-reference/models/typewebsearch20250305.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeWebSearch20250305 - Go SDK -sidebarTitle: TypeWebSearch20250305 -description: TypeWebSearch20250305 type definition -seoTitle: TypeWebSearch20250305 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typewebsearch20250305' -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20250305 Type | OpenRouter Go SDK -'og:description': >- - TypeWebSearch20250305 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20250305%20-%20Go%20SDK&description=TypeWebSearch20250305%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeWebSearch20250305WebSearch20250305 -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `TypeWebSearch20250305WebSearch20250305` | web_search_20250305 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typewebsearch20260209.mdx b/client-sdks/go/api-reference/models/typewebsearch20260209.mdx deleted file mode 100644 index 1cbf32ad..00000000 --- a/client-sdks/go/api-reference/models/typewebsearch20260209.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeWebSearch20260209 - Go SDK -sidebarTitle: TypeWebSearch20260209 -description: TypeWebSearch20260209 type definition -seoTitle: TypeWebSearch20260209 Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typewebsearch20260209' -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20260209 Type | OpenRouter Go SDK -'og:description': >- - TypeWebSearch20260209 type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20260209%20-%20Go%20SDK&description=TypeWebSearch20260209%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeWebSearch20260209WebSearch20260209 -``` - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `TypeWebSearch20260209WebSearch20260209` | web_search_20260209 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typewebsearchcall.mdx b/client-sdks/go/api-reference/models/typewebsearchcall.mdx deleted file mode 100644 index d5127dee..00000000 --- a/client-sdks/go/api-reference/models/typewebsearchcall.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeWebSearchCall - Go SDK -sidebarTitle: TypeWebSearchCall -description: TypeWebSearchCall type definition -seoTitle: TypeWebSearchCall Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/typewebsearchcall' -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchCall Type | OpenRouter Go SDK -'og:description': >- - TypeWebSearchCall type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchCall%20-%20Go%20SDK&description=TypeWebSearchCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeWebSearchCallWebSearchCall -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `TypeWebSearchCallWebSearchCall` | web_search_call | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typewebsearchtoolresult.mdx b/client-sdks/go/api-reference/models/typewebsearchtoolresult.mdx deleted file mode 100644 index 725fdfad..00000000 --- a/client-sdks/go/api-reference/models/typewebsearchtoolresult.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TypeWebSearchToolResult - Go SDK -sidebarTitle: TypeWebSearchToolResult -description: TypeWebSearchToolResult type definition -seoTitle: TypeWebSearchToolResult Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/typewebsearchtoolresult -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchToolResult Type | OpenRouter Go SDK -'og:description': >- - TypeWebSearchToolResult type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchToolResult%20-%20Go%20SDK&description=TypeWebSearchToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeWebSearchToolResultWebSearchToolResult -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `TypeWebSearchToolResultWebSearchToolResult` | web_search_tool_result | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/typewebsearchtoolresulterror.mdx b/client-sdks/go/api-reference/models/typewebsearchtoolresulterror.mdx deleted file mode 100644 index 2f9668e0..00000000 --- a/client-sdks/go/api-reference/models/typewebsearchtoolresulterror.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: TypeWebSearchToolResultError - Go SDK -sidebarTitle: TypeWebSearchToolResultError -description: TypeWebSearchToolResultError type definition -seoTitle: TypeWebSearchToolResultError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/typewebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchToolResultError Type | OpenRouter Go SDK -'og:description': >- - TypeWebSearchToolResultError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchToolResultError%20-%20Go%20SDK&description=TypeWebSearchToolResultError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.TypeWebSearchToolResultErrorWebSearchToolResultError -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `TypeWebSearchToolResultErrorWebSearchToolResultError` | web_search_tool_result_error | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/unauthorizedresponseerror.mdx b/client-sdks/go/api-reference/models/unauthorizedresponseerror.mdx deleted file mode 100644 index 0c121884..00000000 --- a/client-sdks/go/api-reference/models/unauthorizedresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnauthorizedResponseError - Go SDK -sidebarTitle: UnauthorizedResponseError -description: UnauthorizedResponseError type definition -seoTitle: UnauthorizedResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/unauthorizedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseError Type | OpenRouter Go SDK -'og:description': >- - UnauthorizedResponseError type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseError%20-%20Go%20SDK&description=UnauthorizedResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Unauthorized - Authentication required or invalid credentials - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.UnauthorizedResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/unauthorizedresponseerrordata.mdx b/client-sdks/go/api-reference/models/unauthorizedresponseerrordata.mdx deleted file mode 100644 index 84d28322..00000000 --- a/client-sdks/go/api-reference/models/unauthorizedresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnauthorizedResponseErrorData - Go SDK -sidebarTitle: UnauthorizedResponseErrorData -description: UnauthorizedResponseErrorData type definition -seoTitle: UnauthorizedResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/unauthorizedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - UnauthorizedResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseErrorData%20-%20Go%20SDK&description=UnauthorizedResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for UnauthorizedResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/uniqueinsight.mdx b/client-sdks/go/api-reference/models/uniqueinsight.mdx deleted file mode 100644 index 60943d78..00000000 --- a/client-sdks/go/api-reference/models/uniqueinsight.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UniqueInsight - Go SDK -sidebarTitle: UniqueInsight -description: UniqueInsight type definition -seoTitle: UniqueInsight Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/uniqueinsight' -'og:site_name': OpenRouter Documentation -'og:title': UniqueInsight Type | OpenRouter Go SDK -'og:description': >- - UniqueInsight type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UniqueInsight%20-%20Go%20SDK&description=UniqueInsight%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Insight` | `string` | :heavy_check_mark: | N/A | -| `Model` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/unprocessableentityresponseerror.mdx b/client-sdks/go/api-reference/models/unprocessableentityresponseerror.mdx deleted file mode 100644 index 32803da5..00000000 --- a/client-sdks/go/api-reference/models/unprocessableentityresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnprocessableEntityResponseError - Go SDK -sidebarTitle: UnprocessableEntityResponseError -description: UnprocessableEntityResponseError type definition -seoTitle: UnprocessableEntityResponseError Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/unprocessableentityresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseError Type | OpenRouter Go SDK -'og:description': >- - UnprocessableEntityResponseError type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseError%20-%20Go%20SDK&description=UnprocessableEntityResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Unprocessable Entity - Semantic validation failure - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Error` | [components.UnprocessableEntityResponseErrorData](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/unprocessableentityresponseerrordata.mdx b/client-sdks/go/api-reference/models/unprocessableentityresponseerrordata.mdx deleted file mode 100644 index 7cea3bef..00000000 --- a/client-sdks/go/api-reference/models/unprocessableentityresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnprocessableEntityResponseErrorData - Go SDK -sidebarTitle: UnprocessableEntityResponseErrorData -description: UnprocessableEntityResponseErrorData type definition -seoTitle: UnprocessableEntityResponseErrorData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/unprocessableentityresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseErrorData Type | OpenRouter Go SDK -'og:description': >- - UnprocessableEntityResponseErrorData type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseErrorData%20-%20Go%20SDK&description=UnprocessableEntityResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Error data for UnprocessableEntityResponse - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `Code` | `int64` | :heavy_check_mark: | N/A | -| `Message` | `string` | :heavy_check_mark: | N/A | -| `Metadata` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/updatebyokkeyrequest.mdx b/client-sdks/go/api-reference/models/updatebyokkeyrequest.mdx deleted file mode 100644 index 53cf2804..00000000 --- a/client-sdks/go/api-reference/models/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - Go SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest type definition -seoTitle: UpdateBYOKKeyRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/updatebyokkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateBYOKKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20Go%20SDK&description=UpdateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `AllowedUserIds` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `Disabled` | `*bool` | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `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_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `Name` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/updatebyokkeyresponse.mdx b/client-sdks/go/api-reference/models/updatebyokkeyresponse.mdx deleted file mode 100644 index f3c7c944..00000000 --- a/client-sdks/go/api-reference/models/updatebyokkeyresponse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: UpdateBYOKKeyResponse - Go SDK -sidebarTitle: UpdateBYOKKeyResponse -description: UpdateBYOKKeyResponse type definition -seoTitle: UpdateBYOKKeyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/updatebyokkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyResponse Type | OpenRouter Go SDK -'og:description': >- - UpdateBYOKKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyResponse%20-%20Go%20SDK&description=UpdateBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/updateguardrailrequest.mdx b/client-sdks/go/api-reference/models/updateguardrailrequest.mdx deleted file mode 100644 index 7427a202..00000000 --- a/client-sdks/go/api-reference/models/updateguardrailrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UpdateGuardrailRequest - Go SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest type definition -seoTitle: UpdateGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/updateguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateGuardrailRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20Go%20SDK&description=UpdateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `ContentFilters` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](/client-sdks/go/api-reference/models/contentfilterentry)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | `` | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the guardrail | Updated description | -| ~~`EnforceZdr`~~ | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `EnforceZdrAnthropic` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrGoogle` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOpenai` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `EnforceZdrOther` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | true | -| `IgnoredModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `IgnoredProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `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](/client-sdks/go/api-reference/models/guardrailinterval)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/updateguardrailresponse.mdx b/client-sdks/go/api-reference/models/updateguardrailresponse.mdx deleted file mode 100644 index aad68446..00000000 --- a/client-sdks/go/api-reference/models/updateguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateGuardrailResponse - Go SDK -sidebarTitle: UpdateGuardrailResponse -description: UpdateGuardrailResponse type definition -seoTitle: UpdateGuardrailResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/updateguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResponse Type | OpenRouter Go SDK -'og:description': >- - UpdateGuardrailResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResponse%20-%20Go%20SDK&description=UpdateGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](/client-sdks/go/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/go/api-reference/models/updateobservabilitydestinationrequest.mdx b/client-sdks/go/api-reference/models/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index 0ce5965e..00000000 --- a/client-sdks/go/api-reference/models/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - Go SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest type definition -seoTitle: UpdateObservabilityDestinationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateObservabilityDestinationRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20Go%20SDK&description=UpdateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | `` | -| `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.ObservabilityFilterRulesConfig](/client-sdks/go/api-reference/models/observabilityfilterrulesconfig)] | :heavy_minus_sign: | N/A | `` | -| `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/client-sdks/go/api-reference/models/updateobservabilitydestinationresponse.mdx b/client-sdks/go/api-reference/models/updateobservabilitydestinationresponse.mdx deleted file mode 100644 index 2f26bcf2..00000000 --- a/client-sdks/go/api-reference/models/updateobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateObservabilityDestinationResponse - Go SDK -sidebarTitle: UpdateObservabilityDestinationResponse -description: UpdateObservabilityDestinationResponse type definition -seoTitle: UpdateObservabilityDestinationResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/updateobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationResponse Type | OpenRouter Go SDK -'og:description': >- - UpdateObservabilityDestinationResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationResponse%20-%20Go%20SDK&description=UpdateObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/updateworkspacerequest.mdx b/client-sdks/go/api-reference/models/updateworkspacerequest.mdx deleted file mode 100644 index 36f0d5f8..00000000 --- a/client-sdks/go/api-reference/models/updateworkspacerequest.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: UpdateWorkspaceRequest - Go SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest type definition -seoTitle: UpdateWorkspaceRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/updateworkspacerequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateWorkspaceRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20Go%20SDK&description=UpdateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `DefaultImageModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the workspace | Updated description | -| `IoLoggingAPIKeyIds` | optionalnullable.OptionalNullable[[]`int64`] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `IoLoggingSamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `IsDataDiscountLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `IsObservabilityBroadcastEnabled` | `*bool` | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `IsObservabilityIoLoggingEnabled` | `*bool` | :heavy_minus_sign: | Whether private logging is enabled | false | -| `Name` | `*string` | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `Slug` | `*string` | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/updateworkspaceresponse.mdx b/client-sdks/go/api-reference/models/updateworkspaceresponse.mdx deleted file mode 100644 index cbd77714..00000000 --- a/client-sdks/go/api-reference/models/updateworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateWorkspaceResponse - Go SDK -sidebarTitle: UpdateWorkspaceResponse -description: UpdateWorkspaceResponse type definition -seoTitle: UpdateWorkspaceResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/updateworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceResponse Type | OpenRouter Go SDK -'og:description': >- - UpdateWorkspaceResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceResponse%20-%20Go%20SDK&description=UpdateWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](/client-sdks/go/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/go/api-reference/models/urlcitation.mdx b/client-sdks/go/api-reference/models/urlcitation.mdx deleted file mode 100644 index 458a2b62..00000000 --- a/client-sdks/go/api-reference/models/urlcitation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: URLCitation - Go SDK -sidebarTitle: URLCitation -description: URLCitation type definition -seoTitle: URLCitation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/urlcitation' -'og:site_name': OpenRouter Documentation -'og:title': URLCitation Type | OpenRouter Go SDK -'og:description': >- - URLCitation type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitation%20-%20Go%20SDK&description=URLCitation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `EndIndex` | `int64` | :heavy_check_mark: | N/A | -| `StartIndex` | `int64` | :heavy_check_mark: | N/A | -| `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.URLCitationType](/client-sdks/go/api-reference/models/urlcitationtype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/urlcitationtype.mdx b/client-sdks/go/api-reference/models/urlcitationtype.mdx deleted file mode 100644 index 38e297ef..00000000 --- a/client-sdks/go/api-reference/models/urlcitationtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: URLCitationType - Go SDK -sidebarTitle: URLCitationType -description: URLCitationType type definition -seoTitle: URLCitationType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/urlcitationtype' -'og:site_name': OpenRouter Documentation -'og:title': URLCitationType Type | OpenRouter Go SDK -'og:description': >- - URLCitationType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitationType%20-%20Go%20SDK&description=URLCitationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.URLCitationTypeURLCitation -``` - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `URLCitationTypeURLCitation` | url_citation | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/usage.mdx b/client-sdks/go/api-reference/models/usage.mdx deleted file mode 100644 index 179a138a..00000000 --- a/client-sdks/go/api-reference/models/usage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Usage - Go SDK -sidebarTitle: Usage -description: Usage type definition -seoTitle: Usage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/usage' -'og:site_name': OpenRouter Documentation -'og:title': Usage Type | OpenRouter Go SDK -'og:description': >- - Usage type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Usage%20-%20Go%20SDK&description=Usage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Token usage information for the response - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `InputTokens` | `int64` | :heavy_check_mark: | N/A | -| `InputTokensDetails` | [components.InputTokensDetails](/client-sdks/go/api-reference/models/inputtokensdetails) | :heavy_check_mark: | N/A | -| `OutputTokens` | `int64` | :heavy_check_mark: | N/A | -| `OutputTokensDetails` | [components.OutputTokensDetails](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/usagecostdetails) | :heavy_minus_sign: | N/A | -| `IsByok` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/usagecostdetails.mdx b/client-sdks/go/api-reference/models/usagecostdetails.mdx deleted file mode 100644 index bb02411b..00000000 --- a/client-sdks/go/api-reference/models/usagecostdetails.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UsageCostDetails - Go SDK -sidebarTitle: UsageCostDetails -description: UsageCostDetails type definition -seoTitle: UsageCostDetails Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/usagecostdetails' -'og:site_name': OpenRouter Documentation -'og:title': UsageCostDetails Type | OpenRouter Go SDK -'og:description': >- - UsageCostDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageCostDetails%20-%20Go%20SDK&description=UsageCostDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `UpstreamInferenceCost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | -| `UpstreamInferenceInputCost` | `float64` | :heavy_check_mark: | N/A | -| `UpstreamInferenceOutputCost` | `float64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/userlocation.mdx b/client-sdks/go/api-reference/models/userlocation.mdx deleted file mode 100644 index b9d294fc..00000000 --- a/client-sdks/go/api-reference/models/userlocation.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: UserLocation - Go SDK -sidebarTitle: UserLocation -description: UserLocation type definition -seoTitle: UserLocation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/userlocation' -'og:site_name': OpenRouter Documentation -'og:title': UserLocation Type | OpenRouter Go SDK -'og:description': >- - UserLocation type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserLocation%20-%20Go%20SDK&description=UserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased search results. Passed through to native providers that support it (e.g. Anthropic). - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/websearchplugintype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/variables.mdx b/client-sdks/go/api-reference/models/variables.mdx deleted file mode 100644 index 139bc052..00000000 --- a/client-sdks/go/api-reference/models/variables.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Variables - Go SDK -sidebarTitle: Variables -description: Variables type definition -seoTitle: Variables Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/variables' -'og:site_name': OpenRouter Documentation -'og:title': Variables Type | OpenRouter Go SDK -'og:description': >- - Variables type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Variables%20-%20Go%20SDK&description=Variables%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### - -```go lines -variables := components.CreateVariablesStr(string{/* values here */}) -``` - -### InputText - -```go lines -variables := components.CreateVariablesInputText(components.InputText{/* values here */}) -``` - -### InputImage - -```go lines -variables := components.CreateVariablesInputImage(components.InputImage{/* values here */}) -``` - -### InputFile - -```go lines -variables := components.CreateVariablesInputFile(components.InputFile{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch variables.Type { - case components.VariablesTypeStr: - // variables.Str is populated - case components.VariablesTypeInputText: - // variables.InputText is populated - case components.VariablesTypeInputImage: - // variables.InputImage is populated - case components.VariablesTypeInputFile: - // variables.InputFile is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/verbosity.mdx b/client-sdks/go/api-reference/models/verbosity.mdx deleted file mode 100644 index e2109b20..00000000 --- a/client-sdks/go/api-reference/models/verbosity.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Verbosity - Go SDK -sidebarTitle: Verbosity -description: Verbosity type definition -seoTitle: Verbosity Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/verbosity' -'og:site_name': OpenRouter Documentation -'og:title': Verbosity Type | OpenRouter Go SDK -'og:description': >- - Verbosity type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Verbosity%20-%20Go%20SDK&description=Verbosity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.VerbosityLow - -// Open enum: custom values can be created with a direct type cast -custom := components.Verbosity("custom_value") -``` - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `VerbosityLow` | low | -| `VerbosityMedium` | medium | -| `VerbosityHigh` | high | -| `VerbosityXhigh` | xhigh | -| `VerbosityMax` | max | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/version.mdx b/client-sdks/go/api-reference/models/version.mdx deleted file mode 100644 index f456e72f..00000000 --- a/client-sdks/go/api-reference/models/version.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Version - Go SDK -sidebarTitle: Version -description: Version type definition -seoTitle: Version Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/version' -'og:site_name': OpenRouter Documentation -'og:title': Version Type | OpenRouter Go SDK -'og:description': >- - Version type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Version%20-%20Go%20SDK&description=Version%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Dataset version. Field names and grain are stable for the life of `v1`. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.VersionV1 -``` - -## Values - -| Name | Value | -| ----------- | ----------- | -| `VersionV1` | v1 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/videogenerationrequest.mdx b/client-sdks/go/api-reference/models/videogenerationrequest.mdx deleted file mode 100644 index d021375a..00000000 --- a/client-sdks/go/api-reference/models/videogenerationrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: VideoGenerationRequest - Go SDK -sidebarTitle: VideoGenerationRequest -description: VideoGenerationRequest type definition -seoTitle: VideoGenerationRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/videogenerationrequest' -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequest Type | OpenRouter Go SDK -'og:description': >- - VideoGenerationRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequest%20-%20Go%20SDK&description=VideoGenerationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AspectRatio` | [*components.AspectRatio](/client-sdks/go/api-reference/models/aspectratio) | :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](/client-sdks/go/api-reference/models/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.ContentPartImage](/client-sdks/go/api-reference/models/contentpartimage) | :heavy_minus_sign: | Reference images to guide video generation | | -| `Model` | `string` | :heavy_check_mark: | N/A | | -| `Prompt` | `string` | :heavy_check_mark: | N/A | | -| `Provider` | [*components.VideoGenerationRequestProvider](/client-sdks/go/api-reference/models/videogenerationrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `Resolution` | [*components.Resolution](/client-sdks/go/api-reference/models/resolution) | :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/client-sdks/go/api-reference/models/videogenerationrequestprovider.mdx b/client-sdks/go/api-reference/models/videogenerationrequestprovider.mdx deleted file mode 100644 index 622c1417..00000000 --- a/client-sdks/go/api-reference/models/videogenerationrequestprovider.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: VideoGenerationRequestProvider - Go SDK -sidebarTitle: VideoGenerationRequestProvider -description: VideoGenerationRequestProvider type definition -seoTitle: VideoGenerationRequestProvider Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/videogenerationrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequestProvider Type | OpenRouter Go SDK -'og:description': >- - VideoGenerationRequestProvider type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequestProvider%20-%20Go%20SDK&description=VideoGenerationRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `Options` | [*components.OptionsObj](/client-sdks/go/api-reference/models/optionsobj) | :heavy_minus_sign: | N/A | `{"google-vertex": {"output_config": {"effort": "low"}`
\}
\} | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/videogenerationresponse.mdx b/client-sdks/go/api-reference/models/videogenerationresponse.mdx deleted file mode 100644 index 26432a12..00000000 --- a/client-sdks/go/api-reference/models/videogenerationresponse.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: VideoGenerationResponse - Go SDK -sidebarTitle: VideoGenerationResponse -description: VideoGenerationResponse type definition -seoTitle: VideoGenerationResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/videogenerationresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponse Type | OpenRouter Go SDK -'og:description': >- - VideoGenerationResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponse%20-%20Go%20SDK&description=VideoGenerationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `Error` | `*string` | :heavy_minus_sign: | N/A | | -| `GenerationID` | `*string` | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `ID` | `string` | :heavy_check_mark: | N/A | | -| `PollingURL` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.VideoGenerationResponseStatus](/client-sdks/go/api-reference/models/videogenerationresponsestatus) | :heavy_check_mark: | N/A | | -| `UnsignedUrls` | []`string` | :heavy_minus_sign: | N/A | | -| `Usage` | [*components.VideoGenerationUsage](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/videogenerationresponsestatus.mdx b/client-sdks/go/api-reference/models/videogenerationresponsestatus.mdx deleted file mode 100644 index ed8dc3b0..00000000 --- a/client-sdks/go/api-reference/models/videogenerationresponsestatus.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: VideoGenerationResponseStatus - Go SDK -sidebarTitle: VideoGenerationResponseStatus -description: VideoGenerationResponseStatus type definition -seoTitle: VideoGenerationResponseStatus Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/videogenerationresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponseStatus Type | OpenRouter Go SDK -'og:description': >- - VideoGenerationResponseStatus type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponseStatus%20-%20Go%20SDK&description=VideoGenerationResponseStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.VideoGenerationResponseStatusPending - -// Open enum: custom values can be created with a direct type cast -custom := components.VideoGenerationResponseStatus("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------------------- | ----------------------------------------- | -| `VideoGenerationResponseStatusPending` | pending | -| `VideoGenerationResponseStatusInProgress` | in_progress | -| `VideoGenerationResponseStatusCompleted` | completed | -| `VideoGenerationResponseStatusFailed` | failed | -| `VideoGenerationResponseStatusCancelled` | cancelled | -| `VideoGenerationResponseStatusExpired` | expired | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/videogenerationusage.mdx b/client-sdks/go/api-reference/models/videogenerationusage.mdx deleted file mode 100644 index 2830d1a7..00000000 --- a/client-sdks/go/api-reference/models/videogenerationusage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: VideoGenerationUsage - Go SDK -sidebarTitle: VideoGenerationUsage -description: VideoGenerationUsage type definition -seoTitle: VideoGenerationUsage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/videogenerationusage' -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationUsage Type | OpenRouter Go SDK -'og:description': >- - VideoGenerationUsage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationUsage%20-%20Go%20SDK&description=VideoGenerationUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Usage and cost information for the video generation. Available once the job has completed. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | The cost of the video generation in USD. | -| `IsByok` | `*bool` | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/videomodel.mdx b/client-sdks/go/api-reference/models/videomodel.mdx deleted file mode 100644 index 0bebbeae..00000000 --- a/client-sdks/go/api-reference/models/videomodel.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: VideoModel - Go SDK -sidebarTitle: VideoModel -description: VideoModel type definition -seoTitle: VideoModel Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/videomodel' -'og:site_name': OpenRouter Documentation -'og:title': VideoModel Type | OpenRouter Go SDK -'og:description': >- - VideoModel type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModel%20-%20Go%20SDK&description=VideoModel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `CanonicalSlug` | `string` | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `Description` | `*string` | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `GenerateAudio` | `*bool` | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `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 | -| `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](/client-sdks/go/api-reference/models/supportedaspectratio) | :heavy_check_mark: | Supported output aspect ratios | | -| `SupportedDurations` | []`int64` | :heavy_check_mark: | Supported video durations in seconds | | -| `SupportedFrameImages` | [][components.SupportedFrameImage](/client-sdks/go/api-reference/models/supportedframeimage) | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `SupportedResolutions` | [][components.SupportedResolution](/client-sdks/go/api-reference/models/supportedresolution) | :heavy_check_mark: | Supported output resolutions | | -| `SupportedSizes` | [][components.SupportedSize](/client-sdks/go/api-reference/models/supportedsize) | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/videomodelslistresponse.mdx b/client-sdks/go/api-reference/models/videomodelslistresponse.mdx deleted file mode 100644 index 0d9efa0f..00000000 --- a/client-sdks/go/api-reference/models/videomodelslistresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: VideoModelsListResponse - Go SDK -sidebarTitle: VideoModelsListResponse -description: VideoModelsListResponse type definition -seoTitle: VideoModelsListResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/client-sdks/go/api-reference/models/videomodelslistresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoModelsListResponse Type | OpenRouter Go SDK -'og:description': >- - VideoModelsListResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModelsListResponse%20-%20Go%20SDK&description=VideoModelsListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [][components.VideoModel](/client-sdks/go/api-reference/models/videomodel) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/webfetchengineenum.mdx b/client-sdks/go/api-reference/models/webfetchengineenum.mdx deleted file mode 100644 index 14b60ab5..00000000 --- a/client-sdks/go/api-reference/models/webfetchengineenum.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: WebFetchEngineEnum - Go SDK -sidebarTitle: WebFetchEngineEnum -description: WebFetchEngineEnum type definition -seoTitle: WebFetchEngineEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/webfetchengineenum' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchEngineEnum Type | OpenRouter Go SDK -'og:description': >- - WebFetchEngineEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchEngineEnum%20-%20Go%20SDK&description=WebFetchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebFetchEngineEnumAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.WebFetchEngineEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `WebFetchEngineEnumAuto` | auto | -| `WebFetchEngineEnumNative` | native | -| `WebFetchEngineEnumOpenrouter` | openrouter | -| `WebFetchEngineEnumExa` | exa | -| `WebFetchEngineEnumParallel` | parallel | -| `WebFetchEngineEnumFirecrawl` | firecrawl | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/webfetchplugin.mdx b/client-sdks/go/api-reference/models/webfetchplugin.mdx deleted file mode 100644 index c7e56d86..00000000 --- a/client-sdks/go/api-reference/models/webfetchplugin.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebFetchPlugin - Go SDK -sidebarTitle: WebFetchPlugin -description: WebFetchPlugin type definition -seoTitle: WebFetchPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/webfetchplugin' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchPlugin Type | OpenRouter Go SDK -'og:description': >- - WebFetchPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchPlugin%20-%20Go%20SDK&description=WebFetchPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | -| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | -| `ID` | [components.WebFetchPluginID](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/webfetchpluginid.mdx b/client-sdks/go/api-reference/models/webfetchpluginid.mdx deleted file mode 100644 index 70168909..00000000 --- a/client-sdks/go/api-reference/models/webfetchpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebFetchPluginID - Go SDK -sidebarTitle: WebFetchPluginID -description: WebFetchPluginID type definition -seoTitle: WebFetchPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/webfetchpluginid' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchPluginID Type | OpenRouter Go SDK -'og:description': >- - WebFetchPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchPluginID%20-%20Go%20SDK&description=WebFetchPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebFetchPluginIDWebFetch -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `WebFetchPluginIDWebFetch` | web-fetch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/webfetchservertool.mdx b/client-sdks/go/api-reference/models/webfetchservertool.mdx deleted file mode 100644 index 6d788cc0..00000000 --- a/client-sdks/go/api-reference/models/webfetchservertool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: WebFetchServerTool - Go SDK -sidebarTitle: WebFetchServerTool -description: WebFetchServerTool type definition -seoTitle: WebFetchServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/webfetchservertool' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerTool Type | OpenRouter Go SDK -'og:description': >- - WebFetchServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerTool%20-%20Go%20SDK&description=WebFetchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fetches full content from a URL (web page or PDF) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.WebFetchServerToolConfig](/client-sdks/go/api-reference/models/webfetchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | `{"max_content_tokens": 100000,"max_uses": 10}` | -| `Type` | [components.WebFetchServerToolType](/client-sdks/go/api-reference/models/webfetchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/webfetchservertoolconfig.mdx b/client-sdks/go/api-reference/models/webfetchservertoolconfig.mdx deleted file mode 100644 index 59adedd0..00000000 --- a/client-sdks/go/api-reference/models/webfetchservertoolconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebFetchServerToolConfig - Go SDK -sidebarTitle: WebFetchServerToolConfig -description: WebFetchServerToolConfig type definition -seoTitle: WebFetchServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/webfetchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - WebFetchServerToolConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolConfig%20-%20Go%20SDK&description=WebFetchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_fetch server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | | -| `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | | -| `Engine` | [*components.WebFetchEngineEnum](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/webfetchservertooltype.mdx b/client-sdks/go/api-reference/models/webfetchservertooltype.mdx deleted file mode 100644 index b2c80c44..00000000 --- a/client-sdks/go/api-reference/models/webfetchservertooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebFetchServerToolType - Go SDK -sidebarTitle: WebFetchServerToolType -description: WebFetchServerToolType type definition -seoTitle: WebFetchServerToolType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/webfetchservertooltype' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolType Type | OpenRouter Go SDK -'og:description': >- - WebFetchServerToolType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolType%20-%20Go%20SDK&description=WebFetchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebFetchServerToolTypeOpenrouterWebFetch -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `WebFetchServerToolTypeOpenrouterWebFetch` | openrouter:web_fetch | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallcompletedevent.mdx b/client-sdks/go/api-reference/models/websearchcallcompletedevent.mdx deleted file mode 100644 index c2c141e2..00000000 --- a/client-sdks/go/api-reference/models/websearchcallcompletedevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallCompletedEvent - Go SDK -sidebarTitle: WebSearchCallCompletedEvent -description: WebSearchCallCompletedEvent type definition -seoTitle: WebSearchCallCompletedEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallCompletedEvent Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallCompletedEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallCompletedEvent%20-%20Go%20SDK&description=WebSearchCallCompletedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search call completed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallCompletedEventType](/client-sdks/go/api-reference/models/websearchcallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallcompletedeventtype.mdx b/client-sdks/go/api-reference/models/websearchcallcompletedeventtype.mdx deleted file mode 100644 index d650d4eb..00000000 --- a/client-sdks/go/api-reference/models/websearchcallcompletedeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchCallCompletedEventType - Go SDK -sidebarTitle: WebSearchCallCompletedEventType -description: WebSearchCallCompletedEventType type definition -seoTitle: WebSearchCallCompletedEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallcompletedeventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallCompletedEventType Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallCompletedEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallCompletedEventType%20-%20Go%20SDK&description=WebSearchCallCompletedEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchCallCompletedEventTypeResponseWebSearchCallCompleted -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------- | --------------------------------------------------------------- | -| `WebSearchCallCompletedEventTypeResponseWebSearchCallCompleted` | response.web_search_call.completed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallinprogressevent.mdx b/client-sdks/go/api-reference/models/websearchcallinprogressevent.mdx deleted file mode 100644 index 569d1c8f..00000000 --- a/client-sdks/go/api-reference/models/websearchcallinprogressevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallInProgressEvent - Go SDK -sidebarTitle: WebSearchCallInProgressEvent -description: WebSearchCallInProgressEvent type definition -seoTitle: WebSearchCallInProgressEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallInProgressEvent Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallInProgressEvent type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallInProgressEvent%20-%20Go%20SDK&description=WebSearchCallInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search call in progress - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallInProgressEventType](/client-sdks/go/api-reference/models/websearchcallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallinprogresseventtype.mdx b/client-sdks/go/api-reference/models/websearchcallinprogresseventtype.mdx deleted file mode 100644 index 62da3ee4..00000000 --- a/client-sdks/go/api-reference/models/websearchcallinprogresseventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchCallInProgressEventType - Go SDK -sidebarTitle: WebSearchCallInProgressEventType -description: WebSearchCallInProgressEventType type definition -seoTitle: WebSearchCallInProgressEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallInProgressEventType Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallInProgressEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallInProgressEventType%20-%20Go%20SDK&description=WebSearchCallInProgressEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchCallInProgressEventTypeResponseWebSearchCallInProgress -``` - -## Values - -| Name | Value | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `WebSearchCallInProgressEventTypeResponseWebSearchCallInProgress` | response.web_search_call.in_progress | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallsearchingevent.mdx b/client-sdks/go/api-reference/models/websearchcallsearchingevent.mdx deleted file mode 100644 index 8f00ad01..00000000 --- a/client-sdks/go/api-reference/models/websearchcallsearchingevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallSearchingEvent - Go SDK -sidebarTitle: WebSearchCallSearchingEvent -description: WebSearchCallSearchingEvent type definition -seoTitle: WebSearchCallSearchingEvent Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallsearchingevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallSearchingEvent Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallSearchingEvent type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallSearchingEvent%20-%20Go%20SDK&description=WebSearchCallSearchingEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search call is searching - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ItemID` | `string` | :heavy_check_mark: | N/A | -| `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallSearchingEventType](/client-sdks/go/api-reference/models/websearchcallsearchingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchcallsearchingeventtype.mdx b/client-sdks/go/api-reference/models/websearchcallsearchingeventtype.mdx deleted file mode 100644 index 2750058c..00000000 --- a/client-sdks/go/api-reference/models/websearchcallsearchingeventtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchCallSearchingEventType - Go SDK -sidebarTitle: WebSearchCallSearchingEventType -description: WebSearchCallSearchingEventType type definition -seoTitle: WebSearchCallSearchingEventType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchcallsearchingeventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallSearchingEventType Type | OpenRouter Go SDK -'og:description': >- - WebSearchCallSearchingEventType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallSearchingEventType%20-%20Go%20SDK&description=WebSearchCallSearchingEventType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchCallSearchingEventTypeResponseWebSearchCallSearching -``` - -## Values - -| Name | Value | -| --------------------------------------------------------------- | --------------------------------------------------------------- | -| `WebSearchCallSearchingEventTypeResponseWebSearchCallSearching` | response.web_search_call.searching | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchconfig.mdx b/client-sdks/go/api-reference/models/websearchconfig.mdx deleted file mode 100644 index 423f1be4..00000000 --- a/client-sdks/go/api-reference/models/websearchconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchConfig - Go SDK -sidebarTitle: WebSearchConfig -description: WebSearchConfig type definition -seoTitle: WebSearchConfig Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchconfig' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchConfig Type | OpenRouter Go SDK -'og:description': >- - WebSearchConfig type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchConfig%20-%20Go%20SDK&description=WebSearchConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 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 | -| `SearchContextSize` | [*components.SearchQualityLevel](/client-sdks/go/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/websearchdomainfilter.mdx b/client-sdks/go/api-reference/models/websearchdomainfilter.mdx deleted file mode 100644 index dae99502..00000000 --- a/client-sdks/go/api-reference/models/websearchdomainfilter.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchDomainFilter - Go SDK -sidebarTitle: WebSearchDomainFilter -description: WebSearchDomainFilter type definition -seoTitle: WebSearchDomainFilter Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchdomainfilter' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchDomainFilter Type | OpenRouter Go SDK -'og:description': >- - WebSearchDomainFilter type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchDomainFilter%20-%20Go%20SDK&description=WebSearchDomainFilter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | -| `ExcludedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchengine.mdx b/client-sdks/go/api-reference/models/websearchengine.mdx deleted file mode 100644 index fef2a910..00000000 --- a/client-sdks/go/api-reference/models/websearchengine.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: WebSearchEngine - Go SDK -sidebarTitle: WebSearchEngine -description: WebSearchEngine type definition -seoTitle: WebSearchEngine Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchengine' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngine Type | OpenRouter Go SDK -'og:description': >- - WebSearchEngine type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngine%20-%20Go%20SDK&description=WebSearchEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The search engine to use for web search. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchEngineNative - -// Open enum: custom values can be created with a direct type cast -custom := components.WebSearchEngine("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `WebSearchEngineNative` | native | -| `WebSearchEngineExa` | exa | -| `WebSearchEngineFirecrawl` | firecrawl | -| `WebSearchEngineParallel` | parallel | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchengineenum.mdx b/client-sdks/go/api-reference/models/websearchengineenum.mdx deleted file mode 100644 index 6b2dc975..00000000 --- a/client-sdks/go/api-reference/models/websearchengineenum.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WebSearchEngineEnum - Go SDK -sidebarTitle: WebSearchEngineEnum -description: WebSearchEngineEnum type definition -seoTitle: WebSearchEngineEnum Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchengineenum' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngineEnum Type | OpenRouter Go SDK -'og:description': >- - WebSearchEngineEnum type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngineEnum%20-%20Go%20SDK&description=WebSearchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchEngineEnumAuto - -// Open enum: custom values can be created with a direct type cast -custom := components.WebSearchEngineEnum("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `WebSearchEngineEnumAuto` | auto | -| `WebSearchEngineEnumNative` | native | -| `WebSearchEngineEnumExa` | exa | -| `WebSearchEngineEnumParallel` | parallel | -| `WebSearchEngineEnumFirecrawl` | firecrawl | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchplugin.mdx b/client-sdks/go/api-reference/models/websearchplugin.mdx deleted file mode 100644 index 31d26ad8..00000000 --- a/client-sdks/go/api-reference/models/websearchplugin.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: WebSearchPlugin - Go SDK -sidebarTitle: WebSearchPlugin -description: WebSearchPlugin type definition -seoTitle: WebSearchPlugin Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchplugin' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPlugin Type | OpenRouter Go SDK -'og:description': >- - WebSearchPlugin type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPlugin%20-%20Go%20SDK&description=WebSearchPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/websearchpluginid.mdx b/client-sdks/go/api-reference/models/websearchpluginid.mdx deleted file mode 100644 index 944ac92f..00000000 --- a/client-sdks/go/api-reference/models/websearchpluginid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebSearchPluginID - Go SDK -sidebarTitle: WebSearchPluginID -description: WebSearchPluginID type definition -seoTitle: WebSearchPluginID Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchpluginid' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPluginID Type | OpenRouter Go SDK -'og:description': >- - WebSearchPluginID type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPluginID%20-%20Go%20SDK&description=WebSearchPluginID%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchPluginIDWeb -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `WebSearchPluginIDWeb` | web | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchplugintype.mdx b/client-sdks/go/api-reference/models/websearchplugintype.mdx deleted file mode 100644 index 0c6a5186..00000000 --- a/client-sdks/go/api-reference/models/websearchplugintype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebSearchPluginType - Go SDK -sidebarTitle: WebSearchPluginType -description: WebSearchPluginType type definition -seoTitle: WebSearchPluginType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchplugintype' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPluginType Type | OpenRouter Go SDK -'og:description': >- - WebSearchPluginType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPluginType%20-%20Go%20SDK&description=WebSearchPluginType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchPluginTypeApproximate -``` - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `WebSearchPluginTypeApproximate` | approximate | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchservertool.mdx b/client-sdks/go/api-reference/models/websearchservertool.mdx deleted file mode 100644 index d56cd325..00000000 --- a/client-sdks/go/api-reference/models/websearchservertool.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchServerTool - Go SDK -sidebarTitle: WebSearchServerTool -description: WebSearchServerTool type definition -seoTitle: WebSearchServerTool Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchservertool' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerTool Type | OpenRouter Go SDK -'og:description': >- - WebSearchServerTool type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerTool%20-%20Go%20SDK&description=WebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Web search tool configuration (2025-08-26 version) - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `Filters` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](/client-sdks/go/api-reference/models/websearchdomainfilter)] | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.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, and Parallel engines; ignored with native provider search. | 5 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](/client-sdks/go/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.WebSearchServerToolType](/client-sdks/go/api-reference/models/websearchservertooltype) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/websearchservertoolconfig.mdx b/client-sdks/go/api-reference/models/websearchservertoolconfig.mdx deleted file mode 100644 index c8944a09..00000000 --- a/client-sdks/go/api-reference/models/websearchservertoolconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchServerToolConfig - Go SDK -sidebarTitle: WebSearchServerToolConfig -description: WebSearchServerToolConfig type definition -seoTitle: WebSearchServerToolConfig Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolConfig Type | OpenRouter Go SDK -'og:description': >- - WebSearchServerToolConfig type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolConfig%20-%20Go%20SDK&description=WebSearchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_search server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AllowedDomains` | []`string` | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](/client-sdks/go/api-reference/models/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. | auto | -| `ExcludedDomains` | []`string` | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `MaxResults` | `*int64` | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 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 | -| `SearchContextSize` | [*components.SearchQualityLevel](/client-sdks/go/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/websearchservertoolopenrouter.mdx b/client-sdks/go/api-reference/models/websearchservertoolopenrouter.mdx deleted file mode 100644 index 5edbb41f..00000000 --- a/client-sdks/go/api-reference/models/websearchservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebSearchServerToolOpenRouter - Go SDK -sidebarTitle: WebSearchServerToolOpenRouter -description: WebSearchServerToolOpenRouter type definition -seoTitle: WebSearchServerToolOpenRouter Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolOpenRouter Type | OpenRouter Go SDK -'og:description': >- - WebSearchServerToolOpenRouter type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolOpenRouter%20-%20Go%20SDK&description=WebSearchServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchServerToolConfig](/client-sdks/go/api-reference/models/websearchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | `{"max_results": 5,"search_context_size": "medium"}` | -| `Type` | [components.WebSearchServerToolOpenRouterType](/client-sdks/go/api-reference/models/websearchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchservertoolopenroutertype.mdx b/client-sdks/go/api-reference/models/websearchservertoolopenroutertype.mdx deleted file mode 100644 index 4273759d..00000000 --- a/client-sdks/go/api-reference/models/websearchservertoolopenroutertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchServerToolOpenRouterType - Go SDK -sidebarTitle: WebSearchServerToolOpenRouterType -description: WebSearchServerToolOpenRouterType type definition -seoTitle: WebSearchServerToolOpenRouterType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolOpenRouterType Type | OpenRouter Go SDK -'og:description': >- - WebSearchServerToolOpenRouterType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolOpenRouterType%20-%20Go%20SDK&description=WebSearchServerToolOpenRouterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchServerToolOpenRouterTypeOpenrouterWebSearch -``` - -## Values - -| Name | Value | -| ------------------------------------------------------ | ------------------------------------------------------ | -| `WebSearchServerToolOpenRouterTypeOpenrouterWebSearch` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchservertooltype.mdx b/client-sdks/go/api-reference/models/websearchservertooltype.mdx deleted file mode 100644 index bbd7c693..00000000 --- a/client-sdks/go/api-reference/models/websearchservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchServerToolType - Go SDK -sidebarTitle: WebSearchServerToolType -description: WebSearchServerToolType type definition -seoTitle: WebSearchServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolType Type | OpenRouter Go SDK -'og:description': >- - WebSearchServerToolType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolType%20-%20Go%20SDK&description=WebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchServerToolTypeWebSearch20250826 -``` - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `WebSearchServerToolTypeWebSearch20250826` | web_search_2025_08_26 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchsource.mdx b/client-sdks/go/api-reference/models/websearchsource.mdx deleted file mode 100644 index 01ee5a6d..00000000 --- a/client-sdks/go/api-reference/models/websearchsource.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchSource - Go SDK -sidebarTitle: WebSearchSource -description: WebSearchSource type definition -seoTitle: WebSearchSource Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchsource' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSource Type | OpenRouter Go SDK -'og:description': >- - WebSearchSource type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSource%20-%20Go%20SDK&description=WebSearchSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.WebSearchSourceType](/client-sdks/go/api-reference/models/websearchsourcetype) | :heavy_check_mark: | N/A | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchsourcetype.mdx b/client-sdks/go/api-reference/models/websearchsourcetype.mdx deleted file mode 100644 index 0f0a7d5d..00000000 --- a/client-sdks/go/api-reference/models/websearchsourcetype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebSearchSourceType - Go SDK -sidebarTitle: WebSearchSourceType -description: WebSearchSourceType type definition -seoTitle: WebSearchSourceType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchsourcetype' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSourceType Type | OpenRouter Go SDK -'og:description': >- - WebSearchSourceType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSourceType%20-%20Go%20SDK&description=WebSearchSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchSourceTypeURL -``` - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `WebSearchSourceTypeURL` | url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchstatus.mdx b/client-sdks/go/api-reference/models/websearchstatus.mdx deleted file mode 100644 index 149efcae..00000000 --- a/client-sdks/go/api-reference/models/websearchstatus.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: WebSearchStatus - Go SDK -sidebarTitle: WebSearchStatus -description: WebSearchStatus type definition -seoTitle: WebSearchStatus Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchstatus' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchStatus Type | OpenRouter Go SDK -'og:description': >- - WebSearchStatus type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchStatus%20-%20Go%20SDK&description=WebSearchStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchStatusCompleted - -// Open enum: custom values can be created with a direct type cast -custom := components.WebSearchStatus("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `WebSearchStatusCompleted` | completed | -| `WebSearchStatusSearching` | searching | -| `WebSearchStatusInProgress` | in_progress | -| `WebSearchStatusFailed` | failed | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchuserlocation.mdx b/client-sdks/go/api-reference/models/websearchuserlocation.mdx deleted file mode 100644 index 6bf2fa6b..00000000 --- a/client-sdks/go/api-reference/models/websearchuserlocation.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchUserLocation - Go SDK -sidebarTitle: WebSearchUserLocation -description: WebSearchUserLocation type definition -seoTitle: WebSearchUserLocation Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/websearchuserlocation' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocation Type | OpenRouter Go SDK -'og:description': >- - WebSearchUserLocation type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocation%20-%20Go%20SDK&description=WebSearchUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -User location information for web search - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/websearchuserlocationtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchuserlocationservertool.mdx b/client-sdks/go/api-reference/models/websearchuserlocationservertool.mdx deleted file mode 100644 index 4ae59c9c..00000000 --- a/client-sdks/go/api-reference/models/websearchuserlocationservertool.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchUserLocationServerTool - Go SDK -sidebarTitle: WebSearchUserLocationServerTool -description: WebSearchUserLocationServerTool type definition -seoTitle: WebSearchUserLocationServerTool Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchuserlocationservertool -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerTool Type | OpenRouter Go SDK -'og:description': >- - WebSearchUserLocationServerTool type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerTool%20-%20Go%20SDK&description=WebSearchUserLocationServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased results. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `City` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `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](/client-sdks/go/api-reference/models/websearchuserlocationservertooltype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchuserlocationservertooltype.mdx b/client-sdks/go/api-reference/models/websearchuserlocationservertooltype.mdx deleted file mode 100644 index 227ba8ee..00000000 --- a/client-sdks/go/api-reference/models/websearchuserlocationservertooltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchUserLocationServerToolType - Go SDK -sidebarTitle: WebSearchUserLocationServerToolType -description: WebSearchUserLocationServerToolType type definition -seoTitle: WebSearchUserLocationServerToolType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchuserlocationservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerToolType Type | OpenRouter Go SDK -'og:description': >- - WebSearchUserLocationServerToolType type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerToolType%20-%20Go%20SDK&description=WebSearchUserLocationServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchUserLocationServerToolTypeApproximate -``` - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `WebSearchUserLocationServerToolTypeApproximate` | approximate | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/websearchuserlocationtype.mdx b/client-sdks/go/api-reference/models/websearchuserlocationtype.mdx deleted file mode 100644 index 0b2a83ab..00000000 --- a/client-sdks/go/api-reference/models/websearchuserlocationtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchUserLocationType - Go SDK -sidebarTitle: WebSearchUserLocationType -description: WebSearchUserLocationType type definition -seoTitle: WebSearchUserLocationType Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/models/websearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationType Type | OpenRouter Go SDK -'og:description': >- - WebSearchUserLocationType type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationType%20-%20Go%20SDK&description=WebSearchUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WebSearchUserLocationTypeApproximate -``` - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `WebSearchUserLocationTypeApproximate` | approximate | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/workspace.mdx b/client-sdks/go/api-reference/models/workspace.mdx deleted file mode 100644 index 99c2372f..00000000 --- a/client-sdks/go/api-reference/models/workspace.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Workspace - Go SDK -sidebarTitle: Workspace -description: Workspace type definition -seoTitle: Workspace Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/workspace' -'og:site_name': OpenRouter Documentation -'og:title': Workspace Type | OpenRouter Go SDK -'og:description': >- - Workspace type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspace%20-%20Go%20SDK&description=Workspace%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `CreatedBy` | `*string` | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `DefaultImageModel` | `*string` | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `DefaultProviderSort` | `*string` | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `DefaultTextModel` | `*string` | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `Description` | `*string` | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `IoLoggingAPIKeyIds` | []`int64` | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | `` | -| `IoLoggingSamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `IsDataDiscountLoggingEnabled` | `bool` | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `IsObservabilityBroadcastEnabled` | `bool` | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `IsObservabilityIoLoggingEnabled` | `bool` | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `Name` | `string` | :heavy_check_mark: | Name of the workspace | Production | -| `Slug` | `string` | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/go/api-reference/models/workspacemember.mdx b/client-sdks/go/api-reference/models/workspacemember.mdx deleted file mode 100644 index 8705b5ba..00000000 --- a/client-sdks/go/api-reference/models/workspacemember.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WorkspaceMember - Go SDK -sidebarTitle: WorkspaceMember -description: WorkspaceMember type definition -seoTitle: WorkspaceMember Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/workspacemember' -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMember Type | OpenRouter Go SDK -'og:description': >- - WorkspaceMember type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMember%20-%20Go%20SDK&description=WorkspaceMember%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `Role` | [components.WorkspaceMemberRole](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/models/workspacememberrole.mdx b/client-sdks/go/api-reference/models/workspacememberrole.mdx deleted file mode 100644 index 848d5110..00000000 --- a/client-sdks/go/api-reference/models/workspacememberrole.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: WorkspaceMemberRole - Go SDK -sidebarTitle: WorkspaceMemberRole -description: WorkspaceMemberRole type definition -seoTitle: WorkspaceMemberRole Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/models/workspacememberrole' -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMemberRole Type | OpenRouter Go SDK -'og:description': >- - WorkspaceMemberRole type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMemberRole%20-%20Go%20SDK&description=WorkspaceMemberRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Role of the member in the workspace - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -value := components.WorkspaceMemberRoleAdmin - -// Open enum: custom values can be created with a direct type cast -custom := components.WorkspaceMemberRole("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `WorkspaceMemberRoleAdmin` | admin | -| `WorkspaceMemberRoleMember` | member | \ No newline at end of file diff --git a/client-sdks/go/api-reference/oauth.mdx b/client-sdks/go/api-reference/oauth.mdx deleted file mode 100644 index f0c977a6..00000000 --- a/client-sdks/go/api-reference/oauth.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: OAuth - Go SDK -sidebarTitle: OAuth -description: OAuth method reference -seoTitle: OAuth | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/oauth' -'og:site_name': OpenRouter Documentation -'og:title': OAuth | OpenRouter Go SDK -'og:description': >- - OAuth method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OAuth%20-%20Go%20SDK&description=OAuth%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: shield-check ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -OAuth authentication endpoints - -### Available Operations - -* [ExchangeAuthCodeForAPIKey](#exchangeauthcodeforapikey) - Exchange authorization code for API key -* [CreateAuthCode](#createauthcode) - Create authorization code - -## ExchangeAuthCodeForAPIKey - -Exchange an authorization code from the PKCE flow for a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="go" operationID="exchangeAuthCodeForAPIKey" method="post" path="/auth/keys" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.OAuth.ExchangeAuthCodeForAPIKey(ctx, operations.ExchangeAuthCodeForAPIKeyRequest{ - Code: "auth_code_abc123def456", - CodeChallengeMethod: optionalnullable.From(openrouter.Pointer(operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethodS256)), - CodeVerifier: openrouter.Pointer("dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.ExchangeAuthCodeForAPIKeyResponse](/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## CreateAuthCode - -Create an authorization code for the PKCE flow to generate a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="go" operationID="createAuthKeysCode" method="post" path="/auth/keys/code" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.OAuth.CreateAuthCode(ctx, operations.CreateAuthKeysCodeRequest{ - CallbackURL: "https://myapp.com/auth/callback", - CodeChallenge: openrouter.Pointer("E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM"), - CodeChallengeMethod: operations.CreateAuthKeysCodeCodeChallengeMethodS256.ToPointer(), - Limit: openrouter.Pointer[float64](100.0), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/createauthkeyscoderequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.CreateAuthKeysCodeResponse](/client-sdks/go/api-reference/operations/createauthkeyscoderesponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/observability.mdx b/client-sdks/go/api-reference/observability.mdx deleted file mode 100644 index 34c52031..00000000 --- a/client-sdks/go/api-reference/observability.mdx +++ /dev/null @@ -1,462 +0,0 @@ ---- -title: Observability - Go SDK -sidebarTitle: Observability -description: Observability method reference -seoTitle: Observability | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/observability' -'og:site_name': OpenRouter Documentation -'og:title': Observability | OpenRouter Go SDK -'og:description': >- - Observability method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Observability%20-%20Go%20SDK&description=Observability%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Observability endpoints - -### Available Operations - -* [List](#list) - List observability destinations -* [Create](#create) - Create an observability destination -* [Delete](#delete) - Delete an observability destination -* [Get](#get) - Get an observability destination -* [Update](#update) - Update an observability destination - -## List - -List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listObservabilityDestinations" method="get" path="/observability/destinations" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Observability.List(ctx, optionalnullable.From[int64](nil), nil, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `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 | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListObservabilityDestinationsResponse](/client-sdks/go/api-reference/operations/listobservabilitydestinationsresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Create - -Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createObservabilityDestination" method="post" path="/observability/destinations" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Observability.Create(ctx, components.CreateObservabilityDestinationRequest{ - Config: map[string]any{ - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, - Name: "Production Langfuse", - Type: components.CreateObservabilityDestinationRequestTypeLangfuse, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - switch res.Data.Type { - case components.ObservabilityDestinationTypeArize: - // res.Data.ObservabilityArizeDestination is populated - case components.ObservabilityDestinationTypeBraintrust: - // res.Data.ObservabilityBraintrustDestination is populated - case components.ObservabilityDestinationTypeClickhouse: - // res.Data.ObservabilityClickhouseDestination is populated - case components.ObservabilityDestinationTypeDatadog: - // res.Data.ObservabilityDatadogDestination is populated - case components.ObservabilityDestinationTypeGrafana: - // res.Data.ObservabilityGrafanaDestination is populated - case components.ObservabilityDestinationTypeLangfuse: - // res.Data.ObservabilityLangfuseDestination is populated - case components.ObservabilityDestinationTypeLangsmith: - // res.Data.ObservabilityLangsmithDestination is populated - case components.ObservabilityDestinationTypeNewrelic: - // res.Data.ObservabilityNewrelicDestination is populated - case components.ObservabilityDestinationTypeOpik: - // res.Data.ObservabilityOpikDestination is populated - case components.ObservabilityDestinationTypeOtelCollector: - // res.Data.ObservabilityOtelCollectorDestination is populated - case components.ObservabilityDestinationTypePosthog: - // res.Data.ObservabilityPosthogDestination is populated - case components.ObservabilityDestinationTypeRamp: - // res.Data.ObservabilityRampDestination is populated - case components.ObservabilityDestinationTypeS3: - // res.Data.ObservabilityS3Destination is populated - case components.ObservabilityDestinationTypeSentry: - // res.Data.ObservabilitySentryDestination is populated - case components.ObservabilityDestinationTypeSnowflake: - // res.Data.ObservabilitySnowflakeDestination is populated - case components.ObservabilityDestinationTypeWeave: - // res.Data.ObservabilityWeaveDestination is populated - case components.ObservabilityDestinationTypeWebhook: - // res.Data.ObservabilityWebhookDestination is populated - default: - // Unknown type - use res.Data.GetUnknownRaw() for raw JSON - } - - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/createobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.CreateObservabilityDestinationResponse](/client-sdks/go/api-reference/models/createobservabilitydestinationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Delete - -Delete an existing observability destination. This performs a soft delete. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="deleteObservabilityDestination" method="delete" path="/observability/destinations/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Observability.Delete(ctx, "99999999-aaaa-bbbb-cccc-dddddddddddd") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.DeleteObservabilityDestinationResponse](/client-sdks/go/api-reference/models/deleteobservabilitydestinationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Get - -Fetch a single observability destination by its UUID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getObservabilityDestination" method="get" path="/observability/destinations/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" - "github.com/OpenRouterTeam/go-sdk/models/components" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Observability.Get(ctx, "99999999-aaaa-bbbb-cccc-dddddddddddd") - if err != nil { - log.Fatal(err) - } - if res != nil { - switch res.Data.Type { - case components.ObservabilityDestinationTypeArize: - // res.Data.ObservabilityArizeDestination is populated - case components.ObservabilityDestinationTypeBraintrust: - // res.Data.ObservabilityBraintrustDestination is populated - case components.ObservabilityDestinationTypeClickhouse: - // res.Data.ObservabilityClickhouseDestination is populated - case components.ObservabilityDestinationTypeDatadog: - // res.Data.ObservabilityDatadogDestination is populated - case components.ObservabilityDestinationTypeGrafana: - // res.Data.ObservabilityGrafanaDestination is populated - case components.ObservabilityDestinationTypeLangfuse: - // res.Data.ObservabilityLangfuseDestination is populated - case components.ObservabilityDestinationTypeLangsmith: - // res.Data.ObservabilityLangsmithDestination is populated - case components.ObservabilityDestinationTypeNewrelic: - // res.Data.ObservabilityNewrelicDestination is populated - case components.ObservabilityDestinationTypeOpik: - // res.Data.ObservabilityOpikDestination is populated - case components.ObservabilityDestinationTypeOtelCollector: - // res.Data.ObservabilityOtelCollectorDestination is populated - case components.ObservabilityDestinationTypePosthog: - // res.Data.ObservabilityPosthogDestination is populated - case components.ObservabilityDestinationTypeRamp: - // res.Data.ObservabilityRampDestination is populated - case components.ObservabilityDestinationTypeS3: - // res.Data.ObservabilityS3Destination is populated - case components.ObservabilityDestinationTypeSentry: - // res.Data.ObservabilitySentryDestination is populated - case components.ObservabilityDestinationTypeSnowflake: - // res.Data.ObservabilitySnowflakeDestination is populated - case components.ObservabilityDestinationTypeWeave: - // res.Data.ObservabilityWeaveDestination is populated - case components.ObservabilityDestinationTypeWebhook: - // res.Data.ObservabilityWebhookDestination is populated - default: - // Unknown type - use res.Data.GetUnknownRaw() for raw JSON - } - - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GetObservabilityDestinationResponse](/client-sdks/go/api-reference/models/getobservabilitydestinationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Update - -Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="updateObservabilityDestination" method="patch" path="/observability/destinations/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Observability.Update(ctx, "99999999-aaaa-bbbb-cccc-dddddddddddd", components.UpdateObservabilityDestinationRequest{ - Enabled: openrouter.Pointer(false), - Name: openrouter.Pointer("Updated Langfuse"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - switch res.Data.Type { - case components.ObservabilityDestinationTypeArize: - // res.Data.ObservabilityArizeDestination is populated - case components.ObservabilityDestinationTypeBraintrust: - // res.Data.ObservabilityBraintrustDestination is populated - case components.ObservabilityDestinationTypeClickhouse: - // res.Data.ObservabilityClickhouseDestination is populated - case components.ObservabilityDestinationTypeDatadog: - // res.Data.ObservabilityDatadogDestination is populated - case components.ObservabilityDestinationTypeGrafana: - // res.Data.ObservabilityGrafanaDestination is populated - case components.ObservabilityDestinationTypeLangfuse: - // res.Data.ObservabilityLangfuseDestination is populated - case components.ObservabilityDestinationTypeLangsmith: - // res.Data.ObservabilityLangsmithDestination is populated - case components.ObservabilityDestinationTypeNewrelic: - // res.Data.ObservabilityNewrelicDestination is populated - case components.ObservabilityDestinationTypeOpik: - // res.Data.ObservabilityOpikDestination is populated - case components.ObservabilityDestinationTypeOtelCollector: - // res.Data.ObservabilityOtelCollectorDestination is populated - case components.ObservabilityDestinationTypePosthog: - // res.Data.ObservabilityPosthogDestination is populated - case components.ObservabilityDestinationTypeRamp: - // res.Data.ObservabilityRampDestination is populated - case components.ObservabilityDestinationTypeS3: - // res.Data.ObservabilityS3Destination is populated - case components.ObservabilityDestinationTypeSentry: - // res.Data.ObservabilitySentryDestination is populated - case components.ObservabilityDestinationTypeSnowflake: - // res.Data.ObservabilitySnowflakeDestination is populated - case components.ObservabilityDestinationTypeWeave: - // res.Data.ObservabilityWeaveDestination is populated - case components.ObservabilityDestinationTypeWebhook: - // res.Data.ObservabilityWebhookDestination is populated - default: - // Unknown type - use res.Data.GetUnknownRaw() for raw JSON - } - - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"enabled": false,"name": "Updated Langfuse"}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.UpdateObservabilityDestinationResponse](/client-sdks/go/api-reference/models/updateobservabilitydestinationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkaddworkspacemembersrequest.mdx b/client-sdks/go/api-reference/operations/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index 95916ad6..00000000 --- a/client-sdks/go/api-reference/operations/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - Go SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest type definition -seoTitle: BulkAddWorkspaceMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAddWorkspaceMembersRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20Go%20SDK&description=BulkAddWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](/client-sdks/go/api-reference/models/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkassignkeystoguardrailrequest.mdx b/client-sdks/go/api-reference/operations/bulkassignkeystoguardrailrequest.mdx deleted file mode 100644 index ae5d0a70..00000000 --- a/client-sdks/go/api-reference/operations/bulkassignkeystoguardrailrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequest - Go SDK -sidebarTitle: BulkAssignKeysToGuardrailRequest -description: BulkAssignKeysToGuardrailRequest type definition -seoTitle: BulkAssignKeysToGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkassignkeystoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAssignKeysToGuardrailRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequest%20-%20Go%20SDK&description=BulkAssignKeysToGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](/client-sdks/go/api-reference/models/bulkassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx b/client-sdks/go/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx deleted file mode 100644 index 8ee30034..00000000 --- a/client-sdks/go/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequest - Go SDK -sidebarTitle: BulkAssignMembersToGuardrailRequest -description: BulkAssignMembersToGuardrailRequest type definition -seoTitle: BulkAssignMembersToGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkassignmemberstoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - BulkAssignMembersToGuardrailRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequest%20-%20Go%20SDK&description=BulkAssignMembersToGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](/client-sdks/go/api-reference/models/bulkassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkremoveworkspacemembersrequest.mdx b/client-sdks/go/api-reference/operations/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index 0057cef4..00000000 --- a/client-sdks/go/api-reference/operations/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - Go SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest type definition -seoTitle: BulkRemoveWorkspaceMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest Type | OpenRouter Go SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20Go%20SDK&description=BulkRemoveWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](/client-sdks/go/api-reference/models/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx b/client-sdks/go/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx deleted file mode 100644 index d78fc5d4..00000000 --- a/client-sdks/go/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequest - Go SDK -sidebarTitle: BulkUnassignKeysFromGuardrailRequest -description: BulkUnassignKeysFromGuardrailRequest type definition -seoTitle: BulkUnassignKeysFromGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkunassignkeysfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequest%20-%20Go%20SDK&description=BulkUnassignKeysFromGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](/client-sdks/go/api-reference/models/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx b/client-sdks/go/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx deleted file mode 100644 index 336a2f8a..00000000 --- a/client-sdks/go/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequest - Go SDK -sidebarTitle: BulkUnassignMembersFromGuardrailRequest -description: BulkUnassignMembersFromGuardrailRequest type definition -seoTitle: BulkUnassignMembersFromGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/bulkunassignmembersfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequest%20-%20Go%20SDK&description=BulkUnassignMembersFromGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](/client-sdks/go/api-reference/models/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/category.mdx b/client-sdks/go/api-reference/operations/category.mdx deleted file mode 100644 index 1b5ffe20..00000000 --- a/client-sdks/go/api-reference/operations/category.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Category - Go SDK -sidebarTitle: Category -description: Category type definition -seoTitle: Category Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/category' -'og:site_name': OpenRouter Documentation -'og:title': Category Type | OpenRouter Go SDK -'og:description': >- - Category type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Category%20-%20Go%20SDK&description=Category%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Filter models by use case category - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.CategoryProgramming - -// Open enum: custom values can be created with a direct type cast -custom := operations.Category("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `CategoryProgramming` | programming | -| `CategoryRoleplay` | roleplay | -| `CategoryMarketing` | marketing | -| `CategoryMarketingSeo` | marketing/seo | -| `CategoryTechnology` | technology | -| `CategoryScience` | science | -| `CategoryTranslation` | translation | -| `CategoryLegal` | legal | -| `CategoryFinance` | finance | -| `CategoryHealth` | health | -| `CategoryTrivia` | trivia | -| `CategoryAcademia` | academia | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/content.mdx b/client-sdks/go/api-reference/operations/content.mdx deleted file mode 100644 index 47a6dacd..00000000 --- a/client-sdks/go/api-reference/operations/content.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: Content - Go SDK -sidebarTitle: Content -description: Content type definition -seoTitle: Content Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/content' -'og:site_name': OpenRouter Documentation -'og:title': Content Type | OpenRouter Go SDK -'og:description': >- - Content type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Content%20-%20Go%20SDK&description=Content%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ContentText - -```go lines -content := operations.CreateContentText(operations.ContentText{/* values here */}) -``` - -### ContentImageURL - -```go lines -content := operations.CreateContentImageURL(operations.ContentImageURL{/* values here */}) -``` - -### ContentPartInputAudio - -```go lines -content := operations.CreateContentInputAudio(components.ContentPartInputAudio{/* values here */}) -``` - -### ContentPartInputVideo - -```go lines -content := operations.CreateContentInputVideo(components.ContentPartInputVideo{/* values here */}) -``` - -### ContentPartInputFile - -```go lines -content := operations.CreateContentInputFile(components.ContentPartInputFile{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch content.Type { - case operations.ContentTypeText: - // content.ContentText is populated - case operations.ContentTypeImageURL: - // content.ContentImageURL is populated - case operations.ContentTypeInputAudio: - // content.ContentPartInputAudio is populated - case operations.ContentTypeInputVideo: - // content.ContentPartInputVideo is populated - case operations.ContentTypeInputFile: - // content.ContentPartInputFile is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/contentimageurl.mdx b/client-sdks/go/api-reference/operations/contentimageurl.mdx deleted file mode 100644 index a0bf1898..00000000 --- a/client-sdks/go/api-reference/operations/contentimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentImageURL - Go SDK -sidebarTitle: ContentImageURL -description: ContentImageURL type definition -seoTitle: ContentImageURL Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/contentimageurl' -'og:site_name': OpenRouter Documentation -'og:title': ContentImageURL Type | OpenRouter Go SDK -'og:description': >- - ContentImageURL type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentImageURL%20-%20Go%20SDK&description=ContentImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ImageURL` | [operations.ImageURL](/client-sdks/go/api-reference/operations/imageurl) | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeImageURL](/client-sdks/go/api-reference/operations/typeimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/contenttext.mdx b/client-sdks/go/api-reference/operations/contenttext.mdx deleted file mode 100644 index 0bfbbd6e..00000000 --- a/client-sdks/go/api-reference/operations/contenttext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentText - Go SDK -sidebarTitle: ContentText -description: ContentText type definition -seoTitle: ContentText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/contenttext' -'og:site_name': OpenRouter Documentation -'og:title': ContentText Type | OpenRouter Go SDK -'og:description': >- - ContentText type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentText%20-%20Go%20SDK&description=ContentText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeText](/client-sdks/go/api-reference/operations/typetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createauthkeyscodecodechallengemethod.mdx b/client-sdks/go/api-reference/operations/createauthkeyscodecodechallengemethod.mdx deleted file mode 100644 index 628ef031..00000000 --- a/client-sdks/go/api-reference/operations/createauthkeyscodecodechallengemethod.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateAuthKeysCodeCodeChallengeMethod - Go SDK -sidebarTitle: CreateAuthKeysCodeCodeChallengeMethod -description: CreateAuthKeysCodeCodeChallengeMethod type definition -seoTitle: CreateAuthKeysCodeCodeChallengeMethod Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createauthkeyscodecodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeCodeChallengeMethod Type | OpenRouter Go SDK -'og:description': >- - CreateAuthKeysCodeCodeChallengeMethod type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeCodeChallengeMethod%20-%20Go%20SDK&description=CreateAuthKeysCodeCodeChallengeMethod%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.CreateAuthKeysCodeCodeChallengeMethodS256 - -// Open enum: custom values can be created with a direct type cast -custom := operations.CreateAuthKeysCodeCodeChallengeMethod("custom_value") -``` - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `CreateAuthKeysCodeCodeChallengeMethodS256` | S256 | -| `CreateAuthKeysCodeCodeChallengeMethodPlain` | plain | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createauthkeyscodedata.mdx b/client-sdks/go/api-reference/operations/createauthkeyscodedata.mdx deleted file mode 100644 index 59dfb01c..00000000 --- a/client-sdks/go/api-reference/operations/createauthkeyscodedata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateAuthKeysCodeData - Go SDK -sidebarTitle: CreateAuthKeysCodeData -description: CreateAuthKeysCodeData type definition -seoTitle: CreateAuthKeysCodeData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createauthkeyscodedata -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeData Type | OpenRouter Go SDK -'og:description': >- - CreateAuthKeysCodeData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeData%20-%20Go%20SDK&description=CreateAuthKeysCodeData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Auth code data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `AppID` | `int64` | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `ID` | `string` | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createauthkeyscoderequest.mdx b/client-sdks/go/api-reference/operations/createauthkeyscoderequest.mdx deleted file mode 100644 index 0e21ccff..00000000 --- a/client-sdks/go/api-reference/operations/createauthkeyscoderequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateAuthKeysCodeRequest - Go SDK -sidebarTitle: CreateAuthKeysCodeRequest -description: CreateAuthKeysCodeRequest type definition -seoTitle: CreateAuthKeysCodeRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createauthkeyscoderequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequest Type | OpenRouter Go SDK -'og:description': >- - CreateAuthKeysCodeRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequest%20-%20Go%20SDK&description=CreateAuthKeysCodeRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `CallbackURL` | `string` | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `CodeChallenge` | `*string` | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/operations/usagelimittype) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createauthkeyscoderesponse.mdx b/client-sdks/go/api-reference/operations/createauthkeyscoderesponse.mdx deleted file mode 100644 index e1d855f2..00000000 --- a/client-sdks/go/api-reference/operations/createauthkeyscoderesponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeResponse - Go SDK -sidebarTitle: CreateAuthKeysCodeResponse -description: CreateAuthKeysCodeResponse type definition -seoTitle: CreateAuthKeysCodeResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createauthkeyscoderesponse -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeResponse Type | OpenRouter Go SDK -'og:description': >- - CreateAuthKeysCodeResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeResponse%20-%20Go%20SDK&description=CreateAuthKeysCodeResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Successfully created authorization code - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [operations.CreateAuthKeysCodeData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/createembeddingsdata.mdx b/client-sdks/go/api-reference/operations/createembeddingsdata.mdx deleted file mode 100644 index dd9748b6..00000000 --- a/client-sdks/go/api-reference/operations/createembeddingsdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateEmbeddingsData - Go SDK -sidebarTitle: CreateEmbeddingsData -description: CreateEmbeddingsData type definition -seoTitle: CreateEmbeddingsData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createembeddingsdata -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsData Type | OpenRouter Go SDK -'og:description': >- - CreateEmbeddingsData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsData%20-%20Go%20SDK&description=CreateEmbeddingsData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A single embedding object - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [operations.Embedding](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/operations/objectembedding) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createembeddingsrequest.mdx b/client-sdks/go/api-reference/operations/createembeddingsrequest.mdx deleted file mode 100644 index 15f01f0a..00000000 --- a/client-sdks/go/api-reference/operations/createembeddingsrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateEmbeddingsRequest - Go SDK -sidebarTitle: CreateEmbeddingsRequest -description: CreateEmbeddingsRequest type definition -seoTitle: CreateEmbeddingsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createembeddingsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequest Type | OpenRouter Go SDK -'og:description': >- - CreateEmbeddingsRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequest%20-%20Go%20SDK&description=CreateEmbeddingsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Embeddings request input - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Dimensions` | `*int64` | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `EncodingFormat` | [*operations.EncodingFormat](/client-sdks/go/api-reference/operations/encodingformat) | :heavy_minus_sign: | The format of the output embeddings | float | -| `Input` | [operations.InputUnion](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/createembeddingsresponse.mdx b/client-sdks/go/api-reference/operations/createembeddingsresponse.mdx deleted file mode 100644 index d15500f7..00000000 --- a/client-sdks/go/api-reference/operations/createembeddingsresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateEmbeddingsResponse - Go SDK -sidebarTitle: CreateEmbeddingsResponse -description: CreateEmbeddingsResponse type definition -seoTitle: CreateEmbeddingsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createembeddingsresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponse Type | OpenRouter Go SDK -'og:description': >- - CreateEmbeddingsResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponse%20-%20Go%20SDK&description=CreateEmbeddingsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### CreateEmbeddingsResponseBody - -```go lines -createEmbeddingsResponse := operations.CreateCreateEmbeddingsResponseCreateEmbeddingsResponseBody(operations.CreateEmbeddingsResponseBody{/* values here */}) -``` - -### - -```go lines -createEmbeddingsResponse := operations.CreateCreateEmbeddingsResponseStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch createEmbeddingsResponse.Type { - case operations.CreateEmbeddingsResponseTypeCreateEmbeddingsResponseBody: - // createEmbeddingsResponse.CreateEmbeddingsResponseBody is populated - case operations.CreateEmbeddingsResponseTypeStr: - // createEmbeddingsResponse.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createembeddingsresponsebody.mdx b/client-sdks/go/api-reference/operations/createembeddingsresponsebody.mdx deleted file mode 100644 index 39bfc2dd..00000000 --- a/client-sdks/go/api-reference/operations/createembeddingsresponsebody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateEmbeddingsResponseBody - Go SDK -sidebarTitle: CreateEmbeddingsResponseBody -description: CreateEmbeddingsResponseBody type definition -seoTitle: CreateEmbeddingsResponseBody Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createembeddingsresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponseBody Type | OpenRouter Go SDK -'og:description': >- - CreateEmbeddingsResponseBody type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponseBody%20-%20Go%20SDK&description=CreateEmbeddingsResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Embeddings response containing embedding vectors - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.CreateEmbeddingsData](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/operations/object) | :heavy_check_mark: | N/A | | -| `Usage` | [*operations.CreateEmbeddingsUsage](/client-sdks/go/api-reference/operations/createembeddingsusage) | :heavy_minus_sign: | Token usage statistics | `{"prompt_tokens": 8,"total_tokens": 8}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createembeddingsusage.mdx b/client-sdks/go/api-reference/operations/createembeddingsusage.mdx deleted file mode 100644 index 38bc8dcf..00000000 --- a/client-sdks/go/api-reference/operations/createembeddingsusage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CreateEmbeddingsUsage - Go SDK -sidebarTitle: CreateEmbeddingsUsage -description: CreateEmbeddingsUsage type definition -seoTitle: CreateEmbeddingsUsage Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createembeddingsusage -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsUsage Type | OpenRouter Go SDK -'og:description': >- - CreateEmbeddingsUsage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsUsage%20-%20Go%20SDK&description=CreateEmbeddingsUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the input | 8 | -| `PromptTokensDetails` | [*operations.PromptTokensDetails](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/createkeysdata.mdx b/client-sdks/go/api-reference/operations/createkeysdata.mdx deleted file mode 100644 index 13bf4c64..00000000 --- a/client-sdks/go/api-reference/operations/createkeysdata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateKeysData - Go SDK -sidebarTitle: CreateKeysData -description: CreateKeysData type definition -seoTitle: CreateKeysData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/createkeysdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysData Type | OpenRouter Go SDK -'og:description': >- - CreateKeysData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysData%20-%20Go%20SDK&description=CreateKeysData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The created API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ByokUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `ByokUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `ByokUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `ByokUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeByokInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `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 | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `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 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createkeyslimitreset.mdx b/client-sdks/go/api-reference/operations/createkeyslimitreset.mdx deleted file mode 100644 index 7186854c..00000000 --- a/client-sdks/go/api-reference/operations/createkeyslimitreset.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: CreateKeysLimitReset - Go SDK -sidebarTitle: CreateKeysLimitReset -description: CreateKeysLimitReset type definition -seoTitle: CreateKeysLimitReset Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createkeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysLimitReset Type | OpenRouter Go SDK -'og:description': >- - CreateKeysLimitReset type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysLimitReset%20-%20Go%20SDK&description=CreateKeysLimitReset%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.CreateKeysLimitResetDaily - -// Open enum: custom values can be created with a direct type cast -custom := operations.CreateKeysLimitReset("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `CreateKeysLimitResetDaily` | daily | -| `CreateKeysLimitResetWeekly` | weekly | -| `CreateKeysLimitResetMonthly` | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createkeysrequest.mdx b/client-sdks/go/api-reference/operations/createkeysrequest.mdx deleted file mode 100644 index 2c268036..00000000 --- a/client-sdks/go/api-reference/operations/createkeysrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CreateKeysRequest - Go SDK -sidebarTitle: CreateKeysRequest -description: CreateKeysRequest type definition -seoTitle: CreateKeysRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/createkeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequest Type | OpenRouter Go SDK -'og:description': >- - CreateKeysRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequest%20-%20Go%20SDK&description=CreateKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatorUserID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | 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](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/createkeysresponse.mdx b/client-sdks/go/api-reference/operations/createkeysresponse.mdx deleted file mode 100644 index e642e2cb..00000000 --- a/client-sdks/go/api-reference/operations/createkeysresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateKeysResponse - Go SDK -sidebarTitle: CreateKeysResponse -description: CreateKeysResponse type definition -seoTitle: CreateKeysResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/createkeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysResponse Type | OpenRouter Go SDK -'og:description': >- - CreateKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysResponse%20-%20Go%20SDK&description=CreateKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -API key created successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [operations.CreateKeysData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/createpresetschatcompletionsrequest.mdx b/client-sdks/go/api-reference/operations/createpresetschatcompletionsrequest.mdx deleted file mode 100644 index f01c8d5e..00000000 --- a/client-sdks/go/api-reference/operations/createpresetschatcompletionsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreatePresetsChatCompletionsRequest - Go SDK -sidebarTitle: CreatePresetsChatCompletionsRequest -description: CreatePresetsChatCompletionsRequest type definition -seoTitle: CreatePresetsChatCompletionsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createpresetschatcompletionsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsChatCompletionsRequest Type | OpenRouter Go SDK -'og:description': >- - CreatePresetsChatCompletionsRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsChatCompletionsRequest%20-%20Go%20SDK&description=CreatePresetsChatCompletionsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/createpresetsmessagesrequest.mdx b/client-sdks/go/api-reference/operations/createpresetsmessagesrequest.mdx deleted file mode 100644 index 06900060..00000000 --- a/client-sdks/go/api-reference/operations/createpresetsmessagesrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreatePresetsMessagesRequest - Go SDK -sidebarTitle: CreatePresetsMessagesRequest -description: CreatePresetsMessagesRequest type definition -seoTitle: CreatePresetsMessagesRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createpresetsmessagesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsMessagesRequest Type | OpenRouter Go SDK -'og:description': >- - CreatePresetsMessagesRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsMessagesRequest%20-%20Go%20SDK&description=CreatePresetsMessagesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/createpresetsresponsesrequest.mdx b/client-sdks/go/api-reference/operations/createpresetsresponsesrequest.mdx deleted file mode 100644 index 42c391af..00000000 --- a/client-sdks/go/api-reference/operations/createpresetsresponsesrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreatePresetsResponsesRequest - Go SDK -sidebarTitle: CreatePresetsResponsesRequest -description: CreatePresetsResponsesRequest type definition -seoTitle: CreatePresetsResponsesRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createpresetsresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsResponsesRequest Type | OpenRouter Go SDK -'og:description': >- - CreatePresetsResponsesRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsResponsesRequest%20-%20Go%20SDK&description=CreatePresetsResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/creatererankrequest.mdx b/client-sdks/go/api-reference/operations/creatererankrequest.mdx deleted file mode 100644 index 56cb80a1..00000000 --- a/client-sdks/go/api-reference/operations/creatererankrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateRerankRequest - Go SDK -sidebarTitle: CreateRerankRequest -description: CreateRerankRequest type definition -seoTitle: CreateRerankRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/creatererankrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankRequest Type | OpenRouter Go SDK -'og:description': >- - CreateRerankRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankRequest%20-%20Go%20SDK&description=CreateRerankRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Rerank request input - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `Documents` | []`string` | :heavy_check_mark: | The list of documents to rerank | [
"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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/creatererankresponse.mdx b/client-sdks/go/api-reference/operations/creatererankresponse.mdx deleted file mode 100644 index f0484a55..00000000 --- a/client-sdks/go/api-reference/operations/creatererankresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateRerankResponse - Go SDK -sidebarTitle: CreateRerankResponse -description: CreateRerankResponse type definition -seoTitle: CreateRerankResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/creatererankresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponse Type | OpenRouter Go SDK -'og:description': >- - CreateRerankResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponse%20-%20Go%20SDK&description=CreateRerankResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### CreateRerankResponseBody - -```go lines -createRerankResponse := operations.CreateCreateRerankResponseCreateRerankResponseBody(operations.CreateRerankResponseBody{/* values here */}) -``` - -### - -```go lines -createRerankResponse := operations.CreateCreateRerankResponseStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch createRerankResponse.Type { - case operations.CreateRerankResponseTypeCreateRerankResponseBody: - // createRerankResponse.CreateRerankResponseBody is populated - case operations.CreateRerankResponseTypeStr: - // createRerankResponse.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/creatererankresponsebody.mdx b/client-sdks/go/api-reference/operations/creatererankresponsebody.mdx deleted file mode 100644 index 5a0ce6b6..00000000 --- a/client-sdks/go/api-reference/operations/creatererankresponsebody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateRerankResponseBody - Go SDK -sidebarTitle: CreateRerankResponseBody -description: CreateRerankResponseBody type definition -seoTitle: CreateRerankResponseBody Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/creatererankresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponseBody Type | OpenRouter Go SDK -'og:description': >- - CreateRerankResponseBody type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponseBody%20-%20Go%20SDK&description=CreateRerankResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Rerank response containing ranked results - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `ID` | `*string` | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `Model` | `string` | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `Provider` | `*string` | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `Results` | [][operations.Result](/client-sdks/go/api-reference/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](/client-sdks/go/api-reference/operations/creatererankusage) | :heavy_minus_sign: | Usage statistics | `{"search_units": 1,"total_tokens": 150}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/creatererankusage.mdx b/client-sdks/go/api-reference/operations/creatererankusage.mdx deleted file mode 100644 index 7f2211d7..00000000 --- a/client-sdks/go/api-reference/operations/creatererankusage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateRerankUsage - Go SDK -sidebarTitle: CreateRerankUsage -description: CreateRerankUsage type definition -seoTitle: CreateRerankUsage Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/creatererankusage' -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankUsage Type | OpenRouter Go SDK -'og:description': >- - CreateRerankUsage type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankUsage%20-%20Go%20SDK&description=CreateRerankUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `SearchUnits` | `*int64` | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `TotalTokens` | `*int64` | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/createresponsesrequest.mdx b/client-sdks/go/api-reference/operations/createresponsesrequest.mdx deleted file mode 100644 index 6d678e42..00000000 --- a/client-sdks/go/api-reference/operations/createresponsesrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreateResponsesRequest - Go SDK -sidebarTitle: CreateResponsesRequest -description: CreateResponsesRequest type definition -seoTitle: CreateResponsesRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesRequest Type | OpenRouter Go SDK -'og:description': >- - CreateResponsesRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesRequest%20-%20Go%20SDK&description=CreateResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterExperimentalMetadata` | [*components.MetadataLevel](/client-sdks/go/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `ResponsesRequest` | [components.ResponsesRequest](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/createresponsesresponse.mdx b/client-sdks/go/api-reference/operations/createresponsesresponse.mdx deleted file mode 100644 index 91d5903e..00000000 --- a/client-sdks/go/api-reference/operations/createresponsesresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateResponsesResponse - Go SDK -sidebarTitle: CreateResponsesResponse -description: CreateResponsesResponse type definition -seoTitle: CreateResponsesResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/createresponsesresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponse Type | OpenRouter Go SDK -'og:description': >- - CreateResponsesResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponse%20-%20Go%20SDK&description=CreateResponsesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### OpenResponsesResult - -```go lines -createResponsesResponse := operations.CreateCreateResponsesResponseOpenResponsesResult(components.OpenResponsesResult{/* values here */}) -``` - -### - -```go lines -createResponsesResponse := operations.CreateCreateResponsesResponseEventStream(*stream.EventStream[components.ResponsesStreamingResponse]{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch createResponsesResponse.Type { - case operations.CreateResponsesResponseTypeOpenResponsesResult: - // createResponsesResponse.OpenResponsesResult is populated - case operations.CreateResponsesResponseTypeEventStream: - // createResponsesResponse.EventStream is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/datacenter.mdx b/client-sdks/go/api-reference/operations/datacenter.mdx deleted file mode 100644 index 2326da52..00000000 --- a/client-sdks/go/api-reference/operations/datacenter.mdx +++ /dev/null @@ -1,294 +0,0 @@ ---- -title: Datacenter - Go SDK -sidebarTitle: Datacenter -description: Datacenter type definition -seoTitle: Datacenter Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/datacenter' -'og:site_name': OpenRouter Documentation -'og:title': Datacenter Type | OpenRouter Go SDK -'og:description': >- - Datacenter type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datacenter%20-%20Go%20SDK&description=Datacenter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.DatacenterAd - -// Open enum: custom values can be created with a direct type cast -custom := operations.Datacenter("custom_value") -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `DatacenterAd` | AD | -| `DatacenterAe` | AE | -| `DatacenterAf` | AF | -| `DatacenterAg` | AG | -| `DatacenterAi` | AI | -| `DatacenterAl` | AL | -| `DatacenterAm` | AM | -| `DatacenterAo` | AO | -| `DatacenterAq` | AQ | -| `DatacenterAr` | AR | -| `DatacenterAs` | AS | -| `DatacenterAt` | AT | -| `DatacenterAu` | AU | -| `DatacenterAw` | AW | -| `DatacenterAx` | AX | -| `DatacenterAz` | AZ | -| `DatacenterBa` | BA | -| `DatacenterBb` | BB | -| `DatacenterBd` | BD | -| `DatacenterBe` | BE | -| `DatacenterBf` | BF | -| `DatacenterBg` | BG | -| `DatacenterBh` | BH | -| `DatacenterBi` | BI | -| `DatacenterBj` | BJ | -| `DatacenterBl` | BL | -| `DatacenterBm` | BM | -| `DatacenterBn` | BN | -| `DatacenterBo` | BO | -| `DatacenterBq` | BQ | -| `DatacenterBr` | BR | -| `DatacenterBs` | BS | -| `DatacenterBt` | BT | -| `DatacenterBv` | BV | -| `DatacenterBw` | BW | -| `DatacenterBy` | BY | -| `DatacenterBz` | BZ | -| `DatacenterCa` | CA | -| `DatacenterCc` | CC | -| `DatacenterCd` | CD | -| `DatacenterCf` | CF | -| `DatacenterCg` | CG | -| `DatacenterCh` | CH | -| `DatacenterCi` | CI | -| `DatacenterCk` | CK | -| `DatacenterCl` | CL | -| `DatacenterCm` | CM | -| `DatacenterCn` | CN | -| `DatacenterCo` | CO | -| `DatacenterCr` | CR | -| `DatacenterCu` | CU | -| `DatacenterCv` | CV | -| `DatacenterCw` | CW | -| `DatacenterCx` | CX | -| `DatacenterCy` | CY | -| `DatacenterCz` | CZ | -| `DatacenterDe` | DE | -| `DatacenterDj` | DJ | -| `DatacenterDk` | DK | -| `DatacenterDm` | DM | -| `DatacenterDo` | DO | -| `DatacenterDz` | DZ | -| `DatacenterEc` | EC | -| `DatacenterEe` | EE | -| `DatacenterEg` | EG | -| `DatacenterEh` | EH | -| `DatacenterEr` | ER | -| `DatacenterEs` | ES | -| `DatacenterEt` | ET | -| `DatacenterFi` | FI | -| `DatacenterFj` | FJ | -| `DatacenterFk` | FK | -| `DatacenterFm` | FM | -| `DatacenterFo` | FO | -| `DatacenterFr` | FR | -| `DatacenterGa` | GA | -| `DatacenterGb` | GB | -| `DatacenterGd` | GD | -| `DatacenterGe` | GE | -| `DatacenterGf` | GF | -| `DatacenterGg` | GG | -| `DatacenterGh` | GH | -| `DatacenterGi` | GI | -| `DatacenterGl` | GL | -| `DatacenterGm` | GM | -| `DatacenterGn` | GN | -| `DatacenterGp` | GP | -| `DatacenterGq` | GQ | -| `DatacenterGr` | GR | -| `DatacenterGs` | GS | -| `DatacenterGt` | GT | -| `DatacenterGu` | GU | -| `DatacenterGw` | GW | -| `DatacenterGy` | GY | -| `DatacenterHk` | HK | -| `DatacenterHm` | HM | -| `DatacenterHn` | HN | -| `DatacenterHr` | HR | -| `DatacenterHt` | HT | -| `DatacenterHu` | HU | -| `DatacenterID` | ID | -| `DatacenterIe` | IE | -| `DatacenterIl` | IL | -| `DatacenterIm` | IM | -| `DatacenterIn` | IN | -| `DatacenterIo` | IO | -| `DatacenterIq` | IQ | -| `DatacenterIr` | IR | -| `DatacenterIs` | IS | -| `DatacenterIt` | IT | -| `DatacenterJe` | JE | -| `DatacenterJm` | JM | -| `DatacenterJo` | JO | -| `DatacenterJp` | JP | -| `DatacenterKe` | KE | -| `DatacenterKg` | KG | -| `DatacenterKh` | KH | -| `DatacenterKi` | KI | -| `DatacenterKm` | KM | -| `DatacenterKn` | KN | -| `DatacenterKp` | KP | -| `DatacenterKr` | KR | -| `DatacenterKw` | KW | -| `DatacenterKy` | KY | -| `DatacenterKz` | KZ | -| `DatacenterLa` | LA | -| `DatacenterLb` | LB | -| `DatacenterLc` | LC | -| `DatacenterLi` | LI | -| `DatacenterLk` | LK | -| `DatacenterLr` | LR | -| `DatacenterLs` | LS | -| `DatacenterLt` | LT | -| `DatacenterLu` | LU | -| `DatacenterLv` | LV | -| `DatacenterLy` | LY | -| `DatacenterMa` | MA | -| `DatacenterMc` | MC | -| `DatacenterMd` | MD | -| `DatacenterMe` | ME | -| `DatacenterMf` | MF | -| `DatacenterMg` | MG | -| `DatacenterMh` | MH | -| `DatacenterMk` | MK | -| `DatacenterMl` | ML | -| `DatacenterMm` | MM | -| `DatacenterMn` | MN | -| `DatacenterMo` | MO | -| `DatacenterMp` | MP | -| `DatacenterMq` | MQ | -| `DatacenterMr` | MR | -| `DatacenterMs` | MS | -| `DatacenterMt` | MT | -| `DatacenterMu` | MU | -| `DatacenterMv` | MV | -| `DatacenterMw` | MW | -| `DatacenterMx` | MX | -| `DatacenterMy` | MY | -| `DatacenterMz` | MZ | -| `DatacenterNa` | NA | -| `DatacenterNc` | NC | -| `DatacenterNe` | NE | -| `DatacenterNf` | NF | -| `DatacenterNg` | NG | -| `DatacenterNi` | NI | -| `DatacenterNl` | NL | -| `DatacenterNo` | NO | -| `DatacenterNp` | NP | -| `DatacenterNr` | NR | -| `DatacenterNu` | NU | -| `DatacenterNz` | NZ | -| `DatacenterOm` | OM | -| `DatacenterPa` | PA | -| `DatacenterPe` | PE | -| `DatacenterPf` | PF | -| `DatacenterPg` | PG | -| `DatacenterPh` | PH | -| `DatacenterPk` | PK | -| `DatacenterPl` | PL | -| `DatacenterPm` | PM | -| `DatacenterPn` | PN | -| `DatacenterPr` | PR | -| `DatacenterPs` | PS | -| `DatacenterPt` | PT | -| `DatacenterPw` | PW | -| `DatacenterPy` | PY | -| `DatacenterQa` | QA | -| `DatacenterRe` | RE | -| `DatacenterRo` | RO | -| `DatacenterRs` | RS | -| `DatacenterRu` | RU | -| `DatacenterRw` | RW | -| `DatacenterSa` | SA | -| `DatacenterSb` | SB | -| `DatacenterSc` | SC | -| `DatacenterSd` | SD | -| `DatacenterSe` | SE | -| `DatacenterSg` | SG | -| `DatacenterSh` | SH | -| `DatacenterSi` | SI | -| `DatacenterSj` | SJ | -| `DatacenterSk` | SK | -| `DatacenterSl` | SL | -| `DatacenterSm` | SM | -| `DatacenterSn` | SN | -| `DatacenterSo` | SO | -| `DatacenterSr` | SR | -| `DatacenterSs` | SS | -| `DatacenterSt` | ST | -| `DatacenterSv` | SV | -| `DatacenterSx` | SX | -| `DatacenterSy` | SY | -| `DatacenterSz` | SZ | -| `DatacenterTc` | TC | -| `DatacenterTd` | TD | -| `DatacenterTf` | TF | -| `DatacenterTg` | TG | -| `DatacenterTh` | TH | -| `DatacenterTj` | TJ | -| `DatacenterTk` | TK | -| `DatacenterTl` | TL | -| `DatacenterTm` | TM | -| `DatacenterTn` | TN | -| `DatacenterTo` | TO | -| `DatacenterTr` | TR | -| `DatacenterTt` | TT | -| `DatacenterTv` | TV | -| `DatacenterTw` | TW | -| `DatacenterTz` | TZ | -| `DatacenterUa` | UA | -| `DatacenterUg` | UG | -| `DatacenterUm` | UM | -| `DatacenterUs` | US | -| `DatacenterUy` | UY | -| `DatacenterUz` | UZ | -| `DatacenterVa` | VA | -| `DatacenterVc` | VC | -| `DatacenterVe` | VE | -| `DatacenterVg` | VG | -| `DatacenterVi` | VI | -| `DatacenterVn` | VN | -| `DatacenterVu` | VU | -| `DatacenterWf` | WF | -| `DatacenterWs` | WS | -| `DatacenterYe` | YE | -| `DatacenterYt` | YT | -| `DatacenterZa` | ZA | -| `DatacenterZm` | ZM | -| `DatacenterZw` | ZW | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deletebyokkeyrequest.mdx b/client-sdks/go/api-reference/operations/deletebyokkeyrequest.mdx deleted file mode 100644 index f9899dd4..00000000 --- a/client-sdks/go/api-reference/operations/deletebyokkeyrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteBYOKKeyRequest - Go SDK -sidebarTitle: DeleteBYOKKeyRequest -description: DeleteBYOKKeyRequest type definition -seoTitle: DeleteBYOKKeyRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/deletebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyRequest Type | OpenRouter Go SDK -'og:description': >- - DeleteBYOKKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyRequest%20-%20Go%20SDK&description=DeleteBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deleteguardrailrequest.mdx b/client-sdks/go/api-reference/operations/deleteguardrailrequest.mdx deleted file mode 100644 index 71734486..00000000 --- a/client-sdks/go/api-reference/operations/deleteguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteGuardrailRequest - Go SDK -sidebarTitle: DeleteGuardrailRequest -description: DeleteGuardrailRequest type definition -seoTitle: DeleteGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/deleteguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - DeleteGuardrailRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailRequest%20-%20Go%20SDK&description=DeleteGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deletekeysrequest.mdx b/client-sdks/go/api-reference/operations/deletekeysrequest.mdx deleted file mode 100644 index 0ea4d720..00000000 --- a/client-sdks/go/api-reference/operations/deletekeysrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: DeleteKeysRequest - Go SDK -sidebarTitle: DeleteKeysRequest -description: DeleteKeysRequest type definition -seoTitle: DeleteKeysRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/deletekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysRequest Type | OpenRouter Go SDK -'og:description': >- - DeleteKeysRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysRequest%20-%20Go%20SDK&description=DeleteKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deletekeysresponse.mdx b/client-sdks/go/api-reference/operations/deletekeysresponse.mdx deleted file mode 100644 index c44f7f3d..00000000 --- a/client-sdks/go/api-reference/operations/deletekeysresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: DeleteKeysResponse - Go SDK -sidebarTitle: DeleteKeysResponse -description: DeleteKeysResponse type definition -seoTitle: DeleteKeysResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/deletekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysResponse Type | OpenRouter Go SDK -'og:description': >- - DeleteKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysResponse%20-%20Go%20SDK&description=DeleteKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -API key deleted successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `Deleted` | `bool` | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deleteobservabilitydestinationrequest.mdx b/client-sdks/go/api-reference/operations/deleteobservabilitydestinationrequest.mdx deleted file mode 100644 index d8a41c61..00000000 --- a/client-sdks/go/api-reference/operations/deleteobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteObservabilityDestinationRequest - Go SDK -sidebarTitle: DeleteObservabilityDestinationRequest -description: DeleteObservabilityDestinationRequest type definition -seoTitle: DeleteObservabilityDestinationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/deleteobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationRequest Type | OpenRouter Go SDK -'og:description': >- - DeleteObservabilityDestinationRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationRequest%20-%20Go%20SDK&description=DeleteObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/deleteworkspacerequest.mdx b/client-sdks/go/api-reference/operations/deleteworkspacerequest.mdx deleted file mode 100644 index c6ddd676..00000000 --- a/client-sdks/go/api-reference/operations/deleteworkspacerequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteWorkspaceRequest - Go SDK -sidebarTitle: DeleteWorkspaceRequest -description: DeleteWorkspaceRequest type definition -seoTitle: DeleteWorkspaceRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/deleteworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceRequest Type | OpenRouter Go SDK -'og:description': >- - DeleteWorkspaceRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceRequest%20-%20Go%20SDK&description=DeleteWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/document.mdx b/client-sdks/go/api-reference/operations/document.mdx deleted file mode 100644 index 76dd0837..00000000 --- a/client-sdks/go/api-reference/operations/document.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Document - Go SDK -sidebarTitle: Document -description: Document type definition -seoTitle: Document Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/document' -'og:site_name': OpenRouter Documentation -'og:title': Document Type | OpenRouter Go SDK -'og:description': >- - Document type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Document%20-%20Go%20SDK&description=Document%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The document object containing the original text - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `Text` | `string` | :heavy_check_mark: | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/embedding.mdx b/client-sdks/go/api-reference/operations/embedding.mdx deleted file mode 100644 index 1bc48901..00000000 --- a/client-sdks/go/api-reference/operations/embedding.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Embedding - Go SDK -sidebarTitle: Embedding -description: Embedding type definition -seoTitle: Embedding Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/embedding' -'og:site_name': OpenRouter Documentation -'og:title': Embedding Type | OpenRouter Go SDK -'og:description': >- - Embedding type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embedding%20-%20Go%20SDK&description=Embedding%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Embedding vector as an array of floats or a base64 string - -## Supported Types - -### - -```go lines -embedding := operations.CreateEmbeddingArrayOfNumber([]float64{/* values here */}) -``` - -### - -```go lines -embedding := operations.CreateEmbeddingStr(string{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch embedding.Type { - case operations.EmbeddingTypeArrayOfNumber: - // embedding.ArrayOfNumber is populated - case operations.EmbeddingTypeStr: - // embedding.Str is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/encodingformat.mdx b/client-sdks/go/api-reference/operations/encodingformat.mdx deleted file mode 100644 index 9d12d430..00000000 --- a/client-sdks/go/api-reference/operations/encodingformat.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: EncodingFormat - Go SDK -sidebarTitle: EncodingFormat -description: EncodingFormat type definition -seoTitle: EncodingFormat Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/encodingformat' -'og:site_name': OpenRouter Documentation -'og:title': EncodingFormat Type | OpenRouter Go SDK -'og:description': >- - EncodingFormat type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EncodingFormat%20-%20Go%20SDK&description=EncodingFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The format of the output embeddings - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.EncodingFormatFloat - -// Open enum: custom values can be created with a direct type cast -custom := operations.EncodingFormat("custom_value") -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `EncodingFormatFloat` | float | -| `EncodingFormatBase64` | base64 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx b/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx deleted file mode 100644 index 8b616ce6..00000000 --- a/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyCodeChallengeMethod - Go SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod -description: ExchangeAuthCodeForAPIKeyCodeChallengeMethod type definition -seoTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyCodeChallengeMethod Type | OpenRouter Go SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyCodeChallengeMethod type reference for the OpenRouter - Go SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20-%20Go%20SDK&description=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethodS256 - -// Open enum: custom values can be created with a direct type cast -custom := operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod("custom_value") -``` - -## Values - -| Name | Value | -| --------------------------------------------------- | --------------------------------------------------- | -| `ExchangeAuthCodeForAPIKeyCodeChallengeMethodS256` | S256 | -| `ExchangeAuthCodeForAPIKeyCodeChallengeMethodPlain` | plain | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx b/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx deleted file mode 100644 index cb2d5c01..00000000 --- a/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequest - Go SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyRequest -description: ExchangeAuthCodeForAPIKeyRequest type definition -seoTitle: ExchangeAuthCodeForAPIKeyRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/exchangeauthcodeforapikeyrequest -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequest Type | OpenRouter Go SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequest%20-%20Go%20SDK&description=ExchangeAuthCodeForAPIKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx b/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx deleted file mode 100644 index dcef7f32..00000000 --- a/client-sdks/go/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyResponse - Go SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyResponse -description: ExchangeAuthCodeForAPIKeyResponse type definition -seoTitle: ExchangeAuthCodeForAPIKeyResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/exchangeauthcodeforapikeyresponse -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyResponse Type | OpenRouter Go SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyResponse%20-%20Go%20SDK&description=ExchangeAuthCodeForAPIKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Successfully exchanged code for an API key - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Key` | `string` | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `UserID` | `*string` | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getbyokkeyrequest.mdx b/client-sdks/go/api-reference/operations/getbyokkeyrequest.mdx deleted file mode 100644 index d7c4ad1f..00000000 --- a/client-sdks/go/api-reference/operations/getbyokkeyrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetBYOKKeyRequest - Go SDK -sidebarTitle: GetBYOKKeyRequest -description: GetBYOKKeyRequest type definition -seoTitle: GetBYOKKeyRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getbyokkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyRequest Type | OpenRouter Go SDK -'og:description': >- - GetBYOKKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyRequest%20-%20Go%20SDK&description=GetBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getcreditsdata.mdx b/client-sdks/go/api-reference/operations/getcreditsdata.mdx deleted file mode 100644 index 54dc16e4..00000000 --- a/client-sdks/go/api-reference/operations/getcreditsdata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetCreditsData - Go SDK -sidebarTitle: GetCreditsData -description: GetCreditsData type definition -seoTitle: GetCreditsData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getcreditsdata' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsData Type | OpenRouter Go SDK -'og:description': >- - GetCreditsData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsData%20-%20Go%20SDK&description=GetCreditsData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `TotalCredits` | `float64` | :heavy_check_mark: | Total credits purchased | 100.5 | -| `TotalUsage` | `float64` | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getcreditsresponse.mdx b/client-sdks/go/api-reference/operations/getcreditsresponse.mdx deleted file mode 100644 index fd3c3bb1..00000000 --- a/client-sdks/go/api-reference/operations/getcreditsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetCreditsResponse - Go SDK -sidebarTitle: GetCreditsResponse -description: GetCreditsResponse type definition -seoTitle: GetCreditsResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getcreditsresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsResponse Type | OpenRouter Go SDK -'og:description': >- - GetCreditsResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsResponse%20-%20Go%20SDK&description=GetCreditsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Total credits purchased and used - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [operations.GetCreditsData](/client-sdks/go/api-reference/operations/getcreditsdata) | :heavy_check_mark: | N/A | `{"total_credits": 100.5,"total_usage": 25.75}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getcurrentkeydata.mdx b/client-sdks/go/api-reference/operations/getcurrentkeydata.mdx deleted file mode 100644 index a9eb3415..00000000 --- a/client-sdks/go/api-reference/operations/getcurrentkeydata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: GetCurrentKeyData - Go SDK -sidebarTitle: GetCurrentKeyData -description: GetCurrentKeyData type definition -seoTitle: GetCurrentKeyData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getcurrentkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyData Type | OpenRouter Go SDK -'og:description': >- - GetCurrentKeyData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyData%20-%20Go%20SDK&description=GetCurrentKeyData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Current API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ByokUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `ByokUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `ByokUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `ByokUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `IncludeByokInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `IsFreeTier` | `bool` | :heavy_check_mark: | Whether this is a free tier API key | false | -| `IsManagementKey` | `bool` | :heavy_check_mark: | Whether this is a management key | false | -| ~~`IsProvisioningKey`~~ | `bool` | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `Limit` | `*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](/client-sdks/go/api-reference/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 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getcurrentkeyresponse.mdx b/client-sdks/go/api-reference/operations/getcurrentkeyresponse.mdx deleted file mode 100644 index d178453e..00000000 --- a/client-sdks/go/api-reference/operations/getcurrentkeyresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCurrentKeyResponse - Go SDK -sidebarTitle: GetCurrentKeyResponse -description: GetCurrentKeyResponse type definition -seoTitle: GetCurrentKeyResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getcurrentkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyResponse Type | OpenRouter Go SDK -'og:description': >- - GetCurrentKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyResponse%20-%20Go%20SDK&description=GetCurrentKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [operations.GetCurrentKeyData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/getgenerationrequest.mdx b/client-sdks/go/api-reference/operations/getgenerationrequest.mdx deleted file mode 100644 index 44d1899d..00000000 --- a/client-sdks/go/api-reference/operations/getgenerationrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetGenerationRequest - Go SDK -sidebarTitle: GetGenerationRequest -description: GetGenerationRequest type definition -seoTitle: GetGenerationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getgenerationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationRequest Type | OpenRouter Go SDK -'og:description': >- - GetGenerationRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationRequest%20-%20Go%20SDK&description=GetGenerationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getguardrailrequest.mdx b/client-sdks/go/api-reference/operations/getguardrailrequest.mdx deleted file mode 100644 index f4d24dbe..00000000 --- a/client-sdks/go/api-reference/operations/getguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetGuardrailRequest - Go SDK -sidebarTitle: GetGuardrailRequest -description: GetGuardrailRequest type definition -seoTitle: GetGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - GetGuardrailRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailRequest%20-%20Go%20SDK&description=GetGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getkeydata.mdx b/client-sdks/go/api-reference/operations/getkeydata.mdx deleted file mode 100644 index 4fc323a1..00000000 --- a/client-sdks/go/api-reference/operations/getkeydata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: GetKeyData - Go SDK -sidebarTitle: GetKeyData -description: GetKeyData type definition -seoTitle: GetKeyData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyData Type | OpenRouter Go SDK -'og:description': >- - GetKeyData type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyData%20-%20Go%20SDK&description=GetKeyData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ByokUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `ByokUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `ByokUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `ByokUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeByokInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `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 | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `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 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getkeyrequest.mdx b/client-sdks/go/api-reference/operations/getkeyrequest.mdx deleted file mode 100644 index 0a43a455..00000000 --- a/client-sdks/go/api-reference/operations/getkeyrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetKeyRequest - Go SDK -sidebarTitle: GetKeyRequest -description: GetKeyRequest type definition -seoTitle: GetKeyRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyRequest Type | OpenRouter Go SDK -'og:description': >- - GetKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyRequest%20-%20Go%20SDK&description=GetKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getkeyresponse.mdx b/client-sdks/go/api-reference/operations/getkeyresponse.mdx deleted file mode 100644 index 1eb4aa8f..00000000 --- a/client-sdks/go/api-reference/operations/getkeyresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetKeyResponse - Go SDK -sidebarTitle: GetKeyResponse -description: GetKeyResponse type definition -seoTitle: GetKeyResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyResponse Type | OpenRouter Go SDK -'og:description': >- - GetKeyResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyResponse%20-%20Go%20SDK&description=GetKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [operations.GetKeyData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/getmodelsrequest.mdx b/client-sdks/go/api-reference/operations/getmodelsrequest.mdx deleted file mode 100644 index 59b45c4e..00000000 --- a/client-sdks/go/api-reference/operations/getmodelsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetModelsRequest - Go SDK -sidebarTitle: GetModelsRequest -description: GetModelsRequest type definition -seoTitle: GetModelsRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getmodelsrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetModelsRequest Type | OpenRouter Go SDK -'og:description': >- - GetModelsRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsRequest%20-%20Go%20SDK&description=GetModelsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Category` | [*operations.Category](/client-sdks/go/api-reference/operations/category) | :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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getobservabilitydestinationrequest.mdx b/client-sdks/go/api-reference/operations/getobservabilitydestinationrequest.mdx deleted file mode 100644 index 599e9923..00000000 --- a/client-sdks/go/api-reference/operations/getobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetObservabilityDestinationRequest - Go SDK -sidebarTitle: GetObservabilityDestinationRequest -description: GetObservabilityDestinationRequest type definition -seoTitle: GetObservabilityDestinationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationRequest Type | OpenRouter Go SDK -'og:description': >- - GetObservabilityDestinationRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationRequest%20-%20Go%20SDK&description=GetObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getrankingsdailyrequest.mdx b/client-sdks/go/api-reference/operations/getrankingsdailyrequest.mdx deleted file mode 100644 index 56872c6b..00000000 --- a/client-sdks/go/api-reference/operations/getrankingsdailyrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetRankingsDailyRequest - Go SDK -sidebarTitle: GetRankingsDailyRequest -description: GetRankingsDailyRequest type definition -seoTitle: GetRankingsDailyRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getrankingsdailyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetRankingsDailyRequest Type | OpenRouter Go SDK -'og:description': >- - GetRankingsDailyRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetRankingsDailyRequest%20-%20Go%20SDK&description=GetRankingsDailyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getuseractivityrequest.mdx b/client-sdks/go/api-reference/operations/getuseractivityrequest.mdx deleted file mode 100644 index 4c191e29..00000000 --- a/client-sdks/go/api-reference/operations/getuseractivityrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetUserActivityRequest - Go SDK -sidebarTitle: GetUserActivityRequest -description: GetUserActivityRequest type definition -seoTitle: GetUserActivityRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getuseractivityrequest -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityRequest Type | OpenRouter Go SDK -'og:description': >- - GetUserActivityRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityRequest%20-%20Go%20SDK&description=GetUserActivityRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getvideosrequest.mdx b/client-sdks/go/api-reference/operations/getvideosrequest.mdx deleted file mode 100644 index 0201961e..00000000 --- a/client-sdks/go/api-reference/operations/getvideosrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetVideosRequest - Go SDK -sidebarTitle: GetVideosRequest -description: GetVideosRequest type definition -seoTitle: GetVideosRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/getvideosrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetVideosRequest Type | OpenRouter Go SDK -'og:description': >- - GetVideosRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetVideosRequest%20-%20Go%20SDK&description=GetVideosRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/getworkspacerequest.mdx b/client-sdks/go/api-reference/operations/getworkspacerequest.mdx deleted file mode 100644 index 8032dca9..00000000 --- a/client-sdks/go/api-reference/operations/getworkspacerequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetWorkspaceRequest - Go SDK -sidebarTitle: GetWorkspaceRequest -description: GetWorkspaceRequest type definition -seoTitle: GetWorkspaceRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/getworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceRequest Type | OpenRouter Go SDK -'og:description': >- - GetWorkspaceRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceRequest%20-%20Go%20SDK&description=GetWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/headquarters.mdx b/client-sdks/go/api-reference/operations/headquarters.mdx deleted file mode 100644 index dcc297dd..00000000 --- a/client-sdks/go/api-reference/operations/headquarters.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -title: Headquarters - Go SDK -sidebarTitle: Headquarters -description: Headquarters type definition -seoTitle: Headquarters Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/headquarters' -'og:site_name': OpenRouter Documentation -'og:title': Headquarters Type | OpenRouter Go SDK -'og:description': >- - Headquarters type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Headquarters%20-%20Go%20SDK&description=Headquarters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -ISO 3166-1 Alpha-2 country code of the provider headquarters - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.HeadquartersAd - -// Open enum: custom values can be created with a direct type cast -custom := operations.Headquarters("custom_value") -``` - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `HeadquartersAd` | AD | -| `HeadquartersAe` | AE | -| `HeadquartersAf` | AF | -| `HeadquartersAg` | AG | -| `HeadquartersAi` | AI | -| `HeadquartersAl` | AL | -| `HeadquartersAm` | AM | -| `HeadquartersAo` | AO | -| `HeadquartersAq` | AQ | -| `HeadquartersAr` | AR | -| `HeadquartersAs` | AS | -| `HeadquartersAt` | AT | -| `HeadquartersAu` | AU | -| `HeadquartersAw` | AW | -| `HeadquartersAx` | AX | -| `HeadquartersAz` | AZ | -| `HeadquartersBa` | BA | -| `HeadquartersBb` | BB | -| `HeadquartersBd` | BD | -| `HeadquartersBe` | BE | -| `HeadquartersBf` | BF | -| `HeadquartersBg` | BG | -| `HeadquartersBh` | BH | -| `HeadquartersBi` | BI | -| `HeadquartersBj` | BJ | -| `HeadquartersBl` | BL | -| `HeadquartersBm` | BM | -| `HeadquartersBn` | BN | -| `HeadquartersBo` | BO | -| `HeadquartersBq` | BQ | -| `HeadquartersBr` | BR | -| `HeadquartersBs` | BS | -| `HeadquartersBt` | BT | -| `HeadquartersBv` | BV | -| `HeadquartersBw` | BW | -| `HeadquartersBy` | BY | -| `HeadquartersBz` | BZ | -| `HeadquartersCa` | CA | -| `HeadquartersCc` | CC | -| `HeadquartersCd` | CD | -| `HeadquartersCf` | CF | -| `HeadquartersCg` | CG | -| `HeadquartersCh` | CH | -| `HeadquartersCi` | CI | -| `HeadquartersCk` | CK | -| `HeadquartersCl` | CL | -| `HeadquartersCm` | CM | -| `HeadquartersCn` | CN | -| `HeadquartersCo` | CO | -| `HeadquartersCr` | CR | -| `HeadquartersCu` | CU | -| `HeadquartersCv` | CV | -| `HeadquartersCw` | CW | -| `HeadquartersCx` | CX | -| `HeadquartersCy` | CY | -| `HeadquartersCz` | CZ | -| `HeadquartersDe` | DE | -| `HeadquartersDj` | DJ | -| `HeadquartersDk` | DK | -| `HeadquartersDm` | DM | -| `HeadquartersDo` | DO | -| `HeadquartersDz` | DZ | -| `HeadquartersEc` | EC | -| `HeadquartersEe` | EE | -| `HeadquartersEg` | EG | -| `HeadquartersEh` | EH | -| `HeadquartersEr` | ER | -| `HeadquartersEs` | ES | -| `HeadquartersEt` | ET | -| `HeadquartersFi` | FI | -| `HeadquartersFj` | FJ | -| `HeadquartersFk` | FK | -| `HeadquartersFm` | FM | -| `HeadquartersFo` | FO | -| `HeadquartersFr` | FR | -| `HeadquartersGa` | GA | -| `HeadquartersGb` | GB | -| `HeadquartersGd` | GD | -| `HeadquartersGe` | GE | -| `HeadquartersGf` | GF | -| `HeadquartersGg` | GG | -| `HeadquartersGh` | GH | -| `HeadquartersGi` | GI | -| `HeadquartersGl` | GL | -| `HeadquartersGm` | GM | -| `HeadquartersGn` | GN | -| `HeadquartersGp` | GP | -| `HeadquartersGq` | GQ | -| `HeadquartersGr` | GR | -| `HeadquartersGs` | GS | -| `HeadquartersGt` | GT | -| `HeadquartersGu` | GU | -| `HeadquartersGw` | GW | -| `HeadquartersGy` | GY | -| `HeadquartersHk` | HK | -| `HeadquartersHm` | HM | -| `HeadquartersHn` | HN | -| `HeadquartersHr` | HR | -| `HeadquartersHt` | HT | -| `HeadquartersHu` | HU | -| `HeadquartersID` | ID | -| `HeadquartersIe` | IE | -| `HeadquartersIl` | IL | -| `HeadquartersIm` | IM | -| `HeadquartersIn` | IN | -| `HeadquartersIo` | IO | -| `HeadquartersIq` | IQ | -| `HeadquartersIr` | IR | -| `HeadquartersIs` | IS | -| `HeadquartersIt` | IT | -| `HeadquartersJe` | JE | -| `HeadquartersJm` | JM | -| `HeadquartersJo` | JO | -| `HeadquartersJp` | JP | -| `HeadquartersKe` | KE | -| `HeadquartersKg` | KG | -| `HeadquartersKh` | KH | -| `HeadquartersKi` | KI | -| `HeadquartersKm` | KM | -| `HeadquartersKn` | KN | -| `HeadquartersKp` | KP | -| `HeadquartersKr` | KR | -| `HeadquartersKw` | KW | -| `HeadquartersKy` | KY | -| `HeadquartersKz` | KZ | -| `HeadquartersLa` | LA | -| `HeadquartersLb` | LB | -| `HeadquartersLc` | LC | -| `HeadquartersLi` | LI | -| `HeadquartersLk` | LK | -| `HeadquartersLr` | LR | -| `HeadquartersLs` | LS | -| `HeadquartersLt` | LT | -| `HeadquartersLu` | LU | -| `HeadquartersLv` | LV | -| `HeadquartersLy` | LY | -| `HeadquartersMa` | MA | -| `HeadquartersMc` | MC | -| `HeadquartersMd` | MD | -| `HeadquartersMe` | ME | -| `HeadquartersMf` | MF | -| `HeadquartersMg` | MG | -| `HeadquartersMh` | MH | -| `HeadquartersMk` | MK | -| `HeadquartersMl` | ML | -| `HeadquartersMm` | MM | -| `HeadquartersMn` | MN | -| `HeadquartersMo` | MO | -| `HeadquartersMp` | MP | -| `HeadquartersMq` | MQ | -| `HeadquartersMr` | MR | -| `HeadquartersMs` | MS | -| `HeadquartersMt` | MT | -| `HeadquartersMu` | MU | -| `HeadquartersMv` | MV | -| `HeadquartersMw` | MW | -| `HeadquartersMx` | MX | -| `HeadquartersMy` | MY | -| `HeadquartersMz` | MZ | -| `HeadquartersNa` | NA | -| `HeadquartersNc` | NC | -| `HeadquartersNe` | NE | -| `HeadquartersNf` | NF | -| `HeadquartersNg` | NG | -| `HeadquartersNi` | NI | -| `HeadquartersNl` | NL | -| `HeadquartersNo` | NO | -| `HeadquartersNp` | NP | -| `HeadquartersNr` | NR | -| `HeadquartersNu` | NU | -| `HeadquartersNz` | NZ | -| `HeadquartersOm` | OM | -| `HeadquartersPa` | PA | -| `HeadquartersPe` | PE | -| `HeadquartersPf` | PF | -| `HeadquartersPg` | PG | -| `HeadquartersPh` | PH | -| `HeadquartersPk` | PK | -| `HeadquartersPl` | PL | -| `HeadquartersPm` | PM | -| `HeadquartersPn` | PN | -| `HeadquartersPr` | PR | -| `HeadquartersPs` | PS | -| `HeadquartersPt` | PT | -| `HeadquartersPw` | PW | -| `HeadquartersPy` | PY | -| `HeadquartersQa` | QA | -| `HeadquartersRe` | RE | -| `HeadquartersRo` | RO | -| `HeadquartersRs` | RS | -| `HeadquartersRu` | RU | -| `HeadquartersRw` | RW | -| `HeadquartersSa` | SA | -| `HeadquartersSb` | SB | -| `HeadquartersSc` | SC | -| `HeadquartersSd` | SD | -| `HeadquartersSe` | SE | -| `HeadquartersSg` | SG | -| `HeadquartersSh` | SH | -| `HeadquartersSi` | SI | -| `HeadquartersSj` | SJ | -| `HeadquartersSk` | SK | -| `HeadquartersSl` | SL | -| `HeadquartersSm` | SM | -| `HeadquartersSn` | SN | -| `HeadquartersSo` | SO | -| `HeadquartersSr` | SR | -| `HeadquartersSs` | SS | -| `HeadquartersSt` | ST | -| `HeadquartersSv` | SV | -| `HeadquartersSx` | SX | -| `HeadquartersSy` | SY | -| `HeadquartersSz` | SZ | -| `HeadquartersTc` | TC | -| `HeadquartersTd` | TD | -| `HeadquartersTf` | TF | -| `HeadquartersTg` | TG | -| `HeadquartersTh` | TH | -| `HeadquartersTj` | TJ | -| `HeadquartersTk` | TK | -| `HeadquartersTl` | TL | -| `HeadquartersTm` | TM | -| `HeadquartersTn` | TN | -| `HeadquartersTo` | TO | -| `HeadquartersTr` | TR | -| `HeadquartersTt` | TT | -| `HeadquartersTv` | TV | -| `HeadquartersTw` | TW | -| `HeadquartersTz` | TZ | -| `HeadquartersUa` | UA | -| `HeadquartersUg` | UG | -| `HeadquartersUm` | UM | -| `HeadquartersUs` | US | -| `HeadquartersUy` | UY | -| `HeadquartersUz` | UZ | -| `HeadquartersVa` | VA | -| `HeadquartersVc` | VC | -| `HeadquartersVe` | VE | -| `HeadquartersVg` | VG | -| `HeadquartersVi` | VI | -| `HeadquartersVn` | VN | -| `HeadquartersVu` | VU | -| `HeadquartersWf` | WF | -| `HeadquartersWs` | WS | -| `HeadquartersYe` | YE | -| `HeadquartersYt` | YT | -| `HeadquartersZa` | ZA | -| `HeadquartersZm` | ZM | -| `HeadquartersZw` | ZW | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/imageurl.mdx b/client-sdks/go/api-reference/operations/imageurl.mdx deleted file mode 100644 index af36960d..00000000 --- a/client-sdks/go/api-reference/operations/imageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ImageURL - Go SDK -sidebarTitle: ImageURL -description: ImageURL type definition -seoTitle: ImageURL Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageURL Type | OpenRouter Go SDK -'og:description': >- - ImageURL type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageURL%20-%20Go%20SDK&description=ImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/input.mdx b/client-sdks/go/api-reference/operations/input.mdx deleted file mode 100644 index 9365050a..00000000 --- a/client-sdks/go/api-reference/operations/input.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input - Go SDK -sidebarTitle: Input -description: Input type definition -seoTitle: Input Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/input' -'og:site_name': OpenRouter Documentation -'og:title': Input Type | OpenRouter Go SDK -'og:description': >- - Input type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input%20-%20Go%20SDK&description=Input%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Content` | [][operations.Content](/client-sdks/go/api-reference/operations/content) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/inputunion.mdx b/client-sdks/go/api-reference/operations/inputunion.mdx deleted file mode 100644 index f60f9fb2..00000000 --- a/client-sdks/go/api-reference/operations/inputunion.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: InputUnion - Go SDK -sidebarTitle: InputUnion -description: InputUnion type definition -seoTitle: InputUnion Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion Type | OpenRouter Go SDK -'og:description': >- - InputUnion type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20Go%20SDK&description=InputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Text, token, or multimodal input(s) to embed - -## Supported Types - -### - -```go lines -inputUnion := operations.CreateInputUnionStr(string{/* values here */}) -``` - -### - -```go lines -inputUnion := operations.CreateInputUnionArrayOfStr([]string{/* values here */}) -``` - -### - -```go lines -inputUnion := operations.CreateInputUnionArrayOfNumber([]float64{/* values here */}) -``` - -### - -```go lines -inputUnion := operations.CreateInputUnionArrayOfArrayOfNumber([][]float64{/* values here */}) -``` - -### - -```go lines -inputUnion := operations.CreateInputUnionArrayOfInput([]operations.Input{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch inputUnion.Type { - case operations.InputUnionTypeStr: - // inputUnion.Str is populated - case operations.InputUnionTypeArrayOfStr: - // inputUnion.ArrayOfStr is populated - case operations.InputUnionTypeArrayOfNumber: - // inputUnion.ArrayOfNumber is populated - case operations.InputUnionTypeArrayOfArrayOfNumber: - // inputUnion.ArrayOfArrayOfNumber is populated - case operations.InputUnionTypeArrayOfInput: - // inputUnion.ArrayOfInput is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listbyokkeysrequest.mdx b/client-sdks/go/api-reference/operations/listbyokkeysrequest.mdx deleted file mode 100644 index a4d6208d..00000000 --- a/client-sdks/go/api-reference/operations/listbyokkeysrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListBYOKKeysRequest - Go SDK -sidebarTitle: ListBYOKKeysRequest -description: ListBYOKKeysRequest type definition -seoTitle: ListBYOKKeysRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listbyokkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysRequest Type | OpenRouter Go SDK -'og:description': >- - ListBYOKKeysRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysRequest%20-%20Go%20SDK&description=ListBYOKKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/listbyokkeysresponse.mdx b/client-sdks/go/api-reference/operations/listbyokkeysresponse.mdx deleted file mode 100644 index d73d1dd9..00000000 --- a/client-sdks/go/api-reference/operations/listbyokkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListBYOKKeysResponse - Go SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse type definition -seoTitle: ListBYOKKeysResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listbyokkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse Type | OpenRouter Go SDK -'og:description': >- - ListBYOKKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20Go%20SDK&description=ListBYOKKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListBYOKKeysResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listdata.mdx b/client-sdks/go/api-reference/operations/listdata.mdx deleted file mode 100644 index 9ef0f3db..00000000 --- a/client-sdks/go/api-reference/operations/listdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListData - Go SDK -sidebarTitle: ListData -description: ListData type definition -seoTitle: ListData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/listdata' -'og:site_name': OpenRouter Documentation -'og:title': ListData Type | OpenRouter Go SDK -'og:description': >- - ListData type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListData%20-%20Go%20SDK&description=ListData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ByokUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `ByokUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `ByokUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `ByokUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeByokInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `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 | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `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 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listendpointsrequest.mdx b/client-sdks/go/api-reference/operations/listendpointsrequest.mdx deleted file mode 100644 index 2e1429e5..00000000 --- a/client-sdks/go/api-reference/operations/listendpointsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListEndpointsRequest - Go SDK -sidebarTitle: ListEndpointsRequest -description: ListEndpointsRequest type definition -seoTitle: ListEndpointsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listendpointsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsRequest Type | OpenRouter Go SDK -'og:description': >- - ListEndpointsRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsRequest%20-%20Go%20SDK&description=ListEndpointsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `Author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | -| `Slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listendpointsresponse.mdx b/client-sdks/go/api-reference/operations/listendpointsresponse.mdx deleted file mode 100644 index fa68d38b..00000000 --- a/client-sdks/go/api-reference/operations/listendpointsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsResponse - Go SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse type definition -seoTitle: ListEndpointsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listendpointsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse Type | OpenRouter Go SDK -'og:description': >- - ListEndpointsResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Go%20SDK&description=ListEndpointsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ListEndpointsResponse](/client-sdks/go/api-reference/models/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_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}`,
"provider_name": "OpenAI",
"quantization": "fp16",
"status": "default",
"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/client-sdks/go/api-reference/operations/listendpointszdrresponse.mdx b/client-sdks/go/api-reference/operations/listendpointszdrresponse.mdx deleted file mode 100644 index a4b52c86..00000000 --- a/client-sdks/go/api-reference/operations/listendpointszdrresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsZdrResponse - Go SDK -sidebarTitle: ListEndpointsZdrResponse -description: ListEndpointsZdrResponse type definition -seoTitle: ListEndpointsZdrResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listendpointszdrresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrResponse Type | OpenRouter Go SDK -'og:description': >- - ListEndpointsZdrResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrResponse%20-%20Go%20SDK&description=ListEndpointsZdrResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Data` | [][components.PublicEndpoint](/client-sdks/go/api-reference/models/publicendpoint) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listgenerationcontentrequest.mdx b/client-sdks/go/api-reference/operations/listgenerationcontentrequest.mdx deleted file mode 100644 index 831871f9..00000000 --- a/client-sdks/go/api-reference/operations/listgenerationcontentrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGenerationContentRequest - Go SDK -sidebarTitle: ListGenerationContentRequest -description: ListGenerationContentRequest type definition -seoTitle: ListGenerationContentRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listgenerationcontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGenerationContentRequest Type | OpenRouter Go SDK -'og:description': >- - ListGenerationContentRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGenerationContentRequest%20-%20Go%20SDK&description=ListGenerationContentRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `ID` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsrequest.mdx b/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsrequest.mdx deleted file mode 100644 index bd60c908..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsRequest - Go SDK -sidebarTitle: ListGuardrailKeyAssignmentsRequest -description: ListGuardrailKeyAssignmentsRequest type definition -seoTitle: ListGuardrailKeyAssignmentsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsRequest Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailKeyAssignmentsRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsRequest%20-%20Go%20SDK&description=ListGuardrailKeyAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsresponse.mdx b/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsresponse.mdx deleted file mode 100644 index 79a8bb77..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailkeyassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsResponse - Go SDK -sidebarTitle: ListGuardrailKeyAssignmentsResponse -description: ListGuardrailKeyAssignmentsResponse type definition -seoTitle: ListGuardrailKeyAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailKeyAssignmentsResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsResponse%20-%20Go%20SDK&description=ListGuardrailKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsrequest.mdx b/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsrequest.mdx deleted file mode 100644 index ab30637d..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsRequest - Go SDK -sidebarTitle: ListGuardrailMemberAssignmentsRequest -description: ListGuardrailMemberAssignmentsRequest type definition -seoTitle: ListGuardrailMemberAssignmentsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsRequest Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailMemberAssignmentsRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsRequest%20-%20Go%20SDK&description=ListGuardrailMemberAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsresponse.mdx b/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsresponse.mdx deleted file mode 100644 index 67604fca..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailmemberassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsResponse - Go SDK -sidebarTitle: ListGuardrailMemberAssignmentsResponse -description: ListGuardrailMemberAssignmentsResponse type definition -seoTitle: ListGuardrailMemberAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailMemberAssignmentsResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsResponse%20-%20Go%20SDK&description=ListGuardrailMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listguardrailsrequest.mdx b/client-sdks/go/api-reference/operations/listguardrailsrequest.mdx deleted file mode 100644 index d2994d50..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailsRequest - Go SDK -sidebarTitle: ListGuardrailsRequest -description: ListGuardrailsRequest type definition -seoTitle: ListGuardrailsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsRequest Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailsRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsRequest%20-%20Go%20SDK&description=ListGuardrailsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listguardrailsresponse.mdx b/client-sdks/go/api-reference/operations/listguardrailsresponse.mdx deleted file mode 100644 index 61d84df8..00000000 --- a/client-sdks/go/api-reference/operations/listguardrailsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailsResponse - Go SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse type definition -seoTitle: ListGuardrailsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listguardrailsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse Type | OpenRouter Go SDK -'og:description': >- - ListGuardrailsResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20Go%20SDK&description=ListGuardrailsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListGuardrailsResponse](/client-sdks/go/api-reference/models/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,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/go/api-reference/operations/listkeyassignmentsrequest.mdx b/client-sdks/go/api-reference/operations/listkeyassignmentsrequest.mdx deleted file mode 100644 index f85807f2..00000000 --- a/client-sdks/go/api-reference/operations/listkeyassignmentsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListKeyAssignmentsRequest - Go SDK -sidebarTitle: ListKeyAssignmentsRequest -description: ListKeyAssignmentsRequest type definition -seoTitle: ListKeyAssignmentsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsRequest Type | OpenRouter Go SDK -'og:description': >- - ListKeyAssignmentsRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsRequest%20-%20Go%20SDK&description=ListKeyAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listkeyassignmentsresponse.mdx b/client-sdks/go/api-reference/operations/listkeyassignmentsresponse.mdx deleted file mode 100644 index 64a2698b..00000000 --- a/client-sdks/go/api-reference/operations/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - Go SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse type definition -seoTitle: ListKeyAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListKeyAssignmentsResponse type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20Go%20SDK&description=ListKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listmemberassignmentsrequest.mdx b/client-sdks/go/api-reference/operations/listmemberassignmentsrequest.mdx deleted file mode 100644 index 87a5b115..00000000 --- a/client-sdks/go/api-reference/operations/listmemberassignmentsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListMemberAssignmentsRequest - Go SDK -sidebarTitle: ListMemberAssignmentsRequest -description: ListMemberAssignmentsRequest type definition -seoTitle: ListMemberAssignmentsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsRequest Type | OpenRouter Go SDK -'og:description': >- - ListMemberAssignmentsRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsRequest%20-%20Go%20SDK&description=ListMemberAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listmemberassignmentsresponse.mdx b/client-sdks/go/api-reference/operations/listmemberassignmentsresponse.mdx deleted file mode 100644 index b30d44e7..00000000 --- a/client-sdks/go/api-reference/operations/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - Go SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse type definition -seoTitle: ListMemberAssignmentsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse Type | OpenRouter Go SDK -'og:description': >- - ListMemberAssignmentsResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20Go%20SDK&description=ListMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listmodelscountrequest.mdx b/client-sdks/go/api-reference/operations/listmodelscountrequest.mdx deleted file mode 100644 index 91cf5ddc..00000000 --- a/client-sdks/go/api-reference/operations/listmodelscountrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListModelsCountRequest - Go SDK -sidebarTitle: ListModelsCountRequest -description: ListModelsCountRequest type definition -seoTitle: ListModelsCountRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listmodelscountrequest -'og:site_name': OpenRouter Documentation -'og:title': ListModelsCountRequest Type | OpenRouter Go SDK -'og:description': >- - ListModelsCountRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsCountRequest%20-%20Go%20SDK&description=ListModelsCountRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listmodelsusersecurity.mdx b/client-sdks/go/api-reference/operations/listmodelsusersecurity.mdx deleted file mode 100644 index 253bd494..00000000 --- a/client-sdks/go/api-reference/operations/listmodelsusersecurity.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListModelsUserSecurity - Go SDK -sidebarTitle: ListModelsUserSecurity -description: ListModelsUserSecurity type definition -seoTitle: ListModelsUserSecurity Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listmodelsusersecurity -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserSecurity Type | OpenRouter Go SDK -'og:description': >- - ListModelsUserSecurity type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserSecurity%20-%20Go%20SDK&description=ListModelsUserSecurity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `Bearer` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listobservabilitydestinationsrequest.mdx b/client-sdks/go/api-reference/operations/listobservabilitydestinationsrequest.mdx deleted file mode 100644 index 4be1ec1b..00000000 --- a/client-sdks/go/api-reference/operations/listobservabilitydestinationsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListObservabilityDestinationsRequest - Go SDK -sidebarTitle: ListObservabilityDestinationsRequest -description: ListObservabilityDestinationsRequest type definition -seoTitle: ListObservabilityDestinationsRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listobservabilitydestinationsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsRequest Type | OpenRouter Go SDK -'og:description': >- - ListObservabilityDestinationsRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsRequest%20-%20Go%20SDK&description=ListObservabilityDestinationsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listobservabilitydestinationsresponse.mdx b/client-sdks/go/api-reference/operations/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index ef4066fb..00000000 --- a/client-sdks/go/api-reference/operations/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - Go SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse type definition -seoTitle: ListObservabilityDestinationsResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse Type | OpenRouter Go SDK -'og:description': >- - ListObservabilityDestinationsResponse type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20Go%20SDK&description=ListObservabilityDestinationsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListObservabilityDestinationsResponse](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/listorganizationmembersdata.mdx b/client-sdks/go/api-reference/operations/listorganizationmembersdata.mdx deleted file mode 100644 index 24295b53..00000000 --- a/client-sdks/go/api-reference/operations/listorganizationmembersdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListOrganizationMembersData - Go SDK -sidebarTitle: ListOrganizationMembersData -description: ListOrganizationMembersData type definition -seoTitle: ListOrganizationMembersData Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listorganizationmembersdata -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersData Type | OpenRouter Go SDK -'og:description': >- - ListOrganizationMembersData type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersData%20-%20Go%20SDK&description=ListOrganizationMembersData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Email` | `string` | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `FirstName` | `*string` | :heavy_check_mark: | First name of the member | Jane | -| `ID` | `string` | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `LastName` | `*string` | :heavy_check_mark: | Last name of the member | Doe | -| `Role` | [operations.Role](/client-sdks/go/api-reference/operations/role) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listorganizationmembersrequest.mdx b/client-sdks/go/api-reference/operations/listorganizationmembersrequest.mdx deleted file mode 100644 index 6e645237..00000000 --- a/client-sdks/go/api-reference/operations/listorganizationmembersrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListOrganizationMembersRequest - Go SDK -sidebarTitle: ListOrganizationMembersRequest -description: ListOrganizationMembersRequest type definition -seoTitle: ListOrganizationMembersRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listorganizationmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersRequest Type | OpenRouter Go SDK -'og:description': >- - ListOrganizationMembersRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersRequest%20-%20Go%20SDK&description=ListOrganizationMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listorganizationmembersresponse.mdx b/client-sdks/go/api-reference/operations/listorganizationmembersresponse.mdx deleted file mode 100644 index ab3739d1..00000000 --- a/client-sdks/go/api-reference/operations/listorganizationmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListOrganizationMembersResponse - Go SDK -sidebarTitle: ListOrganizationMembersResponse -description: ListOrganizationMembersResponse type definition -seoTitle: ListOrganizationMembersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listorganizationmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponse Type | OpenRouter Go SDK -'og:description': >- - ListOrganizationMembersResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponse%20-%20Go%20SDK&description=ListOrganizationMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Result` | [operations.ListOrganizationMembersResponseBody](/client-sdks/go/api-reference/operations/listorganizationmembersresponsebody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listorganizationmembersresponsebody.mdx b/client-sdks/go/api-reference/operations/listorganizationmembersresponsebody.mdx deleted file mode 100644 index b570b84e..00000000 --- a/client-sdks/go/api-reference/operations/listorganizationmembersresponsebody.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListOrganizationMembersResponseBody - Go SDK -sidebarTitle: ListOrganizationMembersResponseBody -description: ListOrganizationMembersResponseBody type definition -seoTitle: ListOrganizationMembersResponseBody Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listorganizationmembersresponsebody -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponseBody Type | OpenRouter Go SDK -'og:description': >- - ListOrganizationMembersResponseBody type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponseBody%20-%20Go%20SDK&description=ListOrganizationMembersResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -List of organization members - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.ListOrganizationMembersData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/listprovidersdata.mdx b/client-sdks/go/api-reference/operations/listprovidersdata.mdx deleted file mode 100644 index 3673af52..00000000 --- a/client-sdks/go/api-reference/operations/listprovidersdata.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListProvidersData - Go SDK -sidebarTitle: ListProvidersData -description: ListProvidersData type definition -seoTitle: ListProvidersData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/listprovidersdata' -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersData Type | OpenRouter Go SDK -'og:description': >- - ListProvidersData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersData%20-%20Go%20SDK&description=ListProvidersData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](/client-sdks/go/api-reference/operations/datacenter)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](/client-sdks/go/api-reference/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 | -| `StatusPageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `TermsOfServiceURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listprovidersresponse.mdx b/client-sdks/go/api-reference/operations/listprovidersresponse.mdx deleted file mode 100644 index 92a63a20..00000000 --- a/client-sdks/go/api-reference/operations/listprovidersresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListProvidersResponse - Go SDK -sidebarTitle: ListProvidersResponse -description: ListProvidersResponse type definition -seoTitle: ListProvidersResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listprovidersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersResponse Type | OpenRouter Go SDK -'og:description': >- - ListProvidersResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersResponse%20-%20Go%20SDK&description=ListProvidersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Returns a list of providers - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Data` | [][operations.ListProvidersData](/client-sdks/go/api-reference/operations/listprovidersdata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listrequest.mdx b/client-sdks/go/api-reference/operations/listrequest.mdx deleted file mode 100644 index 050ad0e5..00000000 --- a/client-sdks/go/api-reference/operations/listrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListRequest - Go SDK -sidebarTitle: ListRequest -description: ListRequest type definition -seoTitle: ListRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/listrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListRequest Type | OpenRouter Go SDK -'og:description': >- - ListRequest type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListRequest%20-%20Go%20SDK&description=ListRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listresponse.mdx b/client-sdks/go/api-reference/operations/listresponse.mdx deleted file mode 100644 index 70540e5e..00000000 --- a/client-sdks/go/api-reference/operations/listresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListResponse - Go SDK -sidebarTitle: ListResponse -description: ListResponse type definition -seoTitle: ListResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/listresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListResponse Type | OpenRouter Go SDK -'og:description': >- - ListResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListResponse%20-%20Go%20SDK&description=ListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -List of API keys - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `Data` | [][operations.ListData](/client-sdks/go/api-reference/operations/listdata) | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listvideoscontentrequest.mdx b/client-sdks/go/api-reference/operations/listvideoscontentrequest.mdx deleted file mode 100644 index db8cdd57..00000000 --- a/client-sdks/go/api-reference/operations/listvideoscontentrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListVideosContentRequest - Go SDK -sidebarTitle: ListVideosContentRequest -description: ListVideosContentRequest type definition -seoTitle: ListVideosContentRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listvideoscontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListVideosContentRequest Type | OpenRouter Go SDK -'og:description': >- - ListVideosContentRequest type reference for the OpenRouter Go SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosContentRequest%20-%20Go%20SDK&description=ListVideosContentRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `JobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | -| `Index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listworkspacesrequest.mdx b/client-sdks/go/api-reference/operations/listworkspacesrequest.mdx deleted file mode 100644 index c1333fd2..00000000 --- a/client-sdks/go/api-reference/operations/listworkspacesrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListWorkspacesRequest - Go SDK -sidebarTitle: ListWorkspacesRequest -description: ListWorkspacesRequest type definition -seoTitle: ListWorkspacesRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listworkspacesrequest -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesRequest Type | OpenRouter Go SDK -'og:description': >- - ListWorkspacesRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesRequest%20-%20Go%20SDK&description=ListWorkspacesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `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 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/listworkspacesresponse.mdx b/client-sdks/go/api-reference/operations/listworkspacesresponse.mdx deleted file mode 100644 index 10ad2e91..00000000 --- a/client-sdks/go/api-reference/operations/listworkspacesresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListWorkspacesResponse - Go SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse type definition -seoTitle: ListWorkspacesResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/listworkspacesresponse -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse Type | OpenRouter Go SDK -'og:description': >- - ListWorkspacesResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20Go%20SDK&description=ListWorkspacesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspacesResponse](/client-sdks/go/api-reference/models/listworkspacesresponse) | :heavy_check_mark: | N/A | `{"data": [{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/go/api-reference/operations/object.mdx b/client-sdks/go/api-reference/operations/object.mdx deleted file mode 100644 index 7c7dd55f..00000000 --- a/client-sdks/go/api-reference/operations/object.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Object - Go SDK -sidebarTitle: Object -description: Object type definition -seoTitle: Object Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/object' -'og:site_name': OpenRouter Documentation -'og:title': Object Type | OpenRouter Go SDK -'og:description': >- - Object type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Object%20-%20Go%20SDK&description=Object%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.ObjectList -``` - -## Values - -| Name | Value | -| ------------ | ------------ | -| `ObjectList` | list | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/objectembedding.mdx b/client-sdks/go/api-reference/operations/objectembedding.mdx deleted file mode 100644 index 543cac93..00000000 --- a/client-sdks/go/api-reference/operations/objectembedding.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ObjectEmbedding - Go SDK -sidebarTitle: ObjectEmbedding -description: ObjectEmbedding type definition -seoTitle: ObjectEmbedding Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/objectembedding' -'og:site_name': OpenRouter Documentation -'og:title': ObjectEmbedding Type | OpenRouter Go SDK -'og:description': >- - ObjectEmbedding type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectEmbedding%20-%20Go%20SDK&description=ObjectEmbedding%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.ObjectEmbeddingEmbedding -``` - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `ObjectEmbeddingEmbedding` | embedding | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/option.mdx b/client-sdks/go/api-reference/operations/option.mdx deleted file mode 100644 index 417b06e3..00000000 --- a/client-sdks/go/api-reference/operations/option.mdx +++ /dev/null @@ -1,197 +0,0 @@ ---- -title: Options - Go SDK -sidebarTitle: Options -description: Options type definition -seoTitle: Options Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/option' -'og:site_name': OpenRouter Documentation -'og:title': Options Type | OpenRouter Go SDK -'og:description': >- - Options type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Options%20-%20Go%20SDK&description=Options%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Global Options - -Global options are passed when initializing the SDK client and apply to all operations. - -### WithServerURL - -WithServerURL allows providing an alternative server URL. - -```go lines -openrouter.WithServerURL("https://api.example.com") -``` - -### WithTemplatedServerURL - -WithTemplatedServerURL allows providing an alternative server URL with templated parameters. - -```go lines -openrouter.WithTemplatedServerURL("https://{host}:{port}", map[string]string{ - "host": "api.example.com", - "port": "8080", -}) -``` - -### WithServer - -WithServer allows the overriding of the default server by name. - -```go lines -openrouter.WithServer("my-server") -``` - -### WithClient - -WithClient allows the overriding of the default HTTP client used by the SDK. - -```go lines -openrouter.WithClient(httpClient) -``` - -### WithSecurity - -WithSecurity configures the SDK to use the provided security details. - -```go lines -openrouter.WithSecurity(/* ... */) -``` - -### WithSecuritySource - -WithSecuritySource configures the SDK to invoke the provided function on each method call to determine authentication. - -```go lines -openrouter.WithSecuritySource(/* ... */) -``` - -### WithHTTPReferer - -WithHTTPReferer allows setting the HTTPReferer parameter for all supported operations. - -```go lines -openrouter.WithHTTPReferer(/* ... */) -``` - -### WithXTitle - -WithXTitle allows setting the XTitle parameter for all supported operations. - -```go lines -openrouter.WithXTitle(/* ... */) -``` - -### WithRetryConfig - -WithRetryConfig allows setting the default retry configuration used by the SDK for all supported operations. - -```go lines -openrouter.WithRetryConfig(retry.Config{ - Strategy: "backoff", - Backoff: retry.BackoffStrategy{ - InitialInterval: 500 * time.Millisecond, - MaxInterval: 60 * time.Second, - Exponent: 1.5, - MaxElapsedTime: 5 * time.Minute, - }, - RetryConnectionErrors: true, -}) -``` - -### WithTimeout - -WithTimeout sets the default request timeout for all operations. - -```go lines -openrouter.WithTimeout(30 * time.Second) -``` - -## Per-Method Options - -Per-method options are passed as the last argument to individual methods and override any global settings for that request. - -### WithServerURL - -WithServerURL allows providing an alternative server URL for a single request. - -```go lines -operations.WithServerURL("http://api.example.com") -``` - -### WithTemplatedServerURL - -WithTemplatedServerURL allows providing an alternative server URL with templated parameters for a single request. - -```go lines -operations.WithTemplatedServerURL("http://{host}:{port}", map[string]string{ - "host": "api.example.com", - "port": "8080", -}) -``` - -### WithRetries - -WithRetries allows customizing the default retry configuration for a single request. - -```go lines -operations.WithRetries(retry.Config{ - Strategy: "backoff", - Backoff: retry.BackoffStrategy{ - InitialInterval: 500 * time.Millisecond, - MaxInterval: 60 * time.Second, - Exponent: 1.5, - MaxElapsedTime: 5 * time.Minute, - }, - RetryConnectionErrors: true, -}) -``` - -### WithOperationTimeout - -WithOperationTimeout allows setting the request timeout for a single request. - -```go lines -operations.WithOperationTimeout(30 * time.Second) -``` - -### WithSetHeaders - -WithSetHeaders allows setting custom headers on a per-request basis. If the request already contains headers matching the provided keys, they will be overwritten. - -```go lines -operations.WithSetHeaders(map[string]string{ - "X-Cache-TTL": "60", -}) -``` - -### WithURLOverride - -WithURLOverride allows overriding the default URL for an operation. - -```go lines -operations.WithURLOverride("/custom/path") -``` - -### WithAcceptHeaderOverride - -WithAcceptHeaderOverride allows overriding the `Accept` header for operations that support multiple response content types. - -```go lines -operations.WithAcceptHeaderOverride(operations.AcceptHeaderEnumApplicationJson) -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/prompttokensdetails.mdx b/client-sdks/go/api-reference/operations/prompttokensdetails.mdx deleted file mode 100644 index f794082d..00000000 --- a/client-sdks/go/api-reference/operations/prompttokensdetails.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: PromptTokensDetails - Go SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails type definition -seoTitle: PromptTokensDetails Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/prompttokensdetails -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails Type | OpenRouter Go SDK -'og:description': >- - PromptTokensDetails type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20Go%20SDK&description=PromptTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `AudioTokens` | `*int64` | :heavy_minus_sign: | Number of audio tokens in the input | | -| `FileTokens` | `*int64` | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `ImageTokens` | `*int64` | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `TextTokens` | `*int64` | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `VideoTokens` | `*int64` | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/provider.mdx b/client-sdks/go/api-reference/operations/provider.mdx deleted file mode 100644 index a9def6e5..00000000 --- a/client-sdks/go/api-reference/operations/provider.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: Provider - Go SDK -sidebarTitle: Provider -description: Provider type definition -seoTitle: Provider Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/provider' -'og:site_name': OpenRouter Documentation -'og:title': Provider Type | OpenRouter Go SDK -'og:description': >- - Provider type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Provider%20-%20Go%20SDK&description=Provider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.ProviderAi21 - -// Open enum: custom values can be created with a direct type cast -custom := operations.Provider("custom_value") -``` - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `ProviderAi21` | ai21 | -| `ProviderAionLabs` | aion-labs | -| `ProviderAkashml` | akashml | -| `ProviderAlibaba` | alibaba | -| `ProviderAmazonBedrock` | amazon-bedrock | -| `ProviderAmazonNova` | amazon-nova | -| `ProviderAmbient` | ambient | -| `ProviderAnthropic` | anthropic | -| `ProviderArceeAi` | arcee-ai | -| `ProviderAtlasCloud` | atlas-cloud | -| `ProviderAvian` | avian | -| `ProviderAzure` | azure | -| `ProviderBaidu` | baidu | -| `ProviderBaseten` | baseten | -| `ProviderBlackForestLabs` | black-forest-labs | -| `ProviderByteplus` | byteplus | -| `ProviderCerebras` | cerebras | -| `ProviderChutes` | chutes | -| `ProviderCirrascale` | cirrascale | -| `ProviderClarifai` | clarifai | -| `ProviderCloudflare` | cloudflare | -| `ProviderCohere` | cohere | -| `ProviderCrusoe` | crusoe | -| `ProviderDarkbloom` | darkbloom | -| `ProviderDeepinfra` | deepinfra | -| `ProviderDeepseek` | deepseek | -| `ProviderDekallm` | dekallm | -| `ProviderDigitalocean` | digitalocean | -| `ProviderFeatherless` | featherless | -| `ProviderFireworks` | fireworks | -| `ProviderFriendli` | friendli | -| `ProviderGmicloud` | gmicloud | -| `ProviderGoogleAiStudio` | google-ai-studio | -| `ProviderGoogleVertex` | google-vertex | -| `ProviderGroq` | groq | -| `ProviderHyperbolic` | hyperbolic | -| `ProviderInception` | inception | -| `ProviderInceptron` | inceptron | -| `ProviderInferenceNet` | inference-net | -| `ProviderInfermatic` | infermatic | -| `ProviderInflection` | inflection | -| `ProviderIoNet` | io-net | -| `ProviderIonstream` | ionstream | -| `ProviderLiquid` | liquid | -| `ProviderMancer` | mancer | -| `ProviderMara` | mara | -| `ProviderMinimax` | minimax | -| `ProviderMistral` | mistral | -| `ProviderModelrun` | modelrun | -| `ProviderModular` | modular | -| `ProviderMoonshotai` | moonshotai | -| `ProviderMorph` | morph | -| `ProviderNcompass` | ncompass | -| `ProviderNebius` | nebius | -| `ProviderNexAgi` | nex-agi | -| `ProviderNextbit` | nextbit | -| `ProviderNovita` | novita | -| `ProviderNvidia` | nvidia | -| `ProviderOpenInference` | open-inference | -| `ProviderOpenai` | openai | -| `ProviderParasail` | parasail | -| `ProviderPerceptron` | perceptron | -| `ProviderPerplexity` | perplexity | -| `ProviderPhala` | phala | -| `ProviderPoolside` | poolside | -| `ProviderRecraft` | recraft | -| `ProviderReka` | reka | -| `ProviderRelace` | relace | -| `ProviderSambanova` | sambanova | -| `ProviderSeed` | seed | -| `ProviderSiliconflow` | siliconflow | -| `ProviderSourceful` | sourceful | -| `ProviderStepfun` | stepfun | -| `ProviderStreamlake` | streamlake | -| `ProviderSwitchpoint` | switchpoint | -| `ProviderTogether` | together | -| `ProviderUpstage` | upstage | -| `ProviderVenice` | venice | -| `ProviderWandb` | wandb | -| `ProviderXai` | xai | -| `ProviderXiaomi` | xiaomi | -| `ProviderZAi` | z-ai | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/ratelimit.mdx b/client-sdks/go/api-reference/operations/ratelimit.mdx deleted file mode 100644 index 850b401c..00000000 --- a/client-sdks/go/api-reference/operations/ratelimit.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ~~RateLimit~~ - Go SDK -sidebarTitle: ~~RateLimit~~ -description: ~~RateLimit~~ type definition -seoTitle: ~~RateLimit~~ Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/ratelimit' -'og:site_name': OpenRouter Documentation -'og:title': ~~RateLimit~~ Type | OpenRouter Go SDK -'og:description': >- - ~~RateLimit~~ type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~RateLimit~~%20-%20Go%20SDK&description=~~RateLimit~~%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Legacy rate limit information about a key. Will always return -1. - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `Interval` | `string` | :heavy_check_mark: | Rate limit interval | 1h | -| `Note` | `string` | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `Requests` | `int64` | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/result.mdx b/client-sdks/go/api-reference/operations/result.mdx deleted file mode 100644 index 4497cf38..00000000 --- a/client-sdks/go/api-reference/operations/result.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Result - Go SDK -sidebarTitle: Result -description: Result type definition -seoTitle: Result Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/result' -'og:site_name': OpenRouter Documentation -'og:title': Result Type | OpenRouter Go SDK -'og:description': >- - Result type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Result%20-%20Go%20SDK&description=Result%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -A single rerank result - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Document` | [operations.Document](/client-sdks/go/api-reference/operations/document) | :heavy_check_mark: | The document object containing the original text | | -| `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/client-sdks/go/api-reference/operations/role.mdx b/client-sdks/go/api-reference/operations/role.mdx deleted file mode 100644 index 17b98ac4..00000000 --- a/client-sdks/go/api-reference/operations/role.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Role - Go SDK -sidebarTitle: Role -description: Role type definition -seoTitle: Role Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/role' -'og:site_name': OpenRouter Documentation -'og:title': Role Type | OpenRouter Go SDK -'og:description': >- - Role type reference for the OpenRouter Go SDK. Complete type definition and - usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Role%20-%20Go%20SDK&description=Role%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Role of the member in the organization - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.RoleOrgAdmin - -// Open enum: custom values can be created with a direct type cast -custom := operations.Role("custom_value") -``` - -## Values - -| Name | Value | -| --------------- | --------------- | -| `RoleOrgAdmin` | org:admin | -| `RoleOrgMember` | org:member | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/sendchatcompletionrequestrequest.mdx b/client-sdks/go/api-reference/operations/sendchatcompletionrequestrequest.mdx deleted file mode 100644 index 38281339..00000000 --- a/client-sdks/go/api-reference/operations/sendchatcompletionrequestrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SendChatCompletionRequestRequest - Go SDK -sidebarTitle: SendChatCompletionRequestRequest -description: SendChatCompletionRequestRequest type definition -seoTitle: SendChatCompletionRequestRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/sendchatcompletionrequestrequest -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestRequest Type | OpenRouter Go SDK -'og:description': >- - SendChatCompletionRequestRequest type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestRequest%20-%20Go%20SDK&description=SendChatCompletionRequestRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterExperimentalMetadata` | [*components.MetadataLevel](/client-sdks/go/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `ChatRequest` | [components.ChatRequest](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/sendchatcompletionrequestresponse.mdx b/client-sdks/go/api-reference/operations/sendchatcompletionrequestresponse.mdx deleted file mode 100644 index 30c3b536..00000000 --- a/client-sdks/go/api-reference/operations/sendchatcompletionrequestresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: SendChatCompletionRequestResponse - Go SDK -sidebarTitle: SendChatCompletionRequestResponse -description: SendChatCompletionRequestResponse type definition -seoTitle: SendChatCompletionRequestResponse Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/sendchatcompletionrequestresponse -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestResponse Type | OpenRouter Go SDK -'og:description': >- - SendChatCompletionRequestResponse type reference for the OpenRouter Go SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestResponse%20-%20Go%20SDK&description=SendChatCompletionRequestResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### ChatResult - -```go lines -sendChatCompletionRequestResponse := operations.CreateSendChatCompletionRequestResponseChatResult(components.ChatResult{/* values here */}) -``` - -### - -```go lines -sendChatCompletionRequestResponse := operations.CreateSendChatCompletionRequestResponseEventStream(*stream.EventStream[components.ChatStreamingResponse]{/* values here */}) -``` - -## Union Discrimination - -Use the `Type` field to determine which variant is active, then access the corresponding field: - -```go lines -switch sendChatCompletionRequestResponse.Type { - case operations.SendChatCompletionRequestResponseTypeChatResult: - // sendChatCompletionRequestResponse.ChatResult is populated - case operations.SendChatCompletionRequestResponseTypeEventStream: - // sendChatCompletionRequestResponse.EventStream is populated -} -``` \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/typeimageurl.mdx b/client-sdks/go/api-reference/operations/typeimageurl.mdx deleted file mode 100644 index 91036920..00000000 --- a/client-sdks/go/api-reference/operations/typeimageurl.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeImageURL - Go SDK -sidebarTitle: TypeImageURL -description: TypeImageURL type definition -seoTitle: TypeImageURL Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/typeimageurl' -'og:site_name': OpenRouter Documentation -'og:title': TypeImageURL Type | OpenRouter Go SDK -'og:description': >- - TypeImageURL type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeImageURL%20-%20Go%20SDK&description=TypeImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.TypeImageURLImageURL -``` - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TypeImageURLImageURL` | image_url | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/typetext.mdx b/client-sdks/go/api-reference/operations/typetext.mdx deleted file mode 100644 index 817f219e..00000000 --- a/client-sdks/go/api-reference/operations/typetext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TypeText - Go SDK -sidebarTitle: TypeText -description: TypeText type definition -seoTitle: TypeText Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/typetext' -'og:site_name': OpenRouter Documentation -'og:title': TypeText Type | OpenRouter Go SDK -'og:description': >- - TypeText type reference for the OpenRouter Go SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeText%20-%20Go%20SDK&description=TypeText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.TypeTextText -``` - -## Values - -| Name | Value | -| -------------- | -------------- | -| `TypeTextText` | text | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/updatebyokkeyrequest.mdx b/client-sdks/go/api-reference/operations/updatebyokkeyrequest.mdx deleted file mode 100644 index 139a56d4..00000000 --- a/client-sdks/go/api-reference/operations/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - Go SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest type definition -seoTitle: UpdateBYOKKeyRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updatebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateBYOKKeyRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20Go%20SDK&description=UpdateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](/client-sdks/go/api-reference/models/updatebyokkeyrequest) | :heavy_check_mark: | N/A | `{"disabled": false,"name": "Updated OpenAI Key"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/updateguardrailrequest.mdx b/client-sdks/go/api-reference/operations/updateguardrailrequest.mdx deleted file mode 100644 index 81e1676d..00000000 --- a/client-sdks/go/api-reference/operations/updateguardrailrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UpdateGuardrailRequest - Go SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest type definition -seoTitle: UpdateGuardrailRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updateguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateGuardrailRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20Go%20SDK&description=UpdateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| 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](/client-sdks/go/api-reference/models/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/client-sdks/go/api-reference/operations/updatekeysdata.mdx b/client-sdks/go/api-reference/operations/updatekeysdata.mdx deleted file mode 100644 index bc659d33..00000000 --- a/client-sdks/go/api-reference/operations/updatekeysdata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: UpdateKeysData - Go SDK -sidebarTitle: UpdateKeysData -description: UpdateKeysData type definition -seoTitle: UpdateKeysData Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/updatekeysdata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysData Type | OpenRouter Go SDK -'og:description': >- - UpdateKeysData type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysData%20-%20Go%20SDK&description=UpdateKeysData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -The updated API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ByokUsage` | `float64` | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `ByokUsageDaily` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `ByokUsageMonthly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `ByokUsageWeekly` | `float64` | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `CreatedAt` | `string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `CreatorUserID` | `*string` | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `Disabled` | `bool` | :heavy_check_mark: | Whether the API key is disabled | false | -| `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `Hash` | `string` | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `IncludeByokInLimit` | `bool` | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `Label` | `string` | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `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 | -| `Name` | `string` | :heavy_check_mark: | Name of the API key | My Production Key | -| `UpdatedAt` | `*string` | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `Usage` | `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 | -| `UsageWeekly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `WorkspaceID` | `string` | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/updatekeyslimitreset.mdx b/client-sdks/go/api-reference/operations/updatekeyslimitreset.mdx deleted file mode 100644 index c8603bb3..00000000 --- a/client-sdks/go/api-reference/operations/updatekeyslimitreset.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: UpdateKeysLimitReset - Go SDK -sidebarTitle: UpdateKeysLimitReset -description: UpdateKeysLimitReset type definition -seoTitle: UpdateKeysLimitReset Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updatekeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysLimitReset Type | OpenRouter Go SDK -'og:description': >- - UpdateKeysLimitReset type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysLimitReset%20-%20Go%20SDK&description=UpdateKeysLimitReset%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.UpdateKeysLimitResetDaily - -// Open enum: custom values can be created with a direct type cast -custom := operations.UpdateKeysLimitReset("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `UpdateKeysLimitResetDaily` | daily | -| `UpdateKeysLimitResetWeekly` | weekly | -| `UpdateKeysLimitResetMonthly` | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/updatekeysrequest.mdx b/client-sdks/go/api-reference/operations/updatekeysrequest.mdx deleted file mode 100644 index b1740210..00000000 --- a/client-sdks/go/api-reference/operations/updatekeysrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateKeysRequest - Go SDK -sidebarTitle: UpdateKeysRequest -description: UpdateKeysRequest type definition -seoTitle: UpdateKeysRequest Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/updatekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateKeysRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequest%20-%20Go%20SDK&description=UpdateKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `Hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `RequestBody` | [operations.UpdateKeysRequestBody](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/updatekeysrequestbody.mdx b/client-sdks/go/api-reference/operations/updatekeysrequestbody.mdx deleted file mode 100644 index f112a685..00000000 --- a/client-sdks/go/api-reference/operations/updatekeysrequestbody.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateKeysRequestBody - Go SDK -sidebarTitle: UpdateKeysRequestBody -description: UpdateKeysRequestBody type definition -seoTitle: UpdateKeysRequestBody Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updatekeysrequestbody -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequestBody Type | OpenRouter Go SDK -'og:description': >- - UpdateKeysRequestBody type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequestBody%20-%20Go%20SDK&description=UpdateKeysRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/updatekeysresponse.mdx b/client-sdks/go/api-reference/operations/updatekeysresponse.mdx deleted file mode 100644 index 56f8a0bd..00000000 --- a/client-sdks/go/api-reference/operations/updatekeysresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UpdateKeysResponse - Go SDK -sidebarTitle: UpdateKeysResponse -description: UpdateKeysResponse type definition -seoTitle: UpdateKeysResponse Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/updatekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysResponse Type | OpenRouter Go SDK -'og:description': >- - UpdateKeysResponse type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysResponse%20-%20Go%20SDK&description=UpdateKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -API key updated successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [operations.UpdateKeysData](/client-sdks/go/api-reference/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/client-sdks/go/api-reference/operations/updateobservabilitydestinationrequest.mdx b/client-sdks/go/api-reference/operations/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index dabf013f..00000000 --- a/client-sdks/go/api-reference/operations/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - Go SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest type definition -seoTitle: UpdateObservabilityDestinationRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateObservabilityDestinationRequest type reference for the OpenRouter Go - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20Go%20SDK&description=UpdateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](/client-sdks/go/api-reference/models/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"enabled": false,"name": "Updated Langfuse"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/updateworkspacerequest.mdx b/client-sdks/go/api-reference/operations/updateworkspacerequest.mdx deleted file mode 100644 index 5cfea562..00000000 --- a/client-sdks/go/api-reference/operations/updateworkspacerequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UpdateWorkspaceRequest - Go SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest type definition -seoTitle: UpdateWorkspaceRequest Type | OpenRouter Go SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/go/api-reference/operations/updateworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest Type | OpenRouter Go SDK -'og:description': >- - UpdateWorkspaceRequest type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20Go%20SDK&description=UpdateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](/client-sdks/go/api-reference/models/updateworkspacerequest) | :heavy_check_mark: | N/A | `{"name": "Updated Workspace","slug": "updated-workspace"}` | \ No newline at end of file diff --git a/client-sdks/go/api-reference/operations/usagelimittype.mdx b/client-sdks/go/api-reference/operations/usagelimittype.mdx deleted file mode 100644 index a2758600..00000000 --- a/client-sdks/go/api-reference/operations/usagelimittype.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: UsageLimitType - Go SDK -sidebarTitle: UsageLimitType -description: UsageLimitType type definition -seoTitle: UsageLimitType Type | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/operations/usagelimittype' -'og:site_name': OpenRouter Documentation -'og:title': UsageLimitType Type | OpenRouter Go SDK -'og:description': >- - UsageLimitType type reference for the OpenRouter Go SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageLimitType%20-%20Go%20SDK&description=UsageLimitType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -Optional credit limit reset interval. When set, the credit limit resets on this interval. - -## Example Usage - -```go lines -import ( - "github.com/OpenRouterTeam/go-sdk/models/operations" -) - -value := operations.UsageLimitTypeDaily - -// Open enum: custom values can be created with a direct type cast -custom := operations.UsageLimitType("custom_value") -``` - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `UsageLimitTypeDaily` | daily | -| `UsageLimitTypeWeekly` | weekly | -| `UsageLimitTypeMonthly` | monthly | \ No newline at end of file diff --git a/client-sdks/go/api-reference/organization.mdx b/client-sdks/go/api-reference/organization.mdx deleted file mode 100644 index 9ea1d92c..00000000 --- a/client-sdks/go/api-reference/organization.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Organization - Go SDK -sidebarTitle: Organization -description: Organization method reference -seoTitle: Organization | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/organization' -'og:site_name': OpenRouter Documentation -'og:title': Organization | OpenRouter Go SDK -'og:description': >- - Organization method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Organization%20-%20Go%20SDK&description=Organization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Organization endpoints - -### Available Operations - -* [ListMembers](#listmembers) - List organization members - -## ListMembers - -List all members of the organization associated with the authenticated management key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listOrganizationMembers" method="get" path="/organization/members" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Organization.ListMembers(ctx, optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListOrganizationMembersResponse](/client-sdks/go/api-reference/operations/listorganizationmembersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/presets.mdx b/client-sdks/go/api-reference/presets.mdx deleted file mode 100644 index f26791af..00000000 --- a/client-sdks/go/api-reference/presets.mdx +++ /dev/null @@ -1,261 +0,0 @@ ---- -title: Presets - Go SDK -sidebarTitle: Presets -description: Presets method reference -seoTitle: Presets | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/presets' -'og:site_name': OpenRouter Documentation -'og:title': Presets | OpenRouter Go SDK -'og:description': >- - Presets method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Presets%20-%20Go%20SDK&description=Presets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Presets endpoints - -### Available Operations - -* [CreatePresetsChatCompletions](#createpresetschatcompletions) - Create a preset from a chat-completions request body -* [CreatePresetsMessages](#createpresetsmessages) - Create a preset from a messages request body -* [CreatePresetsResponses](#createpresetsresponses) - Create a preset from a responses request body - -## CreatePresetsChatCompletions - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createPresetsChatCompletions" method="post" path="/presets/{slug}/chat/completions" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Presets.CreatePresetsChatCompletions(ctx, "my-preset", components.ChatRequest{ - Messages: []components.ChatMessages{ - components.CreateChatMessagesSystem( - components.ChatSystemMessage{ - Content: components.CreateChatSystemMessageContentStr( - "You are a helpful assistant.", - ), - Role: components.ChatSystemMessageRoleSystem, - }, - ), - components.CreateChatMessagesUser( - components.ChatUserMessage{ - Content: components.CreateChatUserMessageContentStr( - "Hello!", - ), - Role: components.ChatUserMessageRoleUser, - }, - ), - }, - Model: openrouter.Pointer("openai/gpt-5.4"), - Temperature: optionalnullable.From(openrouter.Pointer[float64](0.7)), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.CreatePresetFromInferenceResponse](/client-sdks/go/api-reference/models/createpresetfrominferenceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## CreatePresetsMessages - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createPresetsMessages" method="post" path="/presets/{slug}/messages" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Presets.CreatePresetsMessages(ctx, "my-preset", components.MessagesRequest{ - MaxTokens: openrouter.Pointer[int64](1024), - Messages: []components.MessagesMessageParam{ - components.MessagesMessageParam{ - Content: components.CreateMessagesMessageParamContentUnion5Str( - "Hello!", - ), - Role: components.MessagesMessageParamRoleUser, - }, - }, - Model: "anthropic/claude-4.6-sonnet", - System: openrouter.Pointer(components.CreateSystemStr( - "You are a helpful assistant.", - )), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.CreatePresetFromInferenceResponse](/client-sdks/go/api-reference/models/createpresetfrominferenceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## CreatePresetsResponses - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createPresetsResponses" method="post" path="/presets/{slug}/responses" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Presets.CreatePresetsResponses(ctx, "my-preset", components.ResponsesRequest{ - Input: openrouter.Pointer(components.CreateInputsUnionStr( - "Hello!", - )), - Instructions: optionalnullable.From(openrouter.Pointer("You are a helpful assistant.")), - Model: openrouter.Pointer("openai/gpt-5.4"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.CreatePresetFromInferenceResponse](/client-sdks/go/api-reference/models/createpresetfrominferenceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.ConflictResponseError | 409 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/providers.mdx b/client-sdks/go/api-reference/providers.mdx deleted file mode 100644 index 72fd4c0d..00000000 --- a/client-sdks/go/api-reference/providers.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: Providers - Go SDK -sidebarTitle: Providers -description: Providers method reference -seoTitle: Providers | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/providers' -'og:site_name': OpenRouter Documentation -'og:title': Providers | OpenRouter Go SDK -'og:description': >- - Providers method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Providers%20-%20Go%20SDK&description=Providers%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: cloud ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Provider information endpoints - -### Available Operations - -* [List](#list) - List all providers - -## List - -List all providers - -### Example Usage - -{/* UsageSnippet language="go" operationID="listProviders" method="get" path="/providers" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Providers.List(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.ListProvidersResponse](/client-sdks/go/api-reference/operations/listprovidersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/rerank.mdx b/client-sdks/go/api-reference/rerank.mdx deleted file mode 100644 index 42ce83f5..00000000 --- a/client-sdks/go/api-reference/rerank.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Rerank - Go SDK -sidebarTitle: Rerank -description: Rerank method reference -seoTitle: Rerank | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/rerank' -'og:site_name': OpenRouter Documentation -'og:title': Rerank | OpenRouter Go SDK -'og:description': >- - Rerank method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rerank%20-%20Go%20SDK&description=Rerank%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Rerank endpoints - -### Available Operations - -* [Rerank](#rerank) - Submit a rerank request - -## Rerank - -Submits a rerank request to the rerank router - -### Example Usage - -{/* UsageSnippet language="go" operationID="createRerank" method="post" path="/rerank" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/operations" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Rerank.Rerank(ctx, operations.CreateRerankRequest{ - Documents: []string{ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - }, - Model: "cohere/rerank-v3.5", - Query: "What is the capital of France?", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/creatererankrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*operations.CreateRerankResponse](/client-sdks/go/api-reference/operations/creatererankresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/responses.mdx b/client-sdks/go/api-reference/responses.mdx deleted file mode 100644 index 442f6246..00000000 --- a/client-sdks/go/api-reference/responses.mdx +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Beta.Responses - Go SDK -sidebarTitle: Beta.Responses -description: Beta.Responses method reference -seoTitle: Beta.Responses | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/responses' -'og:site_name': OpenRouter Documentation -'og:title': Beta.Responses | OpenRouter Go SDK -'og:description': >- - Beta.Responses method documentation for the OpenRouter Go SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Beta.Responses%20-%20Go%20SDK&description=Beta.Responses%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: reply ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -beta.responses endpoints - -### Available Operations - -* [Send](#send) - Create a response - -## Send - -Creates a streaming or non-streaming response using OpenResponses API format - -### Example Usage: guardrail-blocked - -{/* UsageSnippet language="go" operationID="createResponses" method="post" path="/responses" example="guardrail-blocked" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Beta.Responses.Send(ctx, components.ResponsesRequest{}, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - defer res.ResponsesStreamingResponse.Close() - - for res.ResponsesStreamingResponse.Next() { - event := res.ResponsesStreamingResponse.Value() - log.Print(event) - // Handle the event - } - } -} -``` -### Example Usage: insufficient-permissions - -{/* UsageSnippet language="go" operationID="createResponses" method="post" path="/responses" example="insufficient-permissions" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Beta.Responses.Send(ctx, components.ResponsesRequest{}, nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - defer res.ResponsesStreamingResponse.Close() - - for res.ResponsesStreamingResponse.Next() { - event := res.ResponsesStreamingResponse.Value() - log.Print(event) - // Handle the event - } - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/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
\} | -| `xOpenRouterExperimentalMetadata` | [*components.MetadataLevel](/client-sdks/go/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.CreateResponsesResponse](/client-sdks/go/api-reference/operations/createresponsesresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.RequestTimeoutResponseError | 408 | application/json | -| sdkerrors.PayloadTooLargeResponseError | 413 | application/json | -| sdkerrors.UnprocessableEntityResponseError | 422 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/stt.mdx b/client-sdks/go/api-reference/stt.mdx deleted file mode 100644 index 535c61be..00000000 --- a/client-sdks/go/api-reference/stt.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Transcriptions - Go SDK -sidebarTitle: Transcriptions -description: Transcriptions method reference -seoTitle: Transcriptions | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/stt' -'og:site_name': OpenRouter Documentation -'og:title': Transcriptions | OpenRouter Go SDK -'og:description': >- - Transcriptions method documentation for the OpenRouter Go SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Transcriptions%20-%20Go%20SDK&description=Transcriptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Speech-to-text endpoints - -### Available Operations - -* [CreateTranscription](#createtranscription) - Create transcription - -## CreateTranscription - -Transcribes audio into text. Accepts base64-encoded audio input and returns the transcribed text. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createAudioTranscriptions" method="post" path="/audio/transcriptions" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Stt.CreateTranscription(ctx, components.STTRequest{ - InputAudio: components.STTInputAudio{ - Data: "UklGRiQA...", - Format: "wav", - }, - Language: openrouter.Pointer("en"), - Model: "openai/whisper-large-v3", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/sttrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.STTResponse](/client-sdks/go/api-reference/models/sttresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/tts.mdx b/client-sdks/go/api-reference/tts.mdx deleted file mode 100644 index 6383960d..00000000 --- a/client-sdks/go/api-reference/tts.mdx +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Speech - Go SDK -sidebarTitle: Speech -description: Speech method reference -seoTitle: Speech | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/tts' -'og:site_name': OpenRouter Documentation -'og:title': Speech | OpenRouter Go SDK -'og:description': >- - Speech method documentation for the OpenRouter Go SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speech%20-%20Go%20SDK&description=Speech%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Text-to-speech endpoints - -### Available Operations - -* [CreateSpeech](#createspeech) - Create speech - -## CreateSpeech - -Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav). - -### Example Usage - -{/* UsageSnippet language="go" operationID="createAudioSpeech" method="post" path="/audio/speech" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Tts.CreateSpeech(ctx, components.SpeechRequest{ - Input: "Hello world", - Model: "elevenlabs/eleven-turbo-v2", - Speed: openrouter.Pointer[float64](1.0), - Voice: "alloy", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/speechrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[io.ReadCloser](/client-sdks/go/api-reference/), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.ServiceUnavailableResponseError | 503 | application/json | -| sdkerrors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| sdkerrors.ProviderOverloadedResponseError | 529 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/videogeneration.mdx b/client-sdks/go/api-reference/videogeneration.mdx deleted file mode 100644 index 1e7f2159..00000000 --- a/client-sdks/go/api-reference/videogeneration.mdx +++ /dev/null @@ -1,271 +0,0 @@ ---- -title: VideoGeneration - Go SDK -sidebarTitle: VideoGeneration -description: VideoGeneration method reference -seoTitle: VideoGeneration | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/videogeneration' -'og:site_name': OpenRouter Documentation -'og:title': VideoGeneration | OpenRouter Go SDK -'og:description': >- - VideoGeneration method documentation for the OpenRouter Go SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGeneration%20-%20Go%20SDK&description=VideoGeneration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Video Generation endpoints - -### Available Operations - -* [Generate](#generate) - Submit a video generation request -* [GetGeneration](#getgeneration) - Poll video generation status -* [GetVideoContent](#getvideocontent) - Download generated video content -* [ListVideosModels](#listvideosmodels) - List all video generation models - -## Generate - -Submits a video generation request and returns a polling URL to check status - -### Example Usage - -{/* UsageSnippet language="go" operationID="createVideos" method="post" path="/videos" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.VideoGeneration.Generate(ctx, components.VideoGenerationRequest{ - AspectRatio: components.AspectRatioOneHundredAndSixtyNine.ToPointer(), - Duration: openrouter.Pointer[int64](8), - Model: "google/veo-3.1", - Prompt: "A serene mountain landscape at sunset", - Resolution: components.ResolutionSevenHundredAndTwentyp.ToPointer(), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/videogenerationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.VideoGenerationResponse](/client-sdks/go/api-reference/models/videogenerationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.PaymentRequiredResponseError | 402 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.TooManyRequestsResponseError | 429 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## GetGeneration - -Returns job status and content URLs when completed - -### Example Usage - -{/* UsageSnippet language="go" operationID="getVideos" method="get" path="/videos/{jobId}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.VideoGeneration.GetGeneration(ctx, "job-abc123") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.VideoGenerationResponse](/client-sdks/go/api-reference/models/videogenerationresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## GetVideoContent - -Streams the generated video content from the upstream provider - -### Example Usage - -{/* UsageSnippet language="go" operationID="listVideosContent" method="get" path="/videos/{jobId}/content" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.VideoGeneration.GetVideoContent(ctx, "job-abc123", optionalnullable.From(openrouter.Pointer[int64](0))) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[io.ReadCloser](/client-sdks/go/api-reference/), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.BadGatewayResponseError | 502 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## ListVideosModels - -Returns a list of all available video generation models and their properties - -### Example Usage - -{/* UsageSnippet language="go" operationID="listVideosModels" method="get" path="/videos/models" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.VideoGeneration.ListVideosModels(ctx) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.VideoModelsListResponse](/client-sdks/go/api-reference/models/videomodelslistresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/go/api-reference/workspaces.mdx b/client-sdks/go/api-reference/workspaces.mdx deleted file mode 100644 index 4033b35d..00000000 --- a/client-sdks/go/api-reference/workspaces.mdx +++ /dev/null @@ -1,477 +0,0 @@ ---- -title: Workspaces - Go SDK -sidebarTitle: Workspaces -description: Workspaces method reference -seoTitle: Workspaces | OpenRouter Go SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/go/api-reference/workspaces' -'og:site_name': OpenRouter Documentation -'og:title': Workspaces | OpenRouter Go SDK -'og:description': >- - Workspaces method documentation for the OpenRouter Go SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspaces%20-%20Go%20SDK&description=Workspaces%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Go SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/go-sdk/issues). - -{/* banner:end */} - -## Overview - -Workspaces endpoints - -### Available Operations - -* [List](#list) - List workspaces -* [Create](#create) - Create a workspace -* [Delete](#delete) - Delete a workspace -* [Get](#get) - Get a workspace -* [Update](#update) - Update a workspace -* [BulkAddMembers](#bulkaddmembers) - Bulk add members to a workspace -* [BulkRemoveMembers](#bulkremovemembers) - Bulk remove members from a workspace - -## List - -List all workspaces for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="listWorkspaces" method="get" path="/workspaces" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.List(ctx, optionalnullable.From[int64](nil), nil) - if err != nil { - log.Fatal(err) - } - if res != nil { - for { - // handle items - - res, err = res.Next() - - if err != nil { - // handle error - } - - if res == nil { - break - } - } - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*operations.ListWorkspacesResponse](/client-sdks/go/api-reference/operations/listworkspacesresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Create - -Create a new workspace for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="createWorkspace" method="post" path="/workspaces" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/optionalnullable" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.Create(ctx, components.CreateWorkspaceRequest{ - DefaultImageModel: optionalnullable.From(openrouter.Pointer("openai/dall-e-3")), - DefaultProviderSort: optionalnullable.From(openrouter.Pointer("price")), - DefaultTextModel: optionalnullable.From(openrouter.Pointer("openai/gpt-4o")), - Description: optionalnullable.From(openrouter.Pointer("Production environment workspace")), - Name: "Production", - Slug: "production", - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| 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](/client-sdks/go/api-reference/models/createworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | - -### Response - -**[*components.CreateWorkspaceResponse](/client-sdks/go/api-reference/models/createworkspaceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Delete - -Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="deleteWorkspace" method="delete" path="/workspaces/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.Delete(ctx, "production") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.DeleteWorkspaceResponse](/client-sdks/go/api-reference/models/deleteworkspaceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Get - -Get a single workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="getWorkspace" method="get" path="/workspaces/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.Get(ctx, "production") - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.GetWorkspaceResponse](/client-sdks/go/api-reference/models/getworkspaceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## Update - -Update an existing workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="updateWorkspace" method="patch" path="/workspaces/{id}" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.Update(ctx, "production", components.UpdateWorkspaceRequest{ - Name: openrouter.Pointer("Updated Workspace"), - Slug: openrouter.Pointer("updated-workspace"), - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `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](/client-sdks/go/api-reference/models/updateworkspacerequest) | :heavy_check_mark: | N/A | `{"name": "Updated Workspace","slug": "updated-workspace"}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.UpdateWorkspaceResponse](/client-sdks/go/api-reference/models/updateworkspaceresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkAddMembers - -Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkAddWorkspaceMembers" method="post" path="/workspaces/{id}/members/add" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.BulkAddMembers(ctx, "production", components.BulkAddWorkspaceMembersRequest{ - UserIds: []string{ - "user_abc123", - "user_def456", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkAddWorkspaceMembersResponse](/client-sdks/go/api-reference/models/bulkaddworkspacemembersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | - -## BulkRemoveMembers - -Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="go" operationID="bulkRemoveWorkspaceMembers" method="post" path="/workspaces/{id}/members/remove" */} -```go expandable lines -package main - -import( - "context" - "os" - openrouter "github.com/OpenRouterTeam/go-sdk" - "github.com/OpenRouterTeam/go-sdk/models/components" - "log" -) - -func main() { - ctx := context.Background() - - s := openrouter.New( - openrouter.WithSecurity(os.Getenv("OPENROUTER_API_KEY")), - ) - - res, err := s.Workspaces.BulkRemoveMembers(ctx, "production", components.BulkRemoveWorkspaceMembersRequest{ - UserIds: []string{ - "user_abc123", - "user_def456", - }, - }) - if err != nil { - log.Fatal(err) - } - if res != nil { - // handle response - } -} -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `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](/client-sdks/go/api-reference/models/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | -| `opts` | [][operations.Option](/client-sdks/go/api-reference/operations/option) | :heavy_minus_sign: | The options for this request. | | - -### Response - -**[*components.BulkRemoveWorkspaceMembersResponse](/client-sdks/go/api-reference/models/bulkremoveworkspacemembersresponse), error** - -### Errors - -| Error Type | Status Code | Content Type | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | -| sdkerrors.BadRequestResponseError | 400 | application/json | -| sdkerrors.UnauthorizedResponseError | 401 | application/json | -| sdkerrors.ForbiddenResponseError | 403 | application/json | -| sdkerrors.NotFoundResponseError | 404 | application/json | -| sdkerrors.InternalServerResponseError | 500 | application/json | -| sdkerrors.APIError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/analytics.mdx b/client-sdks/python/api-reference/analytics.mdx deleted file mode 100644 index ac69e095..00000000 --- a/client-sdks/python/api-reference/analytics.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: Analytics - Python SDK -sidebarTitle: Analytics -description: Analytics method reference -seoTitle: Analytics | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/analytics' -'og:site_name': OpenRouter Documentation -'og:title': Analytics | OpenRouter Python SDK -'og:description': >- - Analytics method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analytics%20-%20Python%20SDK&description=Analytics%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: chart-simple ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Analytics and usage endpoints - -### Available Operations - -* [get_user_activity](#get_user_activity) - Get user activity grouped by endpoint - -## get_user_activity - -Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getUserActivity" method="get" path="/activity" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.analytics.get_user_activity() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `api_key_hash` | *Optional[str]* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `user_id` | *Optional[str]* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.ActivityResponse](/client-sdks/python/api-reference/components/activityresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/apikeys.mdx b/client-sdks/python/api-reference/apikeys.mdx deleted file mode 100644 index 313377a0..00000000 --- a/client-sdks/python/api-reference/apikeys.mdx +++ /dev/null @@ -1,347 +0,0 @@ ---- -title: APIKeys - Python SDK -sidebarTitle: APIKeys -description: APIKeys method reference -seoTitle: APIKeys | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/apikeys' -'og:site_name': OpenRouter Documentation -'og:title': APIKeys | OpenRouter Python SDK -'og:description': >- - APIKeys method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIKeys%20-%20Python%20SDK&description=APIKeys%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: key ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -API key management endpoints - -### Available Operations - -* [get_current_key_metadata](#get_current_key_metadata) - Get current API key -* [list](#list) - List API keys -* [create](#create) - Create a new API key -* [delete](#delete) - Delete an API key -* [get](#get) - Get a single API key -* [update](#update) - Update an API key - -## get_current_key_metadata - -Get information on the API key associated with the current authentication session - -### Example Usage - -{/* UsageSnippet language="python" operationID="getCurrentKey" method="get" path="/key" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.get_current_key_metadata() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[operations.GetCurrentKeyResponse](/client-sdks/python/api-reference/operations/getcurrentkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list - -List all API keys for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="list" method="get" path="/keys" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.list() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListResponse](/client-sdks/python/api-reference/operations/listresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new API key for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createKeys" method="post" path="/keys" */} -```python lines -from openrouter import OpenRouter -from openrouter.utils import parse_datetime -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.create(name="My New API Key", expires_at=parse_datetime("2027-12-31T23:59:59Z"), include_byok_in_limit=True, limit=50, limit_reset="monthly") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `creator_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](/client-sdks/python/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 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.CreateKeysResponse](/client-sdks/python/api-reference/operations/createkeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="deleteKeys" method="delete" path="/keys/{hash}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.delete(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.DeleteKeysResponse](/client-sdks/python/api-reference/operations/deletekeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single API key by hash. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getKey" method="get" path="/keys/{hash}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.get(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.GetKeyResponse](/client-sdks/python/api-reference/operations/getkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="updateKeys" method="patch" path="/keys/{hash}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.api_keys.update(hash="f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", disabled=False, include_byok_in_limit=True, limit=75, limit_reset="daily", name="Updated API Key Name") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](/client-sdks/python/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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.UpdateKeysResponse](/client-sdks/python/api-reference/operations/updatekeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/byok.mdx b/client-sdks/python/api-reference/byok.mdx deleted file mode 100644 index 78ef64a6..00000000 --- a/client-sdks/python/api-reference/byok.mdx +++ /dev/null @@ -1,299 +0,0 @@ ---- -title: Byok - Python SDK -sidebarTitle: Byok -description: Byok method reference -seoTitle: Byok | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/byok' -'og:site_name': OpenRouter Documentation -'og:title': Byok | OpenRouter Python SDK -'og:description': >- - Byok method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Byok%20-%20Python%20SDK&description=Byok%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -BYOK endpoints - -### Available Operations - -* [list](#list) - List BYOK provider credentials -* [create](#create) - Create a BYOK provider credential -* [delete](#delete) - Delete a BYOK provider credential -* [get](#get) - Get a BYOK provider credential -* [update](#update) - Update a BYOK provider credential - -## list - -List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace, or the `provider` query parameter to filter by upstream provider. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listBYOKKeys" method="get" path="/byok" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.byok.list() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [Optional[operations.Provider]](/client-sdks/python/api-reference/operations/provider) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListBYOKKeysResponse](/client-sdks/python/api-reference/operations/listbyokkeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createBYOKKey" method="post" path="/byok" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.byok.create(key="sk-proj-abc123...", provider="openai", name="Production OpenAI Key") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `key` | *str* | :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... | -| `provider` | [components.BYOKProviderSlug](/client-sdks/python/api-reference/components/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `is_fallback` | *Optional[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 | -| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreateBYOKKeyResponse](/client-sdks/python/api-reference/components/createbyokkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its `id`. The encrypted key material is wiped and the record is marked as deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="deleteBYOKKey" method="delete" path="/byok/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.byok.delete(id="11111111-2222-3333-4444-555555555555") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.DeleteBYOKKeyResponse](/client-sdks/python/api-reference/components/deletebyokkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single bring-your-own-key (BYOK) provider credential by its `id`. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getBYOKKey" method="get" path="/byok/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.byok.get(id="11111111-2222-3333-4444-555555555555") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GetBYOKKeyResponse](/client-sdks/python/api-reference/components/getbyokkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing bring-your-own-key (BYOK) provider credential by its `id`. Include the `key` field to rotate the raw provider API key in-place (the previous key material is overwritten). [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="updateBYOKKey" method="patch" path="/byok/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.byok.update(id="11111111-2222-3333-4444-555555555555", disabled=False, name="Updated OpenAI Key") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `is_fallback` | *Optional[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` | *Optional[str]* | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.UpdateBYOKKeyResponse](/client-sdks/python/api-reference/components/updatebyokkeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/chat.mdx b/client-sdks/python/api-reference/chat.mdx deleted file mode 100644 index b7345d05..00000000 --- a/client-sdks/python/api-reference/chat.mdx +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: Chat - Python SDK -sidebarTitle: Chat -description: Chat method reference -seoTitle: Chat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/chat' -'og:site_name': OpenRouter Documentation -'og:title': Chat | OpenRouter Python SDK -'og:description': >- - Chat method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Chat%20-%20Python%20SDK&description=Chat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: comments ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -### Available Operations - -* [send](#send) - Create a chat completion - -## send - -Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes. - -### Example Usage - -{/* UsageSnippet language="python" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" */} -```python expandable lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.chat.send(messages=[ - { - "content": "You are a helpful assistant.", - "role": "system", - }, - { - "content": "What is the capital of France?", - "role": "user", - }, - ], x_open_router_experimental_metadata="enabled", max_tokens=150, model="openai/gpt-4", stream=False, temperature=0.7) - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `messages` | List[[components.ChatMessages](/client-sdks/python/api-reference/components/chatmessages)] | :heavy_check_mark: | List of messages for the conversation | [
`{"content": "Hello!","role": "user"}`
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_experimental_metadata` | [Optional[components.MetadataLevel]](/client-sdks/python/api-reference/components/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](/client-sdks/python/api-reference/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `debug` | [Optional[components.ChatDebugOptions]](/client-sdks/python/api-reference/components/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | `{"echo_upstream_body": true}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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"}` | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | `{"50256": -100}` | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | :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"}` | -| `modalities` | List[[components.Modality](/client-sdks/python/api-reference/components/modality)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](/client-sdks/python/api-reference/components/chatrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [Optional[components.ChatRequestReasoning]](/client-sdks/python/api-reference/components/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | `{"effort": "medium","summary": "concise"}` | -| `response_format` | [Optional[components.ResponseFormat]](/client-sdks/python/api-reference/components/responseformat) | :heavy_minus_sign: | Response format configuration | `{"type": "json_object"}` | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](/client-sdks/python/api-reference/components/chatrequestservicetier) | :heavy_minus_sign: | The service tier to use for processing this request. | auto | -| `session_id` | *Optional[str]* | :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[components.Stop]](/client-sdks/python/api-reference/components/stop) | :heavy_minus_sign: | Stop sequences (up to 4) | [
""
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](/client-sdks/python/api-reference/components/chatstreamoptions) | :heavy_minus_sign: | Streaming configuration options | `{"include_usage": true}` | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](/client-sdks/python/api-reference/components/chattoolchoice) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](/client-sdks/python/api-reference/components/chatfunctiontool)] | :heavy_minus_sign: | Available tools for function calling | [
`{"function": {"description": "Get weather","name": "get_weather"}`,
"type": "function"
\}
] | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](/client-sdks/python/api-reference/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` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | user-123 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.SendChatCompletionRequestResponse](/client-sdks/python/api-reference/operations/sendchatcompletionrequestresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.RequestTimeoutResponseError | 408 | application/json | -| errors.PayloadTooLargeResponseError | 413 | application/json | -| errors.UnprocessableEntityResponseError | 422 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/action.mdx b/client-sdks/python/api-reference/components/action.mdx deleted file mode 100644 index fa825d50..00000000 --- a/client-sdks/python/api-reference/components/action.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Action - Python SDK -sidebarTitle: Action -description: Action method reference -seoTitle: Action | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/action' -'og:site_name': OpenRouter Documentation -'og:title': Action | OpenRouter Python SDK -'og:description': >- - Action method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Action%20-%20Python%20SDK&description=Action%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputWebSearchCallItemActionSearch` - -```python lines -value: components.OutputWebSearchCallItemActionSearch = /* values here */ -``` - -### `components.ActionOpenPage` - -```python lines -value: components.ActionOpenPage = /* values here */ -``` - -### `components.ActionFindInPage` - -```python lines -value: components.ActionFindInPage = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/actionenum.mdx b/client-sdks/python/api-reference/components/actionenum.mdx deleted file mode 100644 index 8ae2cef3..00000000 --- a/client-sdks/python/api-reference/components/actionenum.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ActionEnum - Python SDK -sidebarTitle: ActionEnum -description: ActionEnum method reference -seoTitle: ActionEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/actionenum' -'og:site_name': OpenRouter Documentation -'og:title': ActionEnum | OpenRouter Python SDK -'og:description': >- - ActionEnum method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionEnum%20-%20Python%20SDK&description=ActionEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `READ` | read | -| `WRITE` | write | -| `DELETE` | delete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/actionfindinpage.mdx b/client-sdks/python/api-reference/components/actionfindinpage.mdx deleted file mode 100644 index b9dbd461..00000000 --- a/client-sdks/python/api-reference/components/actionfindinpage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ActionFindInPage - Python SDK -sidebarTitle: ActionFindInPage -description: ActionFindInPage method reference -seoTitle: ActionFindInPage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/actionfindinpage -'og:site_name': OpenRouter Documentation -'og:title': ActionFindInPage | OpenRouter Python SDK -'og:description': >- - ActionFindInPage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionFindInPage%20-%20Python%20SDK&description=ActionFindInPage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `pattern` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeFindInPage](/client-sdks/python/api-reference/components/typefindinpage) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/actionopenpage.mdx b/client-sdks/python/api-reference/components/actionopenpage.mdx deleted file mode 100644 index 9cb3544b..00000000 --- a/client-sdks/python/api-reference/components/actionopenpage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ActionOpenPage - Python SDK -sidebarTitle: ActionOpenPage -description: ActionOpenPage method reference -seoTitle: ActionOpenPage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/actionopenpage' -'og:site_name': OpenRouter Documentation -'og:title': ActionOpenPage | OpenRouter Python SDK -'og:description': >- - ActionOpenPage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionOpenPage%20-%20Python%20SDK&description=ActionOpenPage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `type` | [components.TypeOpenPage](/client-sdks/python/api-reference/components/typeopenpage) | :heavy_check_mark: | N/A | -| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/actiontypesearch.mdx b/client-sdks/python/api-reference/components/actiontypesearch.mdx deleted file mode 100644 index ac581df7..00000000 --- a/client-sdks/python/api-reference/components/actiontypesearch.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ActionTypeSearch - Python SDK -sidebarTitle: ActionTypeSearch -description: ActionTypeSearch method reference -seoTitle: ActionTypeSearch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/actiontypesearch -'og:site_name': OpenRouter Documentation -'og:title': ActionTypeSearch | OpenRouter Python SDK -'og:description': >- - ActionTypeSearch method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionTypeSearch%20-%20Python%20SDK&description=ActionTypeSearch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SEARCH` | search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/activityitem.mdx b/client-sdks/python/api-reference/components/activityitem.mdx deleted file mode 100644 index 1e6ef90e..00000000 --- a/client-sdks/python/api-reference/components/activityitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ActivityItem - Python SDK -sidebarTitle: ActivityItem -description: ActivityItem method reference -seoTitle: ActivityItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/activityitem' -'og:site_name': OpenRouter Documentation -'og:title': ActivityItem | OpenRouter Python SDK -'og:description': >- - ActivityItem method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityItem%20-%20Python%20SDK&description=ActivityItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `completion_tokens` | *int* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `prompt_tokens` | *int* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `reasoning_tokens` | *int* | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `requests` | *int* | :heavy_check_mark: | Number of requests made | 5 | -| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/activityresponse.mdx b/client-sdks/python/api-reference/components/activityresponse.mdx deleted file mode 100644 index 18aebcff..00000000 --- a/client-sdks/python/api-reference/components/activityresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ActivityResponse - Python SDK -sidebarTitle: ActivityResponse -description: ActivityResponse method reference -seoTitle: ActivityResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/activityresponse -'og:site_name': OpenRouter Documentation -'og:title': ActivityResponse | OpenRouter Python SDK -'og:description': >- - ActivityResponse method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityResponse%20-%20Python%20SDK&description=ActivityResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | List[[components.ActivityItem](/client-sdks/python/api-reference/components/activityitem)] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/allowedtools.mdx b/client-sdks/python/api-reference/components/allowedtools.mdx deleted file mode 100644 index df85f4e2..00000000 --- a/client-sdks/python/api-reference/components/allowedtools.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AllowedTools - Python SDK -sidebarTitle: AllowedTools -description: AllowedTools method reference -seoTitle: AllowedTools | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/allowedtools' -'og:site_name': OpenRouter Documentation -'og:title': AllowedTools | OpenRouter Python SDK -'og:description': >- - AllowedTools method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedTools%20-%20Python%20SDK&description=AllowedTools%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `read_only` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/allowedtoolsunion.mdx b/client-sdks/python/api-reference/components/allowedtoolsunion.mdx deleted file mode 100644 index ed18cd51..00000000 --- a/client-sdks/python/api-reference/components/allowedtoolsunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AllowedToolsUnion - Python SDK -sidebarTitle: AllowedToolsUnion -description: AllowedToolsUnion method reference -seoTitle: AllowedToolsUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/allowedtoolsunion -'og:site_name': OpenRouter Documentation -'og:title': AllowedToolsUnion | OpenRouter Python SDK -'og:description': >- - AllowedToolsUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedToolsUnion%20-%20Python%20SDK&description=AllowedToolsUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `components.AllowedTools` - -```python lines -value: components.AllowedTools = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/always.mdx b/client-sdks/python/api-reference/components/always.mdx deleted file mode 100644 index 28566549..00000000 --- a/client-sdks/python/api-reference/components/always.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Always - Python SDK -sidebarTitle: Always -description: Always method reference -seoTitle: Always | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/always' -'og:site_name': OpenRouter Documentation -'og:title': Always | OpenRouter Python SDK -'og:description': >- - Always method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Always%20-%20Python%20SDK&description=Always%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/analysis.mdx b/client-sdks/python/api-reference/components/analysis.mdx deleted file mode 100644 index 4d03825b..00000000 --- a/client-sdks/python/api-reference/components/analysis.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Analysis - Python SDK -sidebarTitle: Analysis -description: Analysis method reference -seoTitle: Analysis | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/analysis' -'og:site_name': OpenRouter Documentation -'og:title': Analysis | OpenRouter Python SDK -'og:description': >- - Analysis method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analysis%20-%20Python%20SDK&description=Analysis%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Structured analysis produced by the fusion judge model. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `blind_spots` | List[*str*] | :heavy_check_mark: | N/A | -| `consensus` | List[*str*] | :heavy_check_mark: | N/A | -| `contradictions` | List[[components.Contradiction](/client-sdks/python/api-reference/components/contradiction)] | :heavy_check_mark: | N/A | -| `partial_coverage` | List[[components.PartialCoverage](/client-sdks/python/api-reference/components/partialcoverage)] | :heavy_check_mark: | N/A | -| `unique_insights` | List[[components.UniqueInsight](/client-sdks/python/api-reference/components/uniqueinsight)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/annotationaddedevent.mdx b/client-sdks/python/api-reference/components/annotationaddedevent.mdx deleted file mode 100644 index 8fb08294..00000000 --- a/client-sdks/python/api-reference/components/annotationaddedevent.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnnotationAddedEvent - Python SDK -sidebarTitle: AnnotationAddedEvent -description: AnnotationAddedEvent method reference -seoTitle: AnnotationAddedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/annotationaddedevent -'og:site_name': OpenRouter Documentation -'og:title': AnnotationAddedEvent | OpenRouter Python SDK -'og:description': >- - AnnotationAddedEvent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnnotationAddedEvent%20-%20Python%20SDK&description=AnnotationAddedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a text annotation is added to output - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `annotation` | [components.OpenAIResponsesAnnotation](/client-sdks/python/api-reference/components/openairesponsesannotation) | :heavy_check_mark: | N/A | `{"file_id": "file-abc123","filename": "research_paper.pdf","index": 0,"type": "file_citation"}` | -| `annotation_index` | *int* | :heavy_check_mark: | N/A | | -| `content_index` | *int* | :heavy_check_mark: | N/A | | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.AnnotationAddedEventType](/client-sdks/python/api-reference/components/annotationaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/annotationaddedeventtype.mdx b/client-sdks/python/api-reference/components/annotationaddedeventtype.mdx deleted file mode 100644 index e75590e2..00000000 --- a/client-sdks/python/api-reference/components/annotationaddedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnnotationAddedEventType - Python SDK -sidebarTitle: AnnotationAddedEventType -description: AnnotationAddedEventType method reference -seoTitle: AnnotationAddedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/annotationaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': AnnotationAddedEventType | OpenRouter Python SDK -'og:description': >- - AnnotationAddedEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnnotationAddedEventType%20-%20Python%20SDK&description=AnnotationAddedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED` | response.output_text.annotation.added | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicallowedcallers.mdx b/client-sdks/python/api-reference/components/anthropicallowedcallers.mdx deleted file mode 100644 index c886dc80..00000000 --- a/client-sdks/python/api-reference/components/anthropicallowedcallers.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicAllowedCallers - Python SDK -sidebarTitle: AnthropicAllowedCallers -description: AnthropicAllowedCallers method reference -seoTitle: AnthropicAllowedCallers | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicallowedcallers -'og:site_name': OpenRouter Documentation -'og:title': AnthropicAllowedCallers | OpenRouter Python SDK -'og:description': >- - AnthropicAllowedCallers method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicAllowedCallers%20-%20Python%20SDK&description=AnthropicAllowedCallers%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `DIRECT` | direct | -| `CODE_EXECUTION_20250825` | code_execution_20250825 | -| `CODE_EXECUTION_20260120` | code_execution_20260120 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicbase64imagesource.mdx b/client-sdks/python/api-reference/components/anthropicbase64imagesource.mdx deleted file mode 100644 index 8bcf33ad..00000000 --- a/client-sdks/python/api-reference/components/anthropicbase64imagesource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicBase64ImageSource - Python SDK -sidebarTitle: AnthropicBase64ImageSource -description: AnthropicBase64ImageSource method reference -seoTitle: AnthropicBase64ImageSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicbase64imagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64ImageSource | OpenRouter Python SDK -'og:description': >- - AnthropicBase64ImageSource method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64ImageSource%20-%20Python%20SDK&description=AnthropicBase64ImageSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | | -| `media_type` | [components.AnthropicImageMimeType](/client-sdks/python/api-reference/components/anthropicimagemimetype) | :heavy_check_mark: | N/A | image/jpeg | -| `type` | [components.AnthropicBase64ImageSourceType](/client-sdks/python/api-reference/components/anthropicbase64imagesourcetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicbase64imagesourcetype.mdx b/client-sdks/python/api-reference/components/anthropicbase64imagesourcetype.mdx deleted file mode 100644 index 3e027608..00000000 --- a/client-sdks/python/api-reference/components/anthropicbase64imagesourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicBase64ImageSourceType - Python SDK -sidebarTitle: AnthropicBase64ImageSourceType -description: AnthropicBase64ImageSourceType method reference -seoTitle: AnthropicBase64ImageSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicbase64imagesourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64ImageSourceType | OpenRouter Python SDK -'og:description': >- - AnthropicBase64ImageSourceType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64ImageSourceType%20-%20Python%20SDK&description=AnthropicBase64ImageSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `BASE64` | base64 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicbase64pdfsource.mdx b/client-sdks/python/api-reference/components/anthropicbase64pdfsource.mdx deleted file mode 100644 index 85651042..00000000 --- a/client-sdks/python/api-reference/components/anthropicbase64pdfsource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicBase64PdfSource - Python SDK -sidebarTitle: AnthropicBase64PdfSource -description: AnthropicBase64PdfSource method reference -seoTitle: AnthropicBase64PdfSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicbase64pdfsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSource | OpenRouter Python SDK -'og:description': >- - AnthropicBase64PdfSource method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSource%20-%20Python%20SDK&description=AnthropicBase64PdfSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `media_type` | [components.AnthropicBase64PdfSourceMediaType](/client-sdks/python/api-reference/components/anthropicbase64pdfsourcemediatype) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicBase64PdfSourceType](/client-sdks/python/api-reference/components/anthropicbase64pdfsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicbase64pdfsourcemediatype.mdx b/client-sdks/python/api-reference/components/anthropicbase64pdfsourcemediatype.mdx deleted file mode 100644 index f566c876..00000000 --- a/client-sdks/python/api-reference/components/anthropicbase64pdfsourcemediatype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicBase64PdfSourceMediaType - Python SDK -sidebarTitle: AnthropicBase64PdfSourceMediaType -description: AnthropicBase64PdfSourceMediaType method reference -seoTitle: AnthropicBase64PdfSourceMediaType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicbase64pdfsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSourceMediaType | OpenRouter Python SDK -'og:description': >- - AnthropicBase64PdfSourceMediaType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSourceMediaType%20-%20Python%20SDK&description=AnthropicBase64PdfSourceMediaType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `APPLICATION_PDF` | application/pdf | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicbase64pdfsourcetype.mdx b/client-sdks/python/api-reference/components/anthropicbase64pdfsourcetype.mdx deleted file mode 100644 index bcd2b73c..00000000 --- a/client-sdks/python/api-reference/components/anthropicbase64pdfsourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicBase64PdfSourceType - Python SDK -sidebarTitle: AnthropicBase64PdfSourceType -description: AnthropicBase64PdfSourceType method reference -seoTitle: AnthropicBase64PdfSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicbase64pdfsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSourceType | OpenRouter Python SDK -'og:description': >- - AnthropicBase64PdfSourceType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSourceType%20-%20Python%20SDK&description=AnthropicBase64PdfSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `BASE64` | base64 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccachecontroldirective.mdx b/client-sdks/python/api-reference/components/anthropiccachecontroldirective.mdx deleted file mode 100644 index d72b09fd..00000000 --- a/client-sdks/python/api-reference/components/anthropiccachecontroldirective.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AnthropicCacheControlDirective - Python SDK -sidebarTitle: AnthropicCacheControlDirective -description: AnthropicCacheControlDirective method reference -seoTitle: AnthropicCacheControlDirective | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccachecontroldirective -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirective | OpenRouter Python SDK -'og:description': >- - AnthropicCacheControlDirective method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirective%20-%20Python%20SDK&description=AnthropicCacheControlDirective%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.md) | :heavy_minus_sign: | N/A | 5m | -| `type` | [components.AnthropicCacheControlDirectiveType](/client-sdks/python/api-reference/components/anthropiccachecontroldirectivetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccachecontroldirectivetype.mdx b/client-sdks/python/api-reference/components/anthropiccachecontroldirectivetype.mdx deleted file mode 100644 index 7c88d48a..00000000 --- a/client-sdks/python/api-reference/components/anthropiccachecontroldirectivetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCacheControlDirectiveType - Python SDK -sidebarTitle: AnthropicCacheControlDirectiveType -description: AnthropicCacheControlDirectiveType method reference -seoTitle: AnthropicCacheControlDirectiveType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccachecontroldirectivetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirectiveType | OpenRouter Python SDK -'og:description': >- - AnthropicCacheControlDirectiveType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirectiveType%20-%20Python%20SDK&description=AnthropicCacheControlDirectiveType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `EPHEMERAL` | ephemeral | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccachecontrolttl.mdx b/client-sdks/python/api-reference/components/anthropiccachecontrolttl.mdx deleted file mode 100644 index c9ac33ae..00000000 --- a/client-sdks/python/api-reference/components/anthropiccachecontrolttl.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicCacheControlTTL - Python SDK -sidebarTitle: AnthropicCacheControlTTL -description: AnthropicCacheControlTTL method reference -seoTitle: AnthropicCacheControlTTL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccachecontrolttl -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlTTL | OpenRouter Python SDK -'og:description': >- - AnthropicCacheControlTTL method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlTTL%20-%20Python%20SDK&description=AnthropicCacheControlTTL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `FIVEM` | 5m | -| `ONEH` | 1h | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationcharlocationparam.mdx b/client-sdks/python/api-reference/components/anthropiccitationcharlocationparam.mdx deleted file mode 100644 index 5e778870..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationcharlocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationCharLocationParam - Python SDK -sidebarTitle: AnthropicCitationCharLocationParam -description: AnthropicCitationCharLocationParam method reference -seoTitle: AnthropicCitationCharLocationParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationcharlocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationCharLocationParam | OpenRouter Python SDK -'og:description': >- - AnthropicCitationCharLocationParam method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationCharLocationParam%20-%20Python%20SDK&description=AnthropicCitationCharLocationParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_char_index` | *int* | :heavy_check_mark: | N/A | -| `start_char_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationCharLocationParamType](/client-sdks/python/api-reference/components/anthropiccitationcharlocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationcharlocationparamtype.mdx b/client-sdks/python/api-reference/components/anthropiccitationcharlocationparamtype.mdx deleted file mode 100644 index 5055ee0a..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationcharlocationparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCitationCharLocationParamType - Python SDK -sidebarTitle: AnthropicCitationCharLocationParamType -description: AnthropicCitationCharLocationParamType method reference -seoTitle: AnthropicCitationCharLocationParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationcharlocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationCharLocationParamType | OpenRouter Python SDK -'og:description': >- - AnthropicCitationCharLocationParamType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationCharLocationParamType%20-%20Python%20SDK&description=AnthropicCitationCharLocationParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `CHAR_LOCATION` | char_location | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparam.mdx b/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparam.mdx deleted file mode 100644 index 24c76900..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationContentBlockLocationParam - Python SDK -sidebarTitle: AnthropicCitationContentBlockLocationParam -description: AnthropicCitationContentBlockLocationParam method reference -seoTitle: AnthropicCitationContentBlockLocationParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationcontentblocklocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationContentBlockLocationParam | OpenRouter Python SDK -'og:description': >- - AnthropicCitationContentBlockLocationParam method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationContentBlockLocationParam%20-%20Python%20SDK&description=AnthropicCitationContentBlockLocationParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationContentBlockLocationParamType](/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparamtype.mdx b/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparamtype.mdx deleted file mode 100644 index a5372e52..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationcontentblocklocationparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCitationContentBlockLocationParamType - Python SDK -sidebarTitle: AnthropicCitationContentBlockLocationParamType -description: AnthropicCitationContentBlockLocationParamType method reference -seoTitle: AnthropicCitationContentBlockLocationParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationcontentblocklocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationContentBlockLocationParamType | OpenRouter Python SDK -'og:description': >- - AnthropicCitationContentBlockLocationParamType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationContentBlockLocationParamType%20-%20Python%20SDK&description=AnthropicCitationContentBlockLocationParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `CONTENT_BLOCK_LOCATION` | content_block_location | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationpagelocationparam.mdx b/client-sdks/python/api-reference/components/anthropiccitationpagelocationparam.mdx deleted file mode 100644 index 519f9fce..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationpagelocationparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicCitationPageLocationParam - Python SDK -sidebarTitle: AnthropicCitationPageLocationParam -description: AnthropicCitationPageLocationParam method reference -seoTitle: AnthropicCitationPageLocationParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationpagelocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationPageLocationParam | OpenRouter Python SDK -'og:description': >- - AnthropicCitationPageLocationParam method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationPageLocationParam%20-%20Python%20SDK&description=AnthropicCitationPageLocationParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `document_index` | *int* | :heavy_check_mark: | N/A | -| `document_title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `end_page_number` | *int* | :heavy_check_mark: | N/A | -| `start_page_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationPageLocationParamType](/client-sdks/python/api-reference/components/anthropiccitationpagelocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationpagelocationparamtype.mdx b/client-sdks/python/api-reference/components/anthropiccitationpagelocationparamtype.mdx deleted file mode 100644 index 3cb45bba..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationpagelocationparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCitationPageLocationParamType - Python SDK -sidebarTitle: AnthropicCitationPageLocationParamType -description: AnthropicCitationPageLocationParamType method reference -seoTitle: AnthropicCitationPageLocationParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationpagelocationparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationPageLocationParamType | OpenRouter Python SDK -'og:description': >- - AnthropicCitationPageLocationParamType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationPageLocationParamType%20-%20Python%20SDK&description=AnthropicCitationPageLocationParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `PAGE_LOCATION` | page_location | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocation.mdx b/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocation.mdx deleted file mode 100644 index 25520c58..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocation.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: AnthropicCitationSearchResultLocation - Python SDK -sidebarTitle: AnthropicCitationSearchResultLocation -description: AnthropicCitationSearchResultLocation method reference -seoTitle: AnthropicCitationSearchResultLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationSearchResultLocation | OpenRouter Python SDK -'og:description': >- - AnthropicCitationSearchResultLocation method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationSearchResultLocation%20-%20Python%20SDK&description=AnthropicCitationSearchResultLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `end_block_index` | *int* | :heavy_check_mark: | N/A | -| `search_result_index` | *int* | :heavy_check_mark: | N/A | -| `source` | *str* | :heavy_check_mark: | N/A | -| `start_block_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationSearchResultLocationType](/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocationtype.mdx b/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocationtype.mdx deleted file mode 100644 index 32468bf6..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationsearchresultlocationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCitationSearchResultLocationType - Python SDK -sidebarTitle: AnthropicCitationSearchResultLocationType -description: AnthropicCitationSearchResultLocationType method reference -seoTitle: AnthropicCitationSearchResultLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationsearchresultlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationSearchResultLocationType | OpenRouter Python SDK -'og:description': >- - AnthropicCitationSearchResultLocationType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationSearchResultLocationType%20-%20Python%20SDK&description=AnthropicCitationSearchResultLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `SEARCH_RESULT_LOCATION` | search_result_location | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocation.mdx b/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocation.mdx deleted file mode 100644 index 73513824..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicCitationWebSearchResultLocation - Python SDK -sidebarTitle: AnthropicCitationWebSearchResultLocation -description: AnthropicCitationWebSearchResultLocation method reference -seoTitle: AnthropicCitationWebSearchResultLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationwebsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationWebSearchResultLocation | OpenRouter Python SDK -'og:description': >- - AnthropicCitationWebSearchResultLocation method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationWebSearchResultLocation%20-%20Python%20SDK&description=AnthropicCitationWebSearchResultLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `cited_text` | *str* | :heavy_check_mark: | N/A | -| `encrypted_index` | *str* | :heavy_check_mark: | N/A | -| `title` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicCitationWebSearchResultLocationType](/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocationtype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocationtype.mdx b/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocationtype.mdx deleted file mode 100644 index 57d581bf..00000000 --- a/client-sdks/python/api-reference/components/anthropiccitationwebsearchresultlocationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicCitationWebSearchResultLocationType - Python SDK -sidebarTitle: AnthropicCitationWebSearchResultLocationType -description: AnthropicCitationWebSearchResultLocationType method reference -seoTitle: AnthropicCitationWebSearchResultLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropiccitationwebsearchresultlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationWebSearchResultLocationType | OpenRouter Python SDK -'og:description': >- - AnthropicCitationWebSearchResultLocationType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationWebSearchResultLocationType%20-%20Python%20SDK&description=AnthropicCitationWebSearchResultLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `WEB_SEARCH_RESULT_LOCATION` | web_search_result_location | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicdocumentblockparam.mdx b/client-sdks/python/api-reference/components/anthropicdocumentblockparam.mdx deleted file mode 100644 index 0bd729ae..00000000 --- a/client-sdks/python/api-reference/components/anthropicdocumentblockparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicDocumentBlockParam - Python SDK -sidebarTitle: AnthropicDocumentBlockParam -description: AnthropicDocumentBlockParam method reference -seoTitle: AnthropicDocumentBlockParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicdocumentblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParam | OpenRouter Python SDK -'og:description': >- - AnthropicDocumentBlockParam method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParam%20-%20Python%20SDK&description=AnthropicDocumentBlockParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | [OptionalNullable[components.AnthropicDocumentBlockParamCitations]](../components/anthropicdocumentblockparamcitations.md) | :heavy_minus_sign: | N/A | | -| `context` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `source` | [components.AnthropicDocumentBlockParamSourceUnion](/client-sdks/python/api-reference/components/anthropicdocumentblockparamsourceunion) | :heavy_check_mark: | N/A | | -| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.TypeDocument](/client-sdks/python/api-reference/components/typedocument) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcitations.mdx b/client-sdks/python/api-reference/components/anthropicdocumentblockparamcitations.mdx deleted file mode 100644 index 81a18c19..00000000 --- a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcitations.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicDocumentBlockParamCitations - Python SDK -sidebarTitle: AnthropicDocumentBlockParamCitations -description: AnthropicDocumentBlockParamCitations method reference -seoTitle: AnthropicDocumentBlockParamCitations | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicdocumentblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamCitations | OpenRouter Python SDK -'og:description': >- - AnthropicDocumentBlockParamCitations method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamCitations%20-%20Python%20SDK&description=AnthropicDocumentBlockParamCitations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent1.mdx b/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent1.mdx deleted file mode 100644 index ec7bcda2..00000000 --- a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent1 - Python SDK -sidebarTitle: AnthropicDocumentBlockParamContent1 -description: AnthropicDocumentBlockParamContent1 method reference -seoTitle: AnthropicDocumentBlockParamContent1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicdocumentblockparamcontent1 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent1 | OpenRouter Python SDK -'og:description': >- - AnthropicDocumentBlockParamContent1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent1%20-%20Python%20SDK&description=AnthropicDocumentBlockParamContent1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicImageBlockParam` - -```python lines -value: components.AnthropicImageBlockParam = /* values here */ -``` - -### `components.AnthropicTextBlockParam` - -```python lines -value: components.AnthropicTextBlockParam = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent2.mdx b/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent2.mdx deleted file mode 100644 index a133abe9..00000000 --- a/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent2 - Python SDK -sidebarTitle: AnthropicDocumentBlockParamContent2 -description: AnthropicDocumentBlockParamContent2 method reference -seoTitle: AnthropicDocumentBlockParamContent2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicdocumentblockparamcontent2 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent2 | OpenRouter Python SDK -'og:description': >- - AnthropicDocumentBlockParamContent2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent2%20-%20Python%20SDK&description=AnthropicDocumentBlockParamContent2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.AnthropicDocumentBlockParamContent1]` - -```python lines -value: List[components.AnthropicDocumentBlockParamContent1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicdocumentblockparamsourceunion.mdx b/client-sdks/python/api-reference/components/anthropicdocumentblockparamsourceunion.mdx deleted file mode 100644 index ad3f7e29..00000000 --- a/client-sdks/python/api-reference/components/anthropicdocumentblockparamsourceunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AnthropicDocumentBlockParamSourceUnion - Python SDK -sidebarTitle: AnthropicDocumentBlockParamSourceUnion -description: AnthropicDocumentBlockParamSourceUnion method reference -seoTitle: AnthropicDocumentBlockParamSourceUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicdocumentblockparamsourceunion -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamSourceUnion | OpenRouter Python SDK -'og:description': >- - AnthropicDocumentBlockParamSourceUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamSourceUnion%20-%20Python%20SDK&description=AnthropicDocumentBlockParamSourceUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicBase64PdfSource` - -```python lines -value: components.AnthropicBase64PdfSource = /* values here */ -``` - -### `components.AnthropicPlainTextSource` - -```python lines -value: components.AnthropicPlainTextSource = /* values here */ -``` - -### `components.SourceContent` - -```python lines -value: components.SourceContent = /* values here */ -``` - -### `components.AnthropicURLPdfSource` - -```python lines -value: components.AnthropicURLPdfSource = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicimageblockparam.mdx b/client-sdks/python/api-reference/components/anthropicimageblockparam.mdx deleted file mode 100644 index c8b29a38..00000000 --- a/client-sdks/python/api-reference/components/anthropicimageblockparam.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicImageBlockParam - Python SDK -sidebarTitle: AnthropicImageBlockParam -description: AnthropicImageBlockParam method reference -seoTitle: AnthropicImageBlockParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicimageblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParam | OpenRouter Python SDK -'og:description': >- - AnthropicImageBlockParam method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParam%20-%20Python%20SDK&description=AnthropicImageBlockParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `source` | [components.AnthropicImageBlockParamSource](/client-sdks/python/api-reference/components/anthropicimageblockparamsource) | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicImageBlockParamType](/client-sdks/python/api-reference/components/anthropicimageblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicimageblockparamsource.mdx b/client-sdks/python/api-reference/components/anthropicimageblockparamsource.mdx deleted file mode 100644 index 7418d36e..00000000 --- a/client-sdks/python/api-reference/components/anthropicimageblockparamsource.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicImageBlockParamSource - Python SDK -sidebarTitle: AnthropicImageBlockParamSource -description: AnthropicImageBlockParamSource method reference -seoTitle: AnthropicImageBlockParamSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicimageblockparamsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParamSource | OpenRouter Python SDK -'og:description': >- - AnthropicImageBlockParamSource method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParamSource%20-%20Python%20SDK&description=AnthropicImageBlockParamSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicBase64ImageSource` - -```python lines -value: components.AnthropicBase64ImageSource = /* values here */ -``` - -### `components.AnthropicURLImageSource` - -```python lines -value: components.AnthropicURLImageSource = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicimageblockparamtype.mdx b/client-sdks/python/api-reference/components/anthropicimageblockparamtype.mdx deleted file mode 100644 index 3900b9a1..00000000 --- a/client-sdks/python/api-reference/components/anthropicimageblockparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicImageBlockParamType - Python SDK -sidebarTitle: AnthropicImageBlockParamType -description: AnthropicImageBlockParamType method reference -seoTitle: AnthropicImageBlockParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicimageblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParamType | OpenRouter Python SDK -'og:description': >- - AnthropicImageBlockParamType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParamType%20-%20Python%20SDK&description=AnthropicImageBlockParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicimagemimetype.mdx b/client-sdks/python/api-reference/components/anthropicimagemimetype.mdx deleted file mode 100644 index 0ba3bc98..00000000 --- a/client-sdks/python/api-reference/components/anthropicimagemimetype.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AnthropicImageMimeType - Python SDK -sidebarTitle: AnthropicImageMimeType -description: AnthropicImageMimeType method reference -seoTitle: AnthropicImageMimeType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicimagemimetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageMimeType | OpenRouter Python SDK -'og:description': >- - AnthropicImageMimeType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageMimeType%20-%20Python%20SDK&description=AnthropicImageMimeType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `IMAGE_JPEG` | image/jpeg | -| `IMAGE_PNG` | image/png | -| `IMAGE_GIF` | image/gif | -| `IMAGE_WEBP` | image/webp | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicinputtokensclearatleast.mdx b/client-sdks/python/api-reference/components/anthropicinputtokensclearatleast.mdx deleted file mode 100644 index a75c89ff..00000000 --- a/client-sdks/python/api-reference/components/anthropicinputtokensclearatleast.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeast - Python SDK -sidebarTitle: AnthropicInputTokensClearAtLeast -description: AnthropicInputTokensClearAtLeast method reference -seoTitle: AnthropicInputTokensClearAtLeast | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicinputtokensclearatleast -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeast | OpenRouter Python SDK -'og:description': >- - AnthropicInputTokensClearAtLeast method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeast%20-%20Python%20SDK&description=AnthropicInputTokensClearAtLeast%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensClearAtLeastType](/client-sdks/python/api-reference/components/anthropicinputtokensclearatleasttype) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicinputtokensclearatleasttype.mdx b/client-sdks/python/api-reference/components/anthropicinputtokensclearatleasttype.mdx deleted file mode 100644 index 38f724d1..00000000 --- a/client-sdks/python/api-reference/components/anthropicinputtokensclearatleasttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeastType - Python SDK -sidebarTitle: AnthropicInputTokensClearAtLeastType -description: AnthropicInputTokensClearAtLeastType method reference -seoTitle: AnthropicInputTokensClearAtLeastType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicinputtokensclearatleasttype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeastType | OpenRouter Python SDK -'og:description': >- - AnthropicInputTokensClearAtLeastType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeastType%20-%20Python%20SDK&description=AnthropicInputTokensClearAtLeastType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `INPUT_TOKENS` | input_tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicinputtokenstrigger.mdx b/client-sdks/python/api-reference/components/anthropicinputtokenstrigger.mdx deleted file mode 100644 index 72813209..00000000 --- a/client-sdks/python/api-reference/components/anthropicinputtokenstrigger.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicInputTokensTrigger - Python SDK -sidebarTitle: AnthropicInputTokensTrigger -description: AnthropicInputTokensTrigger method reference -seoTitle: AnthropicInputTokensTrigger | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicinputtokenstrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensTrigger | OpenRouter Python SDK -'og:description': >- - AnthropicInputTokensTrigger method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensTrigger%20-%20Python%20SDK&description=AnthropicInputTokensTrigger%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicInputTokensTriggerType](/client-sdks/python/api-reference/components/anthropicinputtokenstriggertype) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicinputtokenstriggertype.mdx b/client-sdks/python/api-reference/components/anthropicinputtokenstriggertype.mdx deleted file mode 100644 index 9fe72b06..00000000 --- a/client-sdks/python/api-reference/components/anthropicinputtokenstriggertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicInputTokensTriggerType - Python SDK -sidebarTitle: AnthropicInputTokensTriggerType -description: AnthropicInputTokensTriggerType method reference -seoTitle: AnthropicInputTokensTriggerType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicinputtokenstriggertype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensTriggerType | OpenRouter Python SDK -'og:description': >- - AnthropicInputTokensTriggerType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensTriggerType%20-%20Python%20SDK&description=AnthropicInputTokensTriggerType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `INPUT_TOKENS` | input_tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicplaintextsource.mdx b/client-sdks/python/api-reference/components/anthropicplaintextsource.mdx deleted file mode 100644 index 7569d601..00000000 --- a/client-sdks/python/api-reference/components/anthropicplaintextsource.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: AnthropicPlainTextSource - Python SDK -sidebarTitle: AnthropicPlainTextSource -description: AnthropicPlainTextSource method reference -seoTitle: AnthropicPlainTextSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicplaintextsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSource | OpenRouter Python SDK -'og:description': >- - AnthropicPlainTextSource method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSource%20-%20Python%20SDK&description=AnthropicPlainTextSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `media_type` | [components.AnthropicPlainTextSourceMediaType](/client-sdks/python/api-reference/components/anthropicplaintextsourcemediatype) | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicPlainTextSourceType](/client-sdks/python/api-reference/components/anthropicplaintextsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicplaintextsourcemediatype.mdx b/client-sdks/python/api-reference/components/anthropicplaintextsourcemediatype.mdx deleted file mode 100644 index d3a2e8db..00000000 --- a/client-sdks/python/api-reference/components/anthropicplaintextsourcemediatype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicPlainTextSourceMediaType - Python SDK -sidebarTitle: AnthropicPlainTextSourceMediaType -description: AnthropicPlainTextSourceMediaType method reference -seoTitle: AnthropicPlainTextSourceMediaType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicplaintextsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSourceMediaType | OpenRouter Python SDK -'og:description': >- - AnthropicPlainTextSourceMediaType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSourceMediaType%20-%20Python%20SDK&description=AnthropicPlainTextSourceMediaType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `TEXT_PLAIN` | text/plain | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicplaintextsourcetype.mdx b/client-sdks/python/api-reference/components/anthropicplaintextsourcetype.mdx deleted file mode 100644 index 21f2782c..00000000 --- a/client-sdks/python/api-reference/components/anthropicplaintextsourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicPlainTextSourceType - Python SDK -sidebarTitle: AnthropicPlainTextSourceType -description: AnthropicPlainTextSourceType method reference -seoTitle: AnthropicPlainTextSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicplaintextsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSourceType | OpenRouter Python SDK -'og:description': >- - AnthropicPlainTextSourceType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSourceType%20-%20Python%20SDK&description=AnthropicPlainTextSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicsearchresultblockparam.mdx b/client-sdks/python/api-reference/components/anthropicsearchresultblockparam.mdx deleted file mode 100644 index 7eb011b9..00000000 --- a/client-sdks/python/api-reference/components/anthropicsearchresultblockparam.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AnthropicSearchResultBlockParam - Python SDK -sidebarTitle: AnthropicSearchResultBlockParam -description: AnthropicSearchResultBlockParam method reference -seoTitle: AnthropicSearchResultBlockParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParam | OpenRouter Python SDK -'og:description': >- - AnthropicSearchResultBlockParam method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParam%20-%20Python%20SDK&description=AnthropicSearchResultBlockParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | [Optional[components.AnthropicSearchResultBlockParamCitations]](../components/anthropicsearchresultblockparamcitations.md) | :heavy_minus_sign: | N/A | | -| `content` | List[[components.AnthropicTextBlockParam](/client-sdks/python/api-reference/components/anthropictextblockparam)] | :heavy_check_mark: | N/A | | -| `source` | *str* | :heavy_check_mark: | N/A | | -| `title` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicSearchResultBlockParamType](/client-sdks/python/api-reference/components/anthropicsearchresultblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicsearchresultblockparamcitations.mdx b/client-sdks/python/api-reference/components/anthropicsearchresultblockparamcitations.mdx deleted file mode 100644 index 31f2c75b..00000000 --- a/client-sdks/python/api-reference/components/anthropicsearchresultblockparamcitations.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicSearchResultBlockParamCitations - Python SDK -sidebarTitle: AnthropicSearchResultBlockParamCitations -description: AnthropicSearchResultBlockParamCitations method reference -seoTitle: AnthropicSearchResultBlockParamCitations | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicsearchresultblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParamCitations | OpenRouter Python SDK -'og:description': >- - AnthropicSearchResultBlockParamCitations method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParamCitations%20-%20Python%20SDK&description=AnthropicSearchResultBlockParamCitations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicsearchresultblockparamtype.mdx b/client-sdks/python/api-reference/components/anthropicsearchresultblockparamtype.mdx deleted file mode 100644 index e9a8ab6b..00000000 --- a/client-sdks/python/api-reference/components/anthropicsearchresultblockparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicSearchResultBlockParamType - Python SDK -sidebarTitle: AnthropicSearchResultBlockParamType -description: AnthropicSearchResultBlockParamType method reference -seoTitle: AnthropicSearchResultBlockParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicsearchresultblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParamType | OpenRouter Python SDK -'og:description': >- - AnthropicSearchResultBlockParamType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParamType%20-%20Python%20SDK&description=AnthropicSearchResultBlockParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `SEARCH_RESULT` | search_result | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictextblockparam.mdx b/client-sdks/python/api-reference/components/anthropictextblockparam.mdx deleted file mode 100644 index 5ce024aa..00000000 --- a/client-sdks/python/api-reference/components/anthropictextblockparam.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AnthropicTextBlockParam - Python SDK -sidebarTitle: AnthropicTextBlockParam -description: AnthropicTextBlockParam method reference -seoTitle: AnthropicTextBlockParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictextblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicTextBlockParam | OpenRouter Python SDK -'og:description': >- - AnthropicTextBlockParam method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicTextBlockParam%20-%20Python%20SDK&description=AnthropicTextBlockParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | List[[components.Citation](/client-sdks/python/api-reference/components/citation)] | :heavy_minus_sign: | N/A | | -| `text` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.AnthropicTextBlockParamType](/client-sdks/python/api-reference/components/anthropictextblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictextblockparamtype.mdx b/client-sdks/python/api-reference/components/anthropictextblockparamtype.mdx deleted file mode 100644 index 9ac74290..00000000 --- a/client-sdks/python/api-reference/components/anthropictextblockparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicTextBlockParamType - Python SDK -sidebarTitle: AnthropicTextBlockParamType -description: AnthropicTextBlockParamType method reference -seoTitle: AnthropicTextBlockParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictextblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicTextBlockParamType | OpenRouter Python SDK -'og:description': >- - AnthropicTextBlockParamType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicTextBlockParamType%20-%20Python%20SDK&description=AnthropicTextBlockParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicthinkingdisplay.mdx b/client-sdks/python/api-reference/components/anthropicthinkingdisplay.mdx deleted file mode 100644 index d3f086f4..00000000 --- a/client-sdks/python/api-reference/components/anthropicthinkingdisplay.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicThinkingDisplay - Python SDK -sidebarTitle: AnthropicThinkingDisplay -description: AnthropicThinkingDisplay method reference -seoTitle: AnthropicThinkingDisplay | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicthinkingdisplay -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingDisplay | OpenRouter Python SDK -'og:description': >- - AnthropicThinkingDisplay method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingDisplay%20-%20Python%20SDK&description=AnthropicThinkingDisplay%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `SUMMARIZED` | summarized | -| `OMITTED` | omitted | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicthinkingturns.mdx b/client-sdks/python/api-reference/components/anthropicthinkingturns.mdx deleted file mode 100644 index 7af12941..00000000 --- a/client-sdks/python/api-reference/components/anthropicthinkingturns.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicThinkingTurns - Python SDK -sidebarTitle: AnthropicThinkingTurns -description: AnthropicThinkingTurns method reference -seoTitle: AnthropicThinkingTurns | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicthinkingturns -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurns | OpenRouter Python SDK -'og:description': >- - AnthropicThinkingTurns method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurns%20-%20Python%20SDK&description=AnthropicThinkingTurns%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.AnthropicThinkingTurnsType](/client-sdks/python/api-reference/components/anthropicthinkingturnstype) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicthinkingturnstype.mdx b/client-sdks/python/api-reference/components/anthropicthinkingturnstype.mdx deleted file mode 100644 index 97cbc5a2..00000000 --- a/client-sdks/python/api-reference/components/anthropicthinkingturnstype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicThinkingTurnsType - Python SDK -sidebarTitle: AnthropicThinkingTurnsType -description: AnthropicThinkingTurnsType method reference -seoTitle: AnthropicThinkingTurnsType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicthinkingturnstype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurnsType | OpenRouter Python SDK -'og:description': >- - AnthropicThinkingTurnsType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurnsType%20-%20Python%20SDK&description=AnthropicThinkingTurnsType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `THINKING_TURNS` | thinking_turns | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictooluseskeep.mdx b/client-sdks/python/api-reference/components/anthropictooluseskeep.mdx deleted file mode 100644 index f01c8071..00000000 --- a/client-sdks/python/api-reference/components/anthropictooluseskeep.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicToolUsesKeep - Python SDK -sidebarTitle: AnthropicToolUsesKeep -description: AnthropicToolUsesKeep method reference -seoTitle: AnthropicToolUsesKeep | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictooluseskeep -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeep | OpenRouter Python SDK -'og:description': >- - AnthropicToolUsesKeep method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeep%20-%20Python%20SDK&description=AnthropicToolUsesKeep%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesKeepType](/client-sdks/python/api-reference/components/anthropictooluseskeeptype) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictooluseskeeptype.mdx b/client-sdks/python/api-reference/components/anthropictooluseskeeptype.mdx deleted file mode 100644 index 77945113..00000000 --- a/client-sdks/python/api-reference/components/anthropictooluseskeeptype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicToolUsesKeepType - Python SDK -sidebarTitle: AnthropicToolUsesKeepType -description: AnthropicToolUsesKeepType method reference -seoTitle: AnthropicToolUsesKeepType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictooluseskeeptype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeepType | OpenRouter Python SDK -'og:description': >- - AnthropicToolUsesKeepType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeepType%20-%20Python%20SDK&description=AnthropicToolUsesKeepType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `TOOL_USES` | tool_uses | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictoolusestrigger.mdx b/client-sdks/python/api-reference/components/anthropictoolusestrigger.mdx deleted file mode 100644 index f86ad159..00000000 --- a/client-sdks/python/api-reference/components/anthropictoolusestrigger.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicToolUsesTrigger - Python SDK -sidebarTitle: AnthropicToolUsesTrigger -description: AnthropicToolUsesTrigger method reference -seoTitle: AnthropicToolUsesTrigger | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictoolusestrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesTrigger | OpenRouter Python SDK -'og:description': >- - AnthropicToolUsesTrigger method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesTrigger%20-%20Python%20SDK&description=AnthropicToolUsesTrigger%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicToolUsesTriggerType](/client-sdks/python/api-reference/components/anthropictoolusestriggertype) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropictoolusestriggertype.mdx b/client-sdks/python/api-reference/components/anthropictoolusestriggertype.mdx deleted file mode 100644 index 4829064d..00000000 --- a/client-sdks/python/api-reference/components/anthropictoolusestriggertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicToolUsesTriggerType - Python SDK -sidebarTitle: AnthropicToolUsesTriggerType -description: AnthropicToolUsesTriggerType method reference -seoTitle: AnthropicToolUsesTriggerType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropictoolusestriggertype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesTriggerType | OpenRouter Python SDK -'og:description': >- - AnthropicToolUsesTriggerType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesTriggerType%20-%20Python%20SDK&description=AnthropicToolUsesTriggerType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `TOOL_USES` | tool_uses | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicurlimagesource.mdx b/client-sdks/python/api-reference/components/anthropicurlimagesource.mdx deleted file mode 100644 index 38b627e7..00000000 --- a/client-sdks/python/api-reference/components/anthropicurlimagesource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicURLImageSource - Python SDK -sidebarTitle: AnthropicURLImageSource -description: AnthropicURLImageSource method reference -seoTitle: AnthropicURLImageSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicurlimagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLImageSource | OpenRouter Python SDK -'og:description': >- - AnthropicURLImageSource method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLImageSource%20-%20Python%20SDK&description=AnthropicURLImageSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLImageSourceType](/client-sdks/python/api-reference/components/anthropicurlimagesourcetype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicurlimagesourcetype.mdx b/client-sdks/python/api-reference/components/anthropicurlimagesourcetype.mdx deleted file mode 100644 index 53b8a19c..00000000 --- a/client-sdks/python/api-reference/components/anthropicurlimagesourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicURLImageSourceType - Python SDK -sidebarTitle: AnthropicURLImageSourceType -description: AnthropicURLImageSourceType method reference -seoTitle: AnthropicURLImageSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicurlimagesourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLImageSourceType | OpenRouter Python SDK -'og:description': >- - AnthropicURLImageSourceType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLImageSourceType%20-%20Python%20SDK&description=AnthropicURLImageSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `URL` | url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicurlpdfsource.mdx b/client-sdks/python/api-reference/components/anthropicurlpdfsource.mdx deleted file mode 100644 index 70315939..00000000 --- a/client-sdks/python/api-reference/components/anthropicurlpdfsource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: AnthropicURLPdfSource - Python SDK -sidebarTitle: AnthropicURLPdfSource -description: AnthropicURLPdfSource method reference -seoTitle: AnthropicURLPdfSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicurlpdfsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLPdfSource | OpenRouter Python SDK -'og:description': >- - AnthropicURLPdfSource method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLPdfSource%20-%20Python%20SDK&description=AnthropicURLPdfSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `type` | [components.AnthropicURLPdfSourceType](/client-sdks/python/api-reference/components/anthropicurlpdfsourcetype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicurlpdfsourcetype.mdx b/client-sdks/python/api-reference/components/anthropicurlpdfsourcetype.mdx deleted file mode 100644 index 1abe533a..00000000 --- a/client-sdks/python/api-reference/components/anthropicurlpdfsourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicURLPdfSourceType - Python SDK -sidebarTitle: AnthropicURLPdfSourceType -description: AnthropicURLPdfSourceType method reference -seoTitle: AnthropicURLPdfSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicurlpdfsourcetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicURLPdfSourceType | OpenRouter Python SDK -'og:description': >- - AnthropicURLPdfSourceType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicURLPdfSourceType%20-%20Python%20SDK&description=AnthropicURLPdfSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `URL` | url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparam.mdx b/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparam.mdx deleted file mode 100644 index 0a757e17..00000000 --- a/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparam.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParam - Python SDK -sidebarTitle: AnthropicWebSearchResultBlockParam -description: AnthropicWebSearchResultBlockParam method reference -seoTitle: AnthropicWebSearchResultBlockParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicwebsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParam | OpenRouter Python SDK -'og:description': >- - AnthropicWebSearchResultBlockParam method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParam%20-%20Python%20SDK&description=AnthropicWebSearchResultBlockParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | -| `page_age` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.AnthropicWebSearchResultBlockParamType](/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparamtype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparamtype.mdx b/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparamtype.mdx deleted file mode 100644 index 306d588b..00000000 --- a/client-sdks/python/api-reference/components/anthropicwebsearchresultblockparamtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParamType - Python SDK -sidebarTitle: AnthropicWebSearchResultBlockParamType -description: AnthropicWebSearchResultBlockParamType method reference -seoTitle: AnthropicWebSearchResultBlockParamType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicwebsearchresultblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParamType | OpenRouter Python SDK -'og:description': >- - AnthropicWebSearchResultBlockParamType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParamType%20-%20Python%20SDK&description=AnthropicWebSearchResultBlockParamType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `WEB_SEARCH_RESULT` | web_search_result | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocation.mdx b/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocation.mdx deleted file mode 100644 index 6a543861..00000000 --- a/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocation - Python SDK -sidebarTitle: AnthropicWebSearchToolUserLocation -description: AnthropicWebSearchToolUserLocation method reference -seoTitle: AnthropicWebSearchToolUserLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicwebsearchtooluserlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocation | OpenRouter Python SDK -'og:description': >- - AnthropicWebSearchToolUserLocation method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocation%20-%20Python%20SDK&description=AnthropicWebSearchToolUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.AnthropicWebSearchToolUserLocationType](/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocationtype.mdx b/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocationtype.mdx deleted file mode 100644 index 056a1dd4..00000000 --- a/client-sdks/python/api-reference/components/anthropicwebsearchtooluserlocationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocationType - Python SDK -sidebarTitle: AnthropicWebSearchToolUserLocationType -description: AnthropicWebSearchToolUserLocationType method reference -seoTitle: AnthropicWebSearchToolUserLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/anthropicwebsearchtooluserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocationType | OpenRouter Python SDK -'og:description': >- - AnthropicWebSearchToolUserLocationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocationType%20-%20Python%20SDK&description=AnthropicWebSearchToolUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/apitype.mdx b/client-sdks/python/api-reference/components/apitype.mdx deleted file mode 100644 index 13b14da4..00000000 --- a/client-sdks/python/api-reference/components/apitype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: APIType - Python SDK -sidebarTitle: APIType -description: APIType method reference -seoTitle: APIType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/apitype' -'og:site_name': OpenRouter Documentation -'og:title': APIType | OpenRouter Python SDK -'og:description': >- - APIType method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIType%20-%20Python%20SDK&description=APIType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Type of API used for the generation - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETIONS` | completions | -| `EMBEDDINGS` | embeddings | -| `RERANK` | rerank | -| `TTS` | tts | -| `STT` | stt | -| `VIDEO` | video | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcallitem.mdx b/client-sdks/python/api-reference/components/applypatchcallitem.mdx deleted file mode 100644 index 8f382e83..00000000 --- a/client-sdks/python/api-reference/components/applypatchcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallItem - Python SDK -sidebarTitle: ApplyPatchCallItem -description: ApplyPatchCallItem method reference -seoTitle: ApplyPatchCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcallitem -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItem | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItem%20-%20Python%20SDK&description=ApplyPatchCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A tool call emitted by the model requesting a V4A patch operation. The client applies the patch and echoes an `apply_patch_call_output` on the next turn. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `operation` | [components.ApplyPatchCallOperation](/client-sdks/python/api-reference/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](/client-sdks/python/api-reference/components/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.ApplyPatchCallItemType](/client-sdks/python/api-reference/components/applypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcallitemtype.mdx b/client-sdks/python/api-reference/components/applypatchcallitemtype.mdx deleted file mode 100644 index 48ea10e2..00000000 --- a/client-sdks/python/api-reference/components/applypatchcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchCallItemType - Python SDK -sidebarTitle: ApplyPatchCallItemType -description: ApplyPatchCallItemType method reference -seoTitle: ApplyPatchCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItemType | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItemType%20-%20Python%20SDK&description=ApplyPatchCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `APPLY_PATCH_CALL` | apply_patch_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloperation.mdx b/client-sdks/python/api-reference/components/applypatchcalloperation.mdx deleted file mode 100644 index 496a1e41..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloperation.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ApplyPatchCallOperation - Python SDK -sidebarTitle: ApplyPatchCallOperation -description: ApplyPatchCallOperation method reference -seoTitle: ApplyPatchCallOperation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperation | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOperation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperation%20-%20Python%20SDK&description=ApplyPatchCallOperation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. - -## Supported Types - -### `components.ApplyPatchCreateFileOperation` - -```python lines -value: components.ApplyPatchCreateFileOperation = /* values here */ -``` - -### `components.ApplyPatchDeleteFileOperation` - -```python lines -value: components.ApplyPatchDeleteFileOperation = /* values here */ -``` - -### `components.ApplyPatchUpdateFileOperation` - -```python lines -value: components.ApplyPatchUpdateFileOperation = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaevent.mdx b/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaevent.mdx deleted file mode 100644 index 9271948c..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDeltaEvent - Python SDK -sidebarTitle: ApplyPatchCallOperationDiffDeltaEvent -description: ApplyPatchCallOperationDiffDeltaEvent method reference -seoTitle: ApplyPatchCallOperationDiffDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloperationdiffdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDeltaEvent | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOperationDiffDeltaEvent method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDeltaEvent%20-%20Python%20SDK&description=ApplyPatchCallOperationDiffDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI's streaming shape. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDeltaEventType](/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaeventtype.mdx b/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaeventtype.mdx deleted file mode 100644 index 35a918c7..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDeltaEventType - Python SDK -sidebarTitle: ApplyPatchCallOperationDiffDeltaEventType -description: ApplyPatchCallOperationDiffDeltaEventType method reference -seoTitle: ApplyPatchCallOperationDiffDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloperationdiffdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDeltaEventType | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOperationDiffDeltaEventType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDeltaEventType%20-%20Python%20SDK&description=ApplyPatchCallOperationDiffDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------------------ | ------------------------------------------------ | -| `RESPONSE_APPLY_PATCH_CALL_OPERATION_DIFF_DELTA` | response.apply_patch_call_operation_diff.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneevent.mdx b/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneevent.mdx deleted file mode 100644 index fe0c8e3c..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDoneEvent - Python SDK -sidebarTitle: ApplyPatchCallOperationDiffDoneEvent -description: ApplyPatchCallOperationDiffDoneEvent method reference -seoTitle: ApplyPatchCallOperationDiffDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloperationdiffdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDoneEvent | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOperationDiffDoneEvent method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDoneEvent%20-%20Python%20SDK&description=ApplyPatchCallOperationDiffDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Emitted when `operation.diff` streaming completes for an `apply_patch_call`. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `diff` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOperationDiffDoneEventType](/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneeventtype.mdx b/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneeventtype.mdx deleted file mode 100644 index 5eda87eb..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloperationdiffdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDoneEventType - Python SDK -sidebarTitle: ApplyPatchCallOperationDiffDoneEventType -description: ApplyPatchCallOperationDiffDoneEventType method reference -seoTitle: ApplyPatchCallOperationDiffDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloperationdiffdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDoneEventType | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOperationDiffDoneEventType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDoneEventType%20-%20Python%20SDK&description=ApplyPatchCallOperationDiffDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `RESPONSE_APPLY_PATCH_CALL_OPERATION_DIFF_DONE` | response.apply_patch_call_operation_diff.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloutputitem.mdx b/client-sdks/python/api-reference/components/applypatchcalloutputitem.mdx deleted file mode 100644 index e5e96381..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloutputitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ApplyPatchCallOutputItem - Python SDK -sidebarTitle: ApplyPatchCallOutputItem -description: ApplyPatchCallOutputItem method reference -seoTitle: ApplyPatchCallOutputItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItem | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOutputItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItem%20-%20Python%20SDK&description=ApplyPatchCallOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The client's echo of an `apply_patch_call` after applying the patch. `output` is an optional human-readable log; `status` is `completed` when the patch was applied successfully, `failed` otherwise. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `status` | [components.ApplyPatchCallOutputItemStatus](/client-sdks/python/api-reference/components/applypatchcalloutputitemstatus) | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCallOutputItemType](/client-sdks/python/api-reference/components/applypatchcalloutputitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloutputitemstatus.mdx b/client-sdks/python/api-reference/components/applypatchcalloutputitemstatus.mdx deleted file mode 100644 index 5e0fd8bc..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloutputitemstatus.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ApplyPatchCallOutputItemStatus - Python SDK -sidebarTitle: ApplyPatchCallOutputItemStatus -description: ApplyPatchCallOutputItemStatus method reference -seoTitle: ApplyPatchCallOutputItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemStatus | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOutputItemStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemStatus%20-%20Python%20SDK&description=ApplyPatchCallOutputItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | -| `FAILED` | failed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcalloutputitemtype.mdx b/client-sdks/python/api-reference/components/applypatchcalloutputitemtype.mdx deleted file mode 100644 index de326c7b..00000000 --- a/client-sdks/python/api-reference/components/applypatchcalloutputitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchCallOutputItemType - Python SDK -sidebarTitle: ApplyPatchCallOutputItemType -description: ApplyPatchCallOutputItemType method reference -seoTitle: ApplyPatchCallOutputItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemType | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallOutputItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemType%20-%20Python%20SDK&description=ApplyPatchCallOutputItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `APPLY_PATCH_CALL_OUTPUT` | apply_patch_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcallstatus.mdx b/client-sdks/python/api-reference/components/applypatchcallstatus.mdx deleted file mode 100644 index 243d9685..00000000 --- a/client-sdks/python/api-reference/components/applypatchcallstatus.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApplyPatchCallStatus - Python SDK -sidebarTitle: ApplyPatchCallStatus -description: ApplyPatchCallStatus method reference -seoTitle: ApplyPatchCallStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcallstatus -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallStatus | OpenRouter Python SDK -'og:description': >- - ApplyPatchCallStatus method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallStatus%20-%20Python%20SDK&description=ApplyPatchCallStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Lifecycle state of an `apply_patch_call` output item. - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcreatefileoperation.mdx b/client-sdks/python/api-reference/components/applypatchcreatefileoperation.mdx deleted file mode 100644 index 11e9a03a..00000000 --- a/client-sdks/python/api-reference/components/applypatchcreatefileoperation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ApplyPatchCreateFileOperation - Python SDK -sidebarTitle: ApplyPatchCreateFileOperation -description: ApplyPatchCreateFileOperation method reference -seoTitle: ApplyPatchCreateFileOperation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcreatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCreateFileOperation | OpenRouter Python SDK -'og:description': >- - ApplyPatchCreateFileOperation method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCreateFileOperation%20-%20Python%20SDK&description=ApplyPatchCreateFileOperation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing the new file contents. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `diff` | *str* | :heavy_check_mark: | N/A | -| `path` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchCreateFileOperationType](/client-sdks/python/api-reference/components/applypatchcreatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchcreatefileoperationtype.mdx b/client-sdks/python/api-reference/components/applypatchcreatefileoperationtype.mdx deleted file mode 100644 index b426f1bc..00000000 --- a/client-sdks/python/api-reference/components/applypatchcreatefileoperationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchCreateFileOperationType - Python SDK -sidebarTitle: ApplyPatchCreateFileOperationType -description: ApplyPatchCreateFileOperationType method reference -seoTitle: ApplyPatchCreateFileOperationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchcreatefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCreateFileOperationType | OpenRouter Python SDK -'og:description': >- - ApplyPatchCreateFileOperationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCreateFileOperationType%20-%20Python%20SDK&description=ApplyPatchCreateFileOperationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `CREATE_FILE` | create_file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchdeletefileoperation.mdx b/client-sdks/python/api-reference/components/applypatchdeletefileoperation.mdx deleted file mode 100644 index daaf5291..00000000 --- a/client-sdks/python/api-reference/components/applypatchdeletefileoperation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApplyPatchDeleteFileOperation - Python SDK -sidebarTitle: ApplyPatchDeleteFileOperation -description: ApplyPatchDeleteFileOperation method reference -seoTitle: ApplyPatchDeleteFileOperation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchdeletefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchDeleteFileOperation | OpenRouter Python SDK -'og:description': >- - ApplyPatchDeleteFileOperation method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchDeleteFileOperation%20-%20Python%20SDK&description=ApplyPatchDeleteFileOperation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The `delete_file` variant of an `apply_patch_call.operation`. Identifies the file to remove; no diff is required. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `path` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchDeleteFileOperationType](/client-sdks/python/api-reference/components/applypatchdeletefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchdeletefileoperationtype.mdx b/client-sdks/python/api-reference/components/applypatchdeletefileoperationtype.mdx deleted file mode 100644 index 27617d8a..00000000 --- a/client-sdks/python/api-reference/components/applypatchdeletefileoperationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchDeleteFileOperationType - Python SDK -sidebarTitle: ApplyPatchDeleteFileOperationType -description: ApplyPatchDeleteFileOperationType method reference -seoTitle: ApplyPatchDeleteFileOperationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchdeletefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchDeleteFileOperationType | OpenRouter Python SDK -'og:description': >- - ApplyPatchDeleteFileOperationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchDeleteFileOperationType%20-%20Python%20SDK&description=ApplyPatchDeleteFileOperationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `DELETE_FILE` | delete_file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchengineenum.mdx b/client-sdks/python/api-reference/components/applypatchengineenum.mdx deleted file mode 100644 index 47acee2b..00000000 --- a/client-sdks/python/api-reference/components/applypatchengineenum.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ApplyPatchEngineEnum - Python SDK -sidebarTitle: ApplyPatchEngineEnum -description: ApplyPatchEngineEnum method reference -seoTitle: ApplyPatchEngineEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchengineenum -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchEngineEnum | OpenRouter Python SDK -'og:description': >- - ApplyPatchEngineEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchEngineEnum%20-%20Python%20SDK&description=ApplyPatchEngineEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| ------------ | ------------ | -| `AUTO` | auto | -| `NATIVE` | native | -| `OPENROUTER` | openrouter | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchservertool.mdx b/client-sdks/python/api-reference/components/applypatchservertool.mdx deleted file mode 100644 index 7f8e77dc..00000000 --- a/client-sdks/python/api-reference/components/applypatchservertool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ApplyPatchServerTool - Python SDK -sidebarTitle: ApplyPatchServerTool -description: ApplyPatchServerTool method reference -seoTitle: ApplyPatchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchservertool -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerTool | OpenRouter Python SDK -'og:description': >- - ApplyPatchServerTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerTool%20-%20Python%20SDK&description=ApplyPatchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Apply patch tool configuration - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ApplyPatchServerToolType](/client-sdks/python/api-reference/components/applypatchservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchservertoolconfig.mdx b/client-sdks/python/api-reference/components/applypatchservertoolconfig.mdx deleted file mode 100644 index 6fd45e8e..00000000 --- a/client-sdks/python/api-reference/components/applypatchservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ApplyPatchServerToolConfig - Python SDK -sidebarTitle: ApplyPatchServerToolConfig -description: ApplyPatchServerToolConfig method reference -seoTitle: ApplyPatchServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolConfig | OpenRouter Python SDK -'og:description': >- - ApplyPatchServerToolConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolConfig%20-%20Python%20SDK&description=ApplyPatchServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:apply_patch server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.ApplyPatchEngineEnum]](../components/applypatchengineenum.md) | :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/client-sdks/python/api-reference/components/applypatchservertoolopenrouter.mdx b/client-sdks/python/api-reference/components/applypatchservertoolopenrouter.mdx deleted file mode 100644 index c79b6944..00000000 --- a/client-sdks/python/api-reference/components/applypatchservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ApplyPatchServerToolOpenRouter - Python SDK -sidebarTitle: ApplyPatchServerToolOpenRouter -description: ApplyPatchServerToolOpenRouter method reference -seoTitle: ApplyPatchServerToolOpenRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolOpenRouter | OpenRouter Python SDK -'og:description': >- - ApplyPatchServerToolOpenRouter method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolOpenRouter%20-%20Python%20SDK&description=ApplyPatchServerToolOpenRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: validates V4A diff patches for file operations (create, update, delete). Restricted to the Responses API. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.ApplyPatchServerToolConfig]](../components/applypatchservertoolconfig.md) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | `{"engine": "auto"}` | -| `type` | [components.ApplyPatchServerToolOpenRouterType](/client-sdks/python/api-reference/components/applypatchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchservertoolopenroutertype.mdx b/client-sdks/python/api-reference/components/applypatchservertoolopenroutertype.mdx deleted file mode 100644 index e0e75514..00000000 --- a/client-sdks/python/api-reference/components/applypatchservertoolopenroutertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchServerToolOpenRouterType - Python SDK -sidebarTitle: ApplyPatchServerToolOpenRouterType -description: ApplyPatchServerToolOpenRouterType method reference -seoTitle: ApplyPatchServerToolOpenRouterType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolOpenRouterType | OpenRouter Python SDK -'og:description': >- - ApplyPatchServerToolOpenRouterType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolOpenRouterType%20-%20Python%20SDK&description=ApplyPatchServerToolOpenRouterType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_APPLY_PATCH` | openrouter:apply_patch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchservertooltype.mdx b/client-sdks/python/api-reference/components/applypatchservertooltype.mdx deleted file mode 100644 index dcd144d8..00000000 --- a/client-sdks/python/api-reference/components/applypatchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchServerToolType - Python SDK -sidebarTitle: ApplyPatchServerToolType -description: ApplyPatchServerToolType method reference -seoTitle: ApplyPatchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolType | OpenRouter Python SDK -'og:description': >- - ApplyPatchServerToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolType%20-%20Python%20SDK&description=ApplyPatchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPLY_PATCH` | apply_patch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchupdatefileoperation.mdx b/client-sdks/python/api-reference/components/applypatchupdatefileoperation.mdx deleted file mode 100644 index e6169d24..00000000 --- a/client-sdks/python/api-reference/components/applypatchupdatefileoperation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ApplyPatchUpdateFileOperation - Python SDK -sidebarTitle: ApplyPatchUpdateFileOperation -description: ApplyPatchUpdateFileOperation method reference -seoTitle: ApplyPatchUpdateFileOperation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchupdatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchUpdateFileOperation | OpenRouter Python SDK -'og:description': >- - ApplyPatchUpdateFileOperation method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchUpdateFileOperation%20-%20Python%20SDK&description=ApplyPatchUpdateFileOperation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing edits to an existing file. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `diff` | *str* | :heavy_check_mark: | N/A | -| `path` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ApplyPatchUpdateFileOperationType](/client-sdks/python/api-reference/components/applypatchupdatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/applypatchupdatefileoperationtype.mdx b/client-sdks/python/api-reference/components/applypatchupdatefileoperationtype.mdx deleted file mode 100644 index b4bed60a..00000000 --- a/client-sdks/python/api-reference/components/applypatchupdatefileoperationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ApplyPatchUpdateFileOperationType - Python SDK -sidebarTitle: ApplyPatchUpdateFileOperationType -description: ApplyPatchUpdateFileOperationType method reference -seoTitle: ApplyPatchUpdateFileOperationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/applypatchupdatefileoperationtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchUpdateFileOperationType | OpenRouter Python SDK -'og:description': >- - ApplyPatchUpdateFileOperationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchUpdateFileOperationType%20-%20Python%20SDK&description=ApplyPatchUpdateFileOperationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `UPDATE_FILE` | update_file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/architecture.mdx b/client-sdks/python/api-reference/components/architecture.mdx deleted file mode 100644 index 8643f28c..00000000 --- a/client-sdks/python/api-reference/components/architecture.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Architecture - Python SDK -sidebarTitle: Architecture -description: Architecture method reference -seoTitle: Architecture | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/architecture' -'og:site_name': OpenRouter Documentation -'og:title': Architecture | OpenRouter Python SDK -'og:description': >- - Architecture method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Architecture%20-%20Python%20SDK&description=Architecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `input_modalities` | List[[components.InputModality](/client-sdks/python/api-reference/components/inputmodality)] | :heavy_check_mark: | Supported input modalities | | -| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.md) | :heavy_check_mark: | Instruction format type | chatml | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text | -| `output_modalities` | List[[components.OutputModality](/client-sdks/python/api-reference/components/outputmodality)] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [Nullable[components.Tokenizer]](../components/tokenizer.md) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/aspectratio.mdx b/client-sdks/python/api-reference/components/aspectratio.mdx deleted file mode 100644 index e1fe586a..00000000 --- a/client-sdks/python/api-reference/components/aspectratio.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: AspectRatio - Python SDK -sidebarTitle: AspectRatio -description: AspectRatio method reference -seoTitle: AspectRatio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/aspectratio' -'og:site_name': OpenRouter Documentation -'og:title': AspectRatio | OpenRouter Python SDK -'og:description': >- - AspectRatio method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AspectRatio%20-%20Python%20SDK&description=AspectRatio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Aspect ratio of the generated video - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `ONE_HUNDRED_AND_SIXTY_NINE` | 16:9 | -| `NINE_HUNDRED_AND_SIXTEEN` | 9:16 | -| `ELEVEN` | 1:1 | -| `FORTY_THREE` | 4:3 | -| `THIRTY_FOUR` | 3:4 | -| `THIRTY_TWO` | 3:2 | -| `TWENTY_THREE` | 2:3 | -| `TWO_HUNDRED_AND_NINETEEN` | 21:9 | -| `NINE_HUNDRED_AND_TWENTY_ONE` | 9:21 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/autorouterplugin.mdx b/client-sdks/python/api-reference/components/autorouterplugin.mdx deleted file mode 100644 index 1fb5f91d..00000000 --- a/client-sdks/python/api-reference/components/autorouterplugin.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: AutoRouterPlugin - Python SDK -sidebarTitle: AutoRouterPlugin -description: AutoRouterPlugin method reference -seoTitle: AutoRouterPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/autorouterplugin -'og:site_name': OpenRouter Documentation -'og:title': AutoRouterPlugin | OpenRouter Python SDK -'og:description': >- - AutoRouterPlugin method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AutoRouterPlugin%20-%20Python%20SDK&description=AutoRouterPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :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/*"
] | -| `cost_quality_tradeoff` | *Optional[int]* | :heavy_minus_sign: | 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. | 7 | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `id` | [components.AutoRouterPluginID](/client-sdks/python/api-reference/components/autorouterpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/autorouterpluginid.mdx b/client-sdks/python/api-reference/components/autorouterpluginid.mdx deleted file mode 100644 index 3da207c2..00000000 --- a/client-sdks/python/api-reference/components/autorouterpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: AutoRouterPluginID - Python SDK -sidebarTitle: AutoRouterPluginID -description: AutoRouterPluginID method reference -seoTitle: AutoRouterPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/autorouterpluginid -'og:site_name': OpenRouter Documentation -'og:title': AutoRouterPluginID | OpenRouter Python SDK -'og:description': >- - AutoRouterPluginID method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AutoRouterPluginID%20-%20Python%20SDK&description=AutoRouterPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `AUTO_ROUTER` | auto-router | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/background.mdx b/client-sdks/python/api-reference/components/background.mdx deleted file mode 100644 index ea9df57b..00000000 --- a/client-sdks/python/api-reference/components/background.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Background - Python SDK -sidebarTitle: Background -description: Background method reference -seoTitle: Background | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/background' -'og:site_name': OpenRouter Documentation -'og:title': Background | OpenRouter Python SDK -'og:description': >- - Background method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Background%20-%20Python%20SDK&description=Background%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `TRANSPARENT` | transparent | -| `OPAQUE` | opaque | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/badgatewayresponseerrordata.mdx b/client-sdks/python/api-reference/components/badgatewayresponseerrordata.mdx deleted file mode 100644 index aaa2a5a2..00000000 --- a/client-sdks/python/api-reference/components/badgatewayresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadGatewayResponseErrorData - Python SDK -sidebarTitle: BadGatewayResponseErrorData -description: BadGatewayResponseErrorData method reference -seoTitle: BadGatewayResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/badgatewayresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseErrorData | OpenRouter Python SDK -'og:description': >- - BadGatewayResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseErrorData%20-%20Python%20SDK&description=BadGatewayResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for BadGatewayResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/badrequestresponseerrordata.mdx b/client-sdks/python/api-reference/components/badrequestresponseerrordata.mdx deleted file mode 100644 index 73d3b9fb..00000000 --- a/client-sdks/python/api-reference/components/badrequestresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadRequestResponseErrorData - Python SDK -sidebarTitle: BadRequestResponseErrorData -description: BadRequestResponseErrorData method reference -seoTitle: BadRequestResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/badrequestresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseErrorData | OpenRouter Python SDK -'og:description': >- - BadRequestResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseErrorData%20-%20Python%20SDK&description=BadRequestResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for BadRequestResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputscontent1.mdx b/client-sdks/python/api-reference/components/baseinputscontent1.mdx deleted file mode 100644 index bbfd1977..00000000 --- a/client-sdks/python/api-reference/components/baseinputscontent1.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BaseInputsContent1 - Python SDK -sidebarTitle: BaseInputsContent1 -description: BaseInputsContent1 method reference -seoTitle: BaseInputsContent1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputscontent1 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent1 | OpenRouter Python SDK -'og:description': >- - BaseInputsContent1 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent1%20-%20Python%20SDK&description=BaseInputsContent1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputAudio` - -```python lines -value: components.InputAudio = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputImage` - -```python lines -value: components.InputImage = /* values here */ -``` - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputscontent2.mdx b/client-sdks/python/api-reference/components/baseinputscontent2.mdx deleted file mode 100644 index 4fc187c8..00000000 --- a/client-sdks/python/api-reference/components/baseinputscontent2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsContent2 - Python SDK -sidebarTitle: BaseInputsContent2 -description: BaseInputsContent2 method reference -seoTitle: BaseInputsContent2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputscontent2 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent2 | OpenRouter Python SDK -'og:description': >- - BaseInputsContent2 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent2%20-%20Python%20SDK&description=BaseInputsContent2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.BaseInputsContent1]` - -```python lines -value: List[components.BaseInputsContent1] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsmessage.mdx b/client-sdks/python/api-reference/components/baseinputsmessage.mdx deleted file mode 100644 index faf6a2bd..00000000 --- a/client-sdks/python/api-reference/components/baseinputsmessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BaseInputsMessage - Python SDK -sidebarTitle: BaseInputsMessage -description: BaseInputsMessage method reference -seoTitle: BaseInputsMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsmessage -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsMessage | OpenRouter Python SDK -'og:description': >- - BaseInputsMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsMessage%20-%20Python%20SDK&description=BaseInputsMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | [components.BaseInputsContent2](/client-sdks/python/api-reference/components/baseinputscontent2) | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.BaseInputsPhaseUnion]](../components/baseinputsphaseunion.md) | :heavy_minus_sign: | N/A | -| `role` | [components.BaseInputsRoleUnion](/client-sdks/python/api-reference/components/baseinputsroleunion) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.BaseInputsType]](../components/baseinputstype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsphasecommentary.mdx b/client-sdks/python/api-reference/components/baseinputsphasecommentary.mdx deleted file mode 100644 index 497d2798..00000000 --- a/client-sdks/python/api-reference/components/baseinputsphasecommentary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsPhaseCommentary - Python SDK -sidebarTitle: BaseInputsPhaseCommentary -description: BaseInputsPhaseCommentary method reference -seoTitle: BaseInputsPhaseCommentary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseCommentary | OpenRouter Python SDK -'og:description': >- - BaseInputsPhaseCommentary method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseCommentary%20-%20Python%20SDK&description=BaseInputsPhaseCommentary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMMENTARY` | commentary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsphasefinalanswer.mdx b/client-sdks/python/api-reference/components/baseinputsphasefinalanswer.mdx deleted file mode 100644 index 22477a5a..00000000 --- a/client-sdks/python/api-reference/components/baseinputsphasefinalanswer.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsPhaseFinalAnswer - Python SDK -sidebarTitle: BaseInputsPhaseFinalAnswer -description: BaseInputsPhaseFinalAnswer method reference -seoTitle: BaseInputsPhaseFinalAnswer | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseFinalAnswer | OpenRouter Python SDK -'og:description': >- - BaseInputsPhaseFinalAnswer method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseFinalAnswer%20-%20Python%20SDK&description=BaseInputsPhaseFinalAnswer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FINAL_ANSWER` | final_answer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsphaseunion.mdx b/client-sdks/python/api-reference/components/baseinputsphaseunion.mdx deleted file mode 100644 index 5b29bf5f..00000000 --- a/client-sdks/python/api-reference/components/baseinputsphaseunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: BaseInputsPhaseUnion - Python SDK -sidebarTitle: BaseInputsPhaseUnion -description: BaseInputsPhaseUnion method reference -seoTitle: BaseInputsPhaseUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsphaseunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseUnion | OpenRouter Python SDK -'og:description': >- - BaseInputsPhaseUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseUnion%20-%20Python%20SDK&description=BaseInputsPhaseUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.BaseInputsPhaseCommentary` - -```python lines -value: components.BaseInputsPhaseCommentary = /* values here */ -``` - -### `components.BaseInputsPhaseFinalAnswer` - -```python lines -value: components.BaseInputsPhaseFinalAnswer = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsroleassistant.mdx b/client-sdks/python/api-reference/components/baseinputsroleassistant.mdx deleted file mode 100644 index 5abda5b5..00000000 --- a/client-sdks/python/api-reference/components/baseinputsroleassistant.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsRoleAssistant - Python SDK -sidebarTitle: BaseInputsRoleAssistant -description: BaseInputsRoleAssistant method reference -seoTitle: BaseInputsRoleAssistant | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsroleassistant -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleAssistant | OpenRouter Python SDK -'og:description': >- - BaseInputsRoleAssistant method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleAssistant%20-%20Python%20SDK&description=BaseInputsRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsroledeveloper.mdx b/client-sdks/python/api-reference/components/baseinputsroledeveloper.mdx deleted file mode 100644 index f3e083f8..00000000 --- a/client-sdks/python/api-reference/components/baseinputsroledeveloper.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsRoleDeveloper - Python SDK -sidebarTitle: BaseInputsRoleDeveloper -description: BaseInputsRoleDeveloper method reference -seoTitle: BaseInputsRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleDeveloper | OpenRouter Python SDK -'og:description': >- - BaseInputsRoleDeveloper method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleDeveloper%20-%20Python%20SDK&description=BaseInputsRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsrolesystem.mdx b/client-sdks/python/api-reference/components/baseinputsrolesystem.mdx deleted file mode 100644 index baef8cfc..00000000 --- a/client-sdks/python/api-reference/components/baseinputsrolesystem.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsRoleSystem - Python SDK -sidebarTitle: BaseInputsRoleSystem -description: BaseInputsRoleSystem method reference -seoTitle: BaseInputsRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsrolesystem -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleSystem | OpenRouter Python SDK -'og:description': >- - BaseInputsRoleSystem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleSystem%20-%20Python%20SDK&description=BaseInputsRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsroleunion.mdx b/client-sdks/python/api-reference/components/baseinputsroleunion.mdx deleted file mode 100644 index a39be13b..00000000 --- a/client-sdks/python/api-reference/components/baseinputsroleunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BaseInputsRoleUnion - Python SDK -sidebarTitle: BaseInputsRoleUnion -description: BaseInputsRoleUnion method reference -seoTitle: BaseInputsRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsroleunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUnion | OpenRouter Python SDK -'og:description': >- - BaseInputsRoleUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUnion%20-%20Python%20SDK&description=BaseInputsRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.BaseInputsRoleUser` - -```python lines -value: components.BaseInputsRoleUser = /* values here */ -``` - -### `components.BaseInputsRoleSystem` - -```python lines -value: components.BaseInputsRoleSystem = /* values here */ -``` - -### `components.BaseInputsRoleAssistant` - -```python lines -value: components.BaseInputsRoleAssistant = /* values here */ -``` - -### `components.BaseInputsRoleDeveloper` - -```python lines -value: components.BaseInputsRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsroleuser.mdx b/client-sdks/python/api-reference/components/baseinputsroleuser.mdx deleted file mode 100644 index 17414422..00000000 --- a/client-sdks/python/api-reference/components/baseinputsroleuser.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BaseInputsRoleUser - Python SDK -sidebarTitle: BaseInputsRoleUser -description: BaseInputsRoleUser method reference -seoTitle: BaseInputsRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsroleuser -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUser | OpenRouter Python SDK -'og:description': >- - BaseInputsRoleUser method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUser%20-%20Python%20SDK&description=BaseInputsRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputstype.mdx b/client-sdks/python/api-reference/components/baseinputstype.mdx deleted file mode 100644 index a39fcc9f..00000000 --- a/client-sdks/python/api-reference/components/baseinputstype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BaseInputsType - Python SDK -sidebarTitle: BaseInputsType -description: BaseInputsType method reference -seoTitle: BaseInputsType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/baseinputstype' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsType | OpenRouter Python SDK -'og:description': >- - BaseInputsType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsType%20-%20Python%20SDK&description=BaseInputsType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsunion.mdx b/client-sdks/python/api-reference/components/baseinputsunion.mdx deleted file mode 100644 index f1ec0fd4..00000000 --- a/client-sdks/python/api-reference/components/baseinputsunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: BaseInputsUnion - Python SDK -sidebarTitle: BaseInputsUnion -description: BaseInputsUnion method reference -seoTitle: BaseInputsUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion | OpenRouter Python SDK -'og:description': >- - BaseInputsUnion method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion%20-%20Python%20SDK&description=BaseInputsUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.BaseInputsUnion1]` - -```python lines -value: List[components.BaseInputsUnion1] = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/baseinputsunion1.mdx b/client-sdks/python/api-reference/components/baseinputsunion1.mdx deleted file mode 100644 index 21130199..00000000 --- a/client-sdks/python/api-reference/components/baseinputsunion1.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: BaseInputsUnion1 - Python SDK -sidebarTitle: BaseInputsUnion1 -description: BaseInputsUnion1 method reference -seoTitle: BaseInputsUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/baseinputsunion1 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion1 | OpenRouter Python SDK -'og:description': >- - BaseInputsUnion1 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion1%20-%20Python%20SDK&description=BaseInputsUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.BaseInputsMessage` - -```python lines -value: components.BaseInputsMessage = /* values here */ -``` - -### `components.OpenAIResponseInputMessageItem` - -```python lines -value: components.OpenAIResponseInputMessageItem = /* values here */ -``` - -### `components.OpenAIResponseFunctionToolCallOutput` - -```python lines -value: components.OpenAIResponseFunctionToolCallOutput = /* values here */ -``` - -### `components.OpenAIResponseFunctionToolCall` - -```python lines -value: components.OpenAIResponseFunctionToolCall = /* values here */ -``` - -### `components.OutputItemImageGenerationCall` - -```python lines -value: components.OutputItemImageGenerationCall = /* values here */ -``` - -### `components.OutputMessage` - -```python lines -value: components.OutputMessage = /* values here */ -``` - -### `components.OpenAIResponseCustomToolCall` - -```python lines -value: components.OpenAIResponseCustomToolCall = /* values here */ -``` - -### `components.OpenAIResponseCustomToolCallOutput` - -```python lines -value: components.OpenAIResponseCustomToolCallOutput = /* values here */ -``` - -### `components.ApplyPatchCallItem` - -```python lines -value: components.ApplyPatchCallItem = /* values here */ -``` - -### `components.ApplyPatchCallOutputItem` - -```python lines -value: components.ApplyPatchCallOutputItem = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/basereasoningconfig.mdx b/client-sdks/python/api-reference/components/basereasoningconfig.mdx deleted file mode 100644 index adb22e5d..00000000 --- a/client-sdks/python/api-reference/components/basereasoningconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BaseReasoningConfig - Python SDK -sidebarTitle: BaseReasoningConfig -description: BaseReasoningConfig method reference -seoTitle: BaseReasoningConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/basereasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': BaseReasoningConfig | OpenRouter Python SDK -'og:description': >- - BaseReasoningConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseReasoningConfig%20-%20Python%20SDK&description=BaseReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.ReasoningEffort]](../components/reasoningeffort.md) | :heavy_minus_sign: | N/A | medium | -| `summary` | [OptionalNullable[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.md) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkaddworkspacemembersrequest.mdx b/client-sdks/python/api-reference/components/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index 3d84160f..00000000 --- a/client-sdks/python/api-reference/components/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - Python SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest method reference -seoTitle: BulkAddWorkspaceMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkAddWorkspaceMembersRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20Python%20SDK&description=BulkAddWorkspaceMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkaddworkspacemembersresponse.mdx b/client-sdks/python/api-reference/components/bulkaddworkspacemembersresponse.mdx deleted file mode 100644 index b6dd1dfe..00000000 --- a/client-sdks/python/api-reference/components/bulkaddworkspacemembersresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAddWorkspaceMembersResponse - Python SDK -sidebarTitle: BulkAddWorkspaceMembersResponse -description: BulkAddWorkspaceMembersResponse method reference -seoTitle: BulkAddWorkspaceMembersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkaddworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersResponse | OpenRouter Python SDK -'og:description': >- - BulkAddWorkspaceMembersResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersResponse%20-%20Python%20SDK&description=BulkAddWorkspaceMembersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `added_count` | *int* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `data` | List[[components.WorkspaceMember](/client-sdks/python/api-reference/components/workspacemember)] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkassignkeysrequest.mdx b/client-sdks/python/api-reference/components/bulkassignkeysrequest.mdx deleted file mode 100644 index 4cee0b10..00000000 --- a/client-sdks/python/api-reference/components/bulkassignkeysrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignKeysRequest - Python SDK -sidebarTitle: BulkAssignKeysRequest -description: BulkAssignKeysRequest method reference -seoTitle: BulkAssignKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkassignkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysRequest%20-%20Python%20SDK&description=BulkAssignKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkassignkeysresponse.mdx b/client-sdks/python/api-reference/components/bulkassignkeysresponse.mdx deleted file mode 100644 index 4b6a1eae..00000000 --- a/client-sdks/python/api-reference/components/bulkassignkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignKeysResponse - Python SDK -sidebarTitle: BulkAssignKeysResponse -description: BulkAssignKeysResponse method reference -seoTitle: BulkAssignKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkassignkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysResponse | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysResponse%20-%20Python%20SDK&description=BulkAssignKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assigned_count` | *int* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkassignmembersrequest.mdx b/client-sdks/python/api-reference/components/bulkassignmembersrequest.mdx deleted file mode 100644 index 831438b0..00000000 --- a/client-sdks/python/api-reference/components/bulkassignmembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignMembersRequest - Python SDK -sidebarTitle: BulkAssignMembersRequest -description: BulkAssignMembersRequest method reference -seoTitle: BulkAssignMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersRequest%20-%20Python%20SDK&description=BulkAssignMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkassignmembersresponse.mdx b/client-sdks/python/api-reference/components/bulkassignmembersresponse.mdx deleted file mode 100644 index cdc86558..00000000 --- a/client-sdks/python/api-reference/components/bulkassignmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignMembersResponse - Python SDK -sidebarTitle: BulkAssignMembersResponse -description: BulkAssignMembersResponse method reference -seoTitle: BulkAssignMembersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersResponse | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersResponse%20-%20Python%20SDK&description=BulkAssignMembersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assigned_count` | *int* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkremoveworkspacemembersrequest.mdx b/client-sdks/python/api-reference/components/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index 633ae597..00000000 --- a/client-sdks/python/api-reference/components/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - Python SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest method reference -seoTitle: BulkRemoveWorkspaceMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20Python%20SDK&description=BulkRemoveWorkspaceMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkremoveworkspacemembersresponse.mdx b/client-sdks/python/api-reference/components/bulkremoveworkspacemembersresponse.mdx deleted file mode 100644 index 11fddc6d..00000000 --- a/client-sdks/python/api-reference/components/bulkremoveworkspacemembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersResponse - Python SDK -sidebarTitle: BulkRemoveWorkspaceMembersResponse -description: BulkRemoveWorkspaceMembersResponse method reference -seoTitle: BulkRemoveWorkspaceMembersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkremoveworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersResponse | OpenRouter Python SDK -'og:description': >- - BulkRemoveWorkspaceMembersResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersResponse%20-%20Python%20SDK&description=BulkRemoveWorkspaceMembersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `removed_count` | *int* | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkunassignkeysrequest.mdx b/client-sdks/python/api-reference/components/bulkunassignkeysrequest.mdx deleted file mode 100644 index 820b606a..00000000 --- a/client-sdks/python/api-reference/components/bulkunassignkeysrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignKeysRequest - Python SDK -sidebarTitle: BulkUnassignKeysRequest -description: BulkUnassignKeysRequest method reference -seoTitle: BulkUnassignKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkunassignkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysRequest%20-%20Python%20SDK&description=BulkUnassignKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkunassignkeysresponse.mdx b/client-sdks/python/api-reference/components/bulkunassignkeysresponse.mdx deleted file mode 100644 index 062b73dc..00000000 --- a/client-sdks/python/api-reference/components/bulkunassignkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignKeysResponse - Python SDK -sidebarTitle: BulkUnassignKeysResponse -description: BulkUnassignKeysResponse method reference -seoTitle: BulkUnassignKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkunassignkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysResponse | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysResponse%20-%20Python%20SDK&description=BulkUnassignKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassigned_count` | *int* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkunassignmembersrequest.mdx b/client-sdks/python/api-reference/components/bulkunassignmembersrequest.mdx deleted file mode 100644 index a04e9213..00000000 --- a/client-sdks/python/api-reference/components/bulkunassignmembersrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignMembersRequest - Python SDK -sidebarTitle: BulkUnassignMembersRequest -description: BulkUnassignMembersRequest method reference -seoTitle: BulkUnassignMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkunassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersRequest%20-%20Python%20SDK&description=BulkUnassignMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/bulkunassignmembersresponse.mdx b/client-sdks/python/api-reference/components/bulkunassignmembersresponse.mdx deleted file mode 100644 index 0a4d2934..00000000 --- a/client-sdks/python/api-reference/components/bulkunassignmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignMembersResponse - Python SDK -sidebarTitle: BulkUnassignMembersResponse -description: BulkUnassignMembersResponse method reference -seoTitle: BulkUnassignMembersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/bulkunassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersResponse | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersResponse%20-%20Python%20SDK&description=BulkUnassignMembersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassigned_count` | *int* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/by.mdx b/client-sdks/python/api-reference/components/by.mdx deleted file mode 100644 index 00eea5fd..00000000 --- a/client-sdks/python/api-reference/components/by.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: By - Python SDK -sidebarTitle: By -description: By method reference -seoTitle: By | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/by' -'og:site_name': OpenRouter Documentation -'og:title': By | OpenRouter Python SDK -'og:description': >- - By method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=By%20-%20Python%20SDK&description=By%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | -| `EXACTO` | exacto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/byokkey.mdx b/client-sdks/python/api-reference/components/byokkey.mdx deleted file mode 100644 index 65226cf6..00000000 --- a/client-sdks/python/api-reference/components/byokkey.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BYOKKey - Python SDK -sidebarTitle: BYOKKey -description: BYOKKey method reference -seoTitle: BYOKKey | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/byokkey' -'og:site_name': OpenRouter Documentation -'og:title': BYOKKey | OpenRouter Python SDK -'og:description': >- - BYOKKey method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKKey%20-%20Python%20SDK&description=BYOKKey%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowed_models` | List[*str*] | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowed_user_ids` | List[*str*] | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `created_at` | *str* | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `disabled` | *bool* | :heavy_check_mark: | Whether this credential is currently disabled. | false | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `is_fallback` | *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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](/client-sdks/python/api-reference/components/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `sort_order` | *int* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/byokproviderslug.mdx b/client-sdks/python/api-reference/components/byokproviderslug.mdx deleted file mode 100644 index 255a6e85..00000000 --- a/client-sdks/python/api-reference/components/byokproviderslug.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: BYOKProviderSlug - Python SDK -sidebarTitle: BYOKProviderSlug -description: BYOKProviderSlug method reference -seoTitle: BYOKProviderSlug | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/byokproviderslug -'og:site_name': OpenRouter Documentation -'og:title': BYOKProviderSlug | OpenRouter Python SDK -'og:description': >- - BYOKProviderSlug method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKProviderSlug%20-%20Python%20SDK&description=BYOKProviderSlug%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `AI21` | ai21 | -| `AION_LABS` | aion-labs | -| `AKASHML` | akashml | -| `ALIBABA` | alibaba | -| `AMAZON_BEDROCK` | amazon-bedrock | -| `AMAZON_NOVA` | amazon-nova | -| `AMBIENT` | ambient | -| `ANTHROPIC` | anthropic | -| `ARCEE_AI` | arcee-ai | -| `ATLAS_CLOUD` | atlas-cloud | -| `AVIAN` | avian | -| `AZURE` | azure | -| `BAIDU` | baidu | -| `BASETEN` | baseten | -| `BLACK_FOREST_LABS` | black-forest-labs | -| `BYTEPLUS` | byteplus | -| `CEREBRAS` | cerebras | -| `CHUTES` | chutes | -| `CIRRASCALE` | cirrascale | -| `CLARIFAI` | clarifai | -| `CLOUDFLARE` | cloudflare | -| `COHERE` | cohere | -| `CRUSOE` | crusoe | -| `DARKBLOOM` | darkbloom | -| `DEEPINFRA` | deepinfra | -| `DEEPSEEK` | deepseek | -| `DEKALLM` | dekallm | -| `DIGITALOCEAN` | digitalocean | -| `FEATHERLESS` | featherless | -| `FIREWORKS` | fireworks | -| `FRIENDLI` | friendli | -| `GMICLOUD` | gmicloud | -| `GOOGLE_AI_STUDIO` | google-ai-studio | -| `GOOGLE_VERTEX` | google-vertex | -| `GROQ` | groq | -| `HYPERBOLIC` | hyperbolic | -| `INCEPTION` | inception | -| `INCEPTRON` | inceptron | -| `INFERENCE_NET` | inference-net | -| `INFERMATIC` | infermatic | -| `INFLECTION` | inflection | -| `IO_NET` | io-net | -| `IONSTREAM` | ionstream | -| `LIQUID` | liquid | -| `MANCER` | mancer | -| `MARA` | mara | -| `MINIMAX` | minimax | -| `MISTRAL` | mistral | -| `MODELRUN` | modelrun | -| `MODULAR` | modular | -| `MOONSHOTAI` | moonshotai | -| `MORPH` | morph | -| `NCOMPASS` | ncompass | -| `NEBIUS` | nebius | -| `NEX_AGI` | nex-agi | -| `NEXTBIT` | nextbit | -| `NOVITA` | novita | -| `NVIDIA` | nvidia | -| `OPEN_INFERENCE` | open-inference | -| `OPENAI` | openai | -| `PARASAIL` | parasail | -| `PERCEPTRON` | perceptron | -| `PERPLEXITY` | perplexity | -| `PHALA` | phala | -| `POOLSIDE` | poolside | -| `RECRAFT` | recraft | -| `REKA` | reka | -| `RELACE` | relace | -| `SAMBANOVA` | sambanova | -| `SEED` | seed | -| `SILICONFLOW` | siliconflow | -| `SOURCEFUL` | sourceful | -| `STEPFUN` | stepfun | -| `STREAMLAKE` | streamlake | -| `SWITCHPOINT` | switchpoint | -| `TOGETHER` | together | -| `UPSTAGE` | upstage | -| `VENICE` | venice | -| `WANDB` | wandb | -| `XAI` | xai | -| `XIAOMI` | xiaomi | -| `Z_AI` | z-ai | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/caching.mdx b/client-sdks/python/api-reference/components/caching.mdx deleted file mode 100644 index c1b70bb8..00000000 --- a/client-sdks/python/api-reference/components/caching.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Caching - Python SDK -sidebarTitle: Caching -description: Caching method reference -seoTitle: Caching | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/caching' -'og:site_name': OpenRouter Documentation -'og:title': Caching | OpenRouter Python SDK -'og:description': >- - Caching method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Caching%20-%20Python%20SDK&description=Caching%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.md) | :heavy_minus_sign: | N/A | 5m | -| `type` | [components.ToolTypeEphemeral](/client-sdks/python/api-reference/components/tooltypeephemeral) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatassistantimages.mdx b/client-sdks/python/api-reference/components/chatassistantimages.mdx deleted file mode 100644 index 509089a4..00000000 --- a/client-sdks/python/api-reference/components/chatassistantimages.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatAssistantImages - Python SDK -sidebarTitle: ChatAssistantImages -description: ChatAssistantImages method reference -seoTitle: ChatAssistantImages | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatassistantimages -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImages | OpenRouter Python SDK -'og:description': >- - ChatAssistantImages method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImages%20-%20Python%20SDK&description=ChatAssistantImages%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `image_url` | [components.ChatAssistantImagesImageURL](/client-sdks/python/api-reference/components/chatassistantimagesimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatassistantimagesimageurl.mdx b/client-sdks/python/api-reference/components/chatassistantimagesimageurl.mdx deleted file mode 100644 index 0ef60b1e..00000000 --- a/client-sdks/python/api-reference/components/chatassistantimagesimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatAssistantImagesImageURL - Python SDK -sidebarTitle: ChatAssistantImagesImageURL -description: ChatAssistantImagesImageURL method reference -seoTitle: ChatAssistantImagesImageURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatassistantimagesimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImagesImageURL | OpenRouter Python SDK -'og:description': >- - ChatAssistantImagesImageURL method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImagesImageURL%20-%20Python%20SDK&description=ChatAssistantImagesImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `url` | *str* | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatassistantmessage.mdx b/client-sdks/python/api-reference/components/chatassistantmessage.mdx deleted file mode 100644 index 519e0010..00000000 --- a/client-sdks/python/api-reference/components/chatassistantmessage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatAssistantMessage - Python SDK -sidebarTitle: ChatAssistantMessage -description: ChatAssistantMessage method reference -seoTitle: ChatAssistantMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatassistantmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessage | OpenRouter Python SDK -'og:description': >- - ChatAssistantMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessage%20-%20Python%20SDK&description=ChatAssistantMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Assistant message for requests and responses - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../components/chataudiooutput.md) | :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[components.ChatAssistantMessageContent]](../components/chatassistantmessagecontent.md) | :heavy_minus_sign: | Assistant message content | | -| `images` | List[[components.ChatAssistantImages](/client-sdks/python/api-reference/components/chatassistantimages)] | :heavy_minus_sign: | Generated images from image generation models | [
`{"image_url": {"url": "data:image/png;base64,iVBORw0KGgo..."}`
\}
] | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the assistant | | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning output | | -| `reasoning_details` | List[[components.ReasoningDetailUnion](/client-sdks/python/api-reference/components/reasoningdetailunion)] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"thinking": "Let me work through this step by step...","type": "thinking"}`
] | -| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message if content was refused | | -| `role` | [components.ChatAssistantMessageRole](/client-sdks/python/api-reference/components/chatassistantmessagerole) | :heavy_check_mark: | N/A | | -| `tool_calls` | List[[components.ChatToolCall](/client-sdks/python/api-reference/components/chattoolcall)] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatassistantmessagecontent.mdx b/client-sdks/python/api-reference/components/chatassistantmessagecontent.mdx deleted file mode 100644 index d8ddf050..00000000 --- a/client-sdks/python/api-reference/components/chatassistantmessagecontent.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatAssistantMessageContent - Python SDK -sidebarTitle: ChatAssistantMessageContent -description: ChatAssistantMessageContent method reference -seoTitle: ChatAssistantMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatassistantmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageContent | OpenRouter Python SDK -'og:description': >- - ChatAssistantMessageContent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageContent%20-%20Python%20SDK&description=ChatAssistantMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Assistant message content - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatContentItems]` - -```python lines -value: List[components.ChatContentItems] = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatassistantmessagerole.mdx b/client-sdks/python/api-reference/components/chatassistantmessagerole.mdx deleted file mode 100644 index f323f3e0..00000000 --- a/client-sdks/python/api-reference/components/chatassistantmessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatAssistantMessageRole - Python SDK -sidebarTitle: ChatAssistantMessageRole -description: ChatAssistantMessageRole method reference -seoTitle: ChatAssistantMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatassistantmessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageRole | OpenRouter Python SDK -'og:description': >- - ChatAssistantMessageRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageRole%20-%20Python%20SDK&description=ChatAssistantMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chataudiooutput.mdx b/client-sdks/python/api-reference/components/chataudiooutput.mdx deleted file mode 100644 index 4a4ab001..00000000 --- a/client-sdks/python/api-reference/components/chataudiooutput.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatAudioOutput - Python SDK -sidebarTitle: ChatAudioOutput -description: ChatAudioOutput method reference -seoTitle: ChatAudioOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chataudiooutput -'og:site_name': OpenRouter Documentation -'og:title': ChatAudioOutput | OpenRouter Python SDK -'og:description': >- - ChatAudioOutput method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAudioOutput%20-%20Python%20SDK&description=ChatAudioOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Audio output data or reference - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `data` | *Optional[str]* | :heavy_minus_sign: | Base64 encoded audio data | -| `expires_at` | *Optional[int]* | :heavy_minus_sign: | Audio expiration timestamp | -| `id` | *Optional[str]* | :heavy_minus_sign: | Audio output identifier | -| `transcript` | *Optional[str]* | :heavy_minus_sign: | Audio transcript | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatchoice.mdx b/client-sdks/python/api-reference/components/chatchoice.mdx deleted file mode 100644 index f67d7243..00000000 --- a/client-sdks/python/api-reference/components/chatchoice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatChoice - Python SDK -sidebarTitle: ChatChoice -description: ChatChoice method reference -seoTitle: ChatChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chatchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatChoice | OpenRouter Python SDK -'og:description': >- - ChatChoice method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatChoice%20-%20Python%20SDK&description=ChatChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Chat completion choice - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.md) | :heavy_check_mark: | N/A | stop | -| `index` | *int* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../components/chattokenlogprobs.md) | :heavy_minus_sign: | Log probabilities for the completion | `{"content": [{"bytes": null,"logprob": -0.612345,"token": " Hello","top_logprobs": []}`
],
"refusal": `null
`\} | -| `message` | [components.ChatAssistantMessage](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/chatcontentaudio.mdx b/client-sdks/python/api-reference/components/chatcontentaudio.mdx deleted file mode 100644 index 72fa7518..00000000 --- a/client-sdks/python/api-reference/components/chatcontentaudio.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentAudio - Python SDK -sidebarTitle: ChatContentAudio -description: ChatContentAudio method reference -seoTitle: ChatContentAudio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudio | OpenRouter Python SDK -'og:description': >- - ChatContentAudio method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudio%20-%20Python%20SDK&description=ChatContentAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Audio input content part. Supported audio formats vary by provider. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `input_audio` | [components.ChatContentAudioInputAudio](/client-sdks/python/api-reference/components/chatcontentaudioinputaudio) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentAudioType](/client-sdks/python/api-reference/components/chatcontentaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentaudioinputaudio.mdx b/client-sdks/python/api-reference/components/chatcontentaudioinputaudio.mdx deleted file mode 100644 index 48ad33a2..00000000 --- a/client-sdks/python/api-reference/components/chatcontentaudioinputaudio.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatContentAudioInputAudio - Python SDK -sidebarTitle: ChatContentAudioInputAudio -description: ChatContentAudioInputAudio method reference -seoTitle: ChatContentAudioInputAudio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudioInputAudio | OpenRouter Python SDK -'og:description': >- - ChatContentAudioInputAudio method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudioInputAudio%20-%20Python%20SDK&description=ChatContentAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | Base64 encoded audio data | -| `format_` | *str* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentaudiotype.mdx b/client-sdks/python/api-reference/components/chatcontentaudiotype.mdx deleted file mode 100644 index 701c9266..00000000 --- a/client-sdks/python/api-reference/components/chatcontentaudiotype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentAudioType - Python SDK -sidebarTitle: ChatContentAudioType -description: ChatContentAudioType method reference -seoTitle: ChatContentAudioType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentaudiotype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudioType | OpenRouter Python SDK -'og:description': >- - ChatContentAudioType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudioType%20-%20Python%20SDK&description=ChatContentAudioType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_AUDIO` | input_audio | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentcachecontrol.mdx b/client-sdks/python/api-reference/components/chatcontentcachecontrol.mdx deleted file mode 100644 index c32b5315..00000000 --- a/client-sdks/python/api-reference/components/chatcontentcachecontrol.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentCacheControl - Python SDK -sidebarTitle: ChatContentCacheControl -description: ChatContentCacheControl method reference -seoTitle: ChatContentCacheControl | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentcachecontrol -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControl | OpenRouter Python SDK -'og:description': >- - ChatContentCacheControl method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControl%20-%20Python%20SDK&description=ChatContentCacheControl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Cache control for the content part - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ttl` | [Optional[components.AnthropicCacheControlTTL]](../components/anthropiccachecontrolttl.md) | :heavy_minus_sign: | N/A | 5m | -| `type` | [components.ChatContentCacheControlType](/client-sdks/python/api-reference/components/chatcontentcachecontroltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentcachecontroltype.mdx b/client-sdks/python/api-reference/components/chatcontentcachecontroltype.mdx deleted file mode 100644 index 669f2b42..00000000 --- a/client-sdks/python/api-reference/components/chatcontentcachecontroltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentCacheControlType - Python SDK -sidebarTitle: ChatContentCacheControlType -description: ChatContentCacheControlType method reference -seoTitle: ChatContentCacheControlType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentcachecontroltype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControlType | OpenRouter Python SDK -'og:description': >- - ChatContentCacheControlType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControlType%20-%20Python%20SDK&description=ChatContentCacheControlType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `EPHEMERAL` | ephemeral | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentfile.mdx b/client-sdks/python/api-reference/components/chatcontentfile.mdx deleted file mode 100644 index 961492c7..00000000 --- a/client-sdks/python/api-reference/components/chatcontentfile.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentFile - Python SDK -sidebarTitle: ChatContentFile -description: ChatContentFile method reference -seoTitle: ChatContentFile | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentfile -'og:site_name': OpenRouter Documentation -'og:title': ChatContentFile | OpenRouter Python SDK -'og:description': >- - ChatContentFile method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentFile%20-%20Python%20SDK&description=ChatContentFile%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -File content part for document processing - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `file` | [components.File](/client-sdks/python/api-reference/components/file) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentFileType](/client-sdks/python/api-reference/components/chatcontentfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentfiletype.mdx b/client-sdks/python/api-reference/components/chatcontentfiletype.mdx deleted file mode 100644 index 85c2e0e5..00000000 --- a/client-sdks/python/api-reference/components/chatcontentfiletype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentFileType - Python SDK -sidebarTitle: ChatContentFileType -description: ChatContentFileType method reference -seoTitle: ChatContentFileType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentfiletype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentFileType | OpenRouter Python SDK -'og:description': >- - ChatContentFileType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentFileType%20-%20Python%20SDK&description=ChatContentFileType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `FILE` | file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentimage.mdx b/client-sdks/python/api-reference/components/chatcontentimage.mdx deleted file mode 100644 index 97ba5356..00000000 --- a/client-sdks/python/api-reference/components/chatcontentimage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentImage - Python SDK -sidebarTitle: ChatContentImage -description: ChatContentImage method reference -seoTitle: ChatContentImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentimage -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImage | OpenRouter Python SDK -'og:description': >- - ChatContentImage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImage%20-%20Python%20SDK&description=ChatContentImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image content part for vision models - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ChatContentImageImageURL](/client-sdks/python/api-reference/components/chatcontentimageimageurl) | :heavy_check_mark: | N/A | -| `type` | [components.ChatContentImageType](/client-sdks/python/api-reference/components/chatcontentimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentimagedetail.mdx b/client-sdks/python/api-reference/components/chatcontentimagedetail.mdx deleted file mode 100644 index bc8f1568..00000000 --- a/client-sdks/python/api-reference/components/chatcontentimagedetail.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatContentImageDetail - Python SDK -sidebarTitle: ChatContentImageDetail -description: ChatContentImageDetail method reference -seoTitle: ChatContentImageDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentimagedetail -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageDetail | OpenRouter Python SDK -'og:description': >- - ChatContentImageDetail method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageDetail%20-%20Python%20SDK&description=ChatContentImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image detail level for vision models - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `LOW` | low | -| `HIGH` | high | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentimageimageurl.mdx b/client-sdks/python/api-reference/components/chatcontentimageimageurl.mdx deleted file mode 100644 index fb5e9938..00000000 --- a/client-sdks/python/api-reference/components/chatcontentimageimageurl.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatContentImageImageURL - Python SDK -sidebarTitle: ChatContentImageImageURL -description: ChatContentImageImageURL method reference -seoTitle: ChatContentImageImageURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageImageURL | OpenRouter Python SDK -'og:description': >- - ChatContentImageImageURL method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageImageURL%20-%20Python%20SDK&description=ChatContentImageImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `detail` | [Optional[components.ChatContentImageDetail]](../components/chatcontentimagedetail.md) | :heavy_minus_sign: | Image detail level for vision models | -| `url` | *str* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentimagetype.mdx b/client-sdks/python/api-reference/components/chatcontentimagetype.mdx deleted file mode 100644 index 48633692..00000000 --- a/client-sdks/python/api-reference/components/chatcontentimagetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentImageType - Python SDK -sidebarTitle: ChatContentImageType -description: ChatContentImageType method reference -seoTitle: ChatContentImageType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentimagetype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageType | OpenRouter Python SDK -'og:description': >- - ChatContentImageType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageType%20-%20Python%20SDK&description=ChatContentImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `IMAGE_URL` | image_url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentitems.mdx b/client-sdks/python/api-reference/components/chatcontentitems.mdx deleted file mode 100644 index c9c6ae5c..00000000 --- a/client-sdks/python/api-reference/components/chatcontentitems.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ChatContentItems - Python SDK -sidebarTitle: ChatContentItems -description: ChatContentItems method reference -seoTitle: ChatContentItems | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentitems -'og:site_name': OpenRouter Documentation -'og:title': ChatContentItems | OpenRouter Python SDK -'og:description': >- - ChatContentItems method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentItems%20-%20Python%20SDK&description=ChatContentItems%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Content part for chat completion messages - -## Supported Types - -### `components.ChatContentFile` - -```python lines -value: components.ChatContentFile = /* values here */ -``` - -### `components.ChatContentImage` - -```python lines -value: components.ChatContentImage = /* values here */ -``` - -### `components.ChatContentAudio` - -```python lines -value: components.ChatContentAudio = /* values here */ -``` - -### `components.LegacyChatContentVideo` - -```python lines -value: components.LegacyChatContentVideo = /* values here */ -``` - -### `components.ChatContentText` - -```python lines -value: components.ChatContentText = /* values here */ -``` - -### `components.ChatContentVideo` - -```python lines -value: components.ChatContentVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontenttext.mdx b/client-sdks/python/api-reference/components/chatcontenttext.mdx deleted file mode 100644 index ffa80f8e..00000000 --- a/client-sdks/python/api-reference/components/chatcontenttext.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatContentText - Python SDK -sidebarTitle: ChatContentText -description: ChatContentText method reference -seoTitle: ChatContentText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontenttext -'og:site_name': OpenRouter Documentation -'og:title': ChatContentText | OpenRouter Python SDK -'og:description': >- - ChatContentText method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentText%20-%20Python%20SDK&description=ChatContentText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text content part - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../components/chatcontentcachecontrol.md) | :heavy_minus_sign: | Cache control for the content part | `{"type": "ephemeral"}` | -| `text` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ChatContentTextType](/client-sdks/python/api-reference/components/chatcontenttexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontenttexttype.mdx b/client-sdks/python/api-reference/components/chatcontenttexttype.mdx deleted file mode 100644 index 7885d6b8..00000000 --- a/client-sdks/python/api-reference/components/chatcontenttexttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentTextType - Python SDK -sidebarTitle: ChatContentTextType -description: ChatContentTextType method reference -seoTitle: ChatContentTextType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontenttexttype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentTextType | OpenRouter Python SDK -'og:description': >- - ChatContentTextType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentTextType%20-%20Python%20SDK&description=ChatContentTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentvideo.mdx b/client-sdks/python/api-reference/components/chatcontentvideo.mdx deleted file mode 100644 index c8bb0d4c..00000000 --- a/client-sdks/python/api-reference/components/chatcontentvideo.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatContentVideo - Python SDK -sidebarTitle: ChatContentVideo -description: ChatContentVideo method reference -seoTitle: ChatContentVideo | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentvideo -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideo | OpenRouter Python SDK -'og:description': >- - ChatContentVideo method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideo%20-%20Python%20SDK&description=ChatContentVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Video input content part - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.ChatContentVideoType](/client-sdks/python/api-reference/components/chatcontentvideotype) | :heavy_check_mark: | N/A | | -| `video_url` | [components.ChatContentVideoInput](/client-sdks/python/api-reference/components/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentvideoinput.mdx b/client-sdks/python/api-reference/components/chatcontentvideoinput.mdx deleted file mode 100644 index a196cae6..00000000 --- a/client-sdks/python/api-reference/components/chatcontentvideoinput.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatContentVideoInput - Python SDK -sidebarTitle: ChatContentVideoInput -description: ChatContentVideoInput method reference -seoTitle: ChatContentVideoInput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentvideoinput -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideoInput | OpenRouter Python SDK -'og:description': >- - ChatContentVideoInput method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideoInput%20-%20Python%20SDK&description=ChatContentVideoInput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Video input object - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `url` | *str* | :heavy_check_mark: | URL of the video (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatcontentvideotype.mdx b/client-sdks/python/api-reference/components/chatcontentvideotype.mdx deleted file mode 100644 index e8b86774..00000000 --- a/client-sdks/python/api-reference/components/chatcontentvideotype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatContentVideoType - Python SDK -sidebarTitle: ChatContentVideoType -description: ChatContentVideoType method reference -seoTitle: ChatContentVideoType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatcontentvideotype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideoType | OpenRouter Python SDK -'og:description': >- - ChatContentVideoType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideoType%20-%20Python%20SDK&description=ChatContentVideoType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `VIDEO_URL` | video_url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatdebugoptions.mdx b/client-sdks/python/api-reference/components/chatdebugoptions.mdx deleted file mode 100644 index 9c5e99f7..00000000 --- a/client-sdks/python/api-reference/components/chatdebugoptions.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatDebugOptions - Python SDK -sidebarTitle: ChatDebugOptions -description: ChatDebugOptions method reference -seoTitle: ChatDebugOptions | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatdebugoptions -'og:site_name': OpenRouter Documentation -'og:title': ChatDebugOptions | OpenRouter Python SDK -'og:description': >- - ChatDebugOptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDebugOptions%20-%20Python%20SDK&description=ChatDebugOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Debug options for inspecting request transformations (streaming only) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `echo_upstream_body` | *Optional[bool]* | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatdevelopermessage.mdx b/client-sdks/python/api-reference/components/chatdevelopermessage.mdx deleted file mode 100644 index 2acd1463..00000000 --- a/client-sdks/python/api-reference/components/chatdevelopermessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatDeveloperMessage - Python SDK -sidebarTitle: ChatDeveloperMessage -description: ChatDeveloperMessage method reference -seoTitle: ChatDeveloperMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatdevelopermessage -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessage | OpenRouter Python SDK -'og:description': >- - ChatDeveloperMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessage%20-%20Python%20SDK&description=ChatDeveloperMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Developer message - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `content` | [components.ChatDeveloperMessageContent](/client-sdks/python/api-reference/components/chatdevelopermessagecontent) | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `role` | [components.ChatDeveloperMessageRole](/client-sdks/python/api-reference/components/chatdevelopermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatdevelopermessagecontent.mdx b/client-sdks/python/api-reference/components/chatdevelopermessagecontent.mdx deleted file mode 100644 index 3255fb6e..00000000 --- a/client-sdks/python/api-reference/components/chatdevelopermessagecontent.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatDeveloperMessageContent - Python SDK -sidebarTitle: ChatDeveloperMessageContent -description: ChatDeveloperMessageContent method reference -seoTitle: ChatDeveloperMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatdevelopermessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessageContent | OpenRouter Python SDK -'og:description': >- - ChatDeveloperMessageContent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessageContent%20-%20Python%20SDK&description=ChatDeveloperMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Developer message content - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatContentText]` - -```python lines -value: List[components.ChatContentText] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatdevelopermessagerole.mdx b/client-sdks/python/api-reference/components/chatdevelopermessagerole.mdx deleted file mode 100644 index d6a59d24..00000000 --- a/client-sdks/python/api-reference/components/chatdevelopermessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatDeveloperMessageRole - Python SDK -sidebarTitle: ChatDeveloperMessageRole -description: ChatDeveloperMessageRole method reference -seoTitle: ChatDeveloperMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatdevelopermessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessageRole | OpenRouter Python SDK -'og:description': >- - ChatDeveloperMessageRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessageRole%20-%20Python%20SDK&description=ChatDeveloperMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatfinishreasonenum.mdx b/client-sdks/python/api-reference/components/chatfinishreasonenum.mdx deleted file mode 100644 index ca4f41e0..00000000 --- a/client-sdks/python/api-reference/components/chatfinishreasonenum.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatFinishReasonEnum - Python SDK -sidebarTitle: ChatFinishReasonEnum -description: ChatFinishReasonEnum method reference -seoTitle: ChatFinishReasonEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatfinishreasonenum -'og:site_name': OpenRouter Documentation -'og:title': ChatFinishReasonEnum | OpenRouter Python SDK -'og:description': >- - ChatFinishReasonEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFinishReasonEnum%20-%20Python%20SDK&description=ChatFinishReasonEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `TOOL_CALLS` | tool_calls | -| `STOP` | stop | -| `LENGTH` | length | -| `CONTENT_FILTER` | content_filter | -| `ERROR` | error | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatgrammarconfig.mdx b/client-sdks/python/api-reference/components/chatformatgrammarconfig.mdx deleted file mode 100644 index 9c0b49f0..00000000 --- a/client-sdks/python/api-reference/components/chatformatgrammarconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatFormatGrammarConfig - Python SDK -sidebarTitle: ChatFormatGrammarConfig -description: ChatFormatGrammarConfig method reference -seoTitle: ChatFormatGrammarConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatgrammarconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatGrammarConfig | OpenRouter Python SDK -'og:description': >- - ChatFormatGrammarConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatGrammarConfig%20-%20Python%20SDK&description=ChatFormatGrammarConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Custom grammar response format - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `grammar` | *str* | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `type` | [components.ChatFormatGrammarConfigType](/client-sdks/python/api-reference/components/chatformatgrammarconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatgrammarconfigtype.mdx b/client-sdks/python/api-reference/components/chatformatgrammarconfigtype.mdx deleted file mode 100644 index 9373de1d..00000000 --- a/client-sdks/python/api-reference/components/chatformatgrammarconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatFormatGrammarConfigType - Python SDK -sidebarTitle: ChatFormatGrammarConfigType -description: ChatFormatGrammarConfigType method reference -seoTitle: ChatFormatGrammarConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatgrammarconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatGrammarConfigType | OpenRouter Python SDK -'og:description': >- - ChatFormatGrammarConfigType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatGrammarConfigType%20-%20Python%20SDK&description=ChatFormatGrammarConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `GRAMMAR` | grammar | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatjsonschemaconfig.mdx b/client-sdks/python/api-reference/components/chatformatjsonschemaconfig.mdx deleted file mode 100644 index 62eb633b..00000000 --- a/client-sdks/python/api-reference/components/chatformatjsonschemaconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatFormatJSONSchemaConfig - Python SDK -sidebarTitle: ChatFormatJSONSchemaConfig -description: ChatFormatJSONSchemaConfig method reference -seoTitle: ChatFormatJSONSchemaConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatJSONSchemaConfig | OpenRouter Python SDK -'og:description': >- - ChatFormatJSONSchemaConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatJSONSchemaConfig%20-%20Python%20SDK&description=ChatFormatJSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON Schema response format for structured outputs - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `json_schema` | [components.ChatJSONSchemaConfig](/client-sdks/python/api-reference/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](/client-sdks/python/api-reference/components/chatformatjsonschemaconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatjsonschemaconfigtype.mdx b/client-sdks/python/api-reference/components/chatformatjsonschemaconfigtype.mdx deleted file mode 100644 index 45ef7cb3..00000000 --- a/client-sdks/python/api-reference/components/chatformatjsonschemaconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatFormatJSONSchemaConfigType - Python SDK -sidebarTitle: ChatFormatJSONSchemaConfigType -description: ChatFormatJSONSchemaConfigType method reference -seoTitle: ChatFormatJSONSchemaConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatjsonschemaconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatJSONSchemaConfigType | OpenRouter Python SDK -'og:description': >- - ChatFormatJSONSchemaConfigType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatJSONSchemaConfigType%20-%20Python%20SDK&description=ChatFormatJSONSchemaConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_SCHEMA` | json_schema | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatpythonconfig.mdx b/client-sdks/python/api-reference/components/chatformatpythonconfig.mdx deleted file mode 100644 index 752da319..00000000 --- a/client-sdks/python/api-reference/components/chatformatpythonconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatFormatPythonConfig - Python SDK -sidebarTitle: ChatFormatPythonConfig -description: ChatFormatPythonConfig method reference -seoTitle: ChatFormatPythonConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatpythonconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatPythonConfig | OpenRouter Python SDK -'og:description': >- - ChatFormatPythonConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatPythonConfig%20-%20Python%20SDK&description=ChatFormatPythonConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Python code response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.ChatFormatPythonConfigType](/client-sdks/python/api-reference/components/chatformatpythonconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformatpythonconfigtype.mdx b/client-sdks/python/api-reference/components/chatformatpythonconfigtype.mdx deleted file mode 100644 index 8feec4ed..00000000 --- a/client-sdks/python/api-reference/components/chatformatpythonconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatFormatPythonConfigType - Python SDK -sidebarTitle: ChatFormatPythonConfigType -description: ChatFormatPythonConfigType method reference -seoTitle: ChatFormatPythonConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformatpythonconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatPythonConfigType | OpenRouter Python SDK -'og:description': >- - ChatFormatPythonConfigType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatPythonConfigType%20-%20Python%20SDK&description=ChatFormatPythonConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `PYTHON` | python | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformattextconfig.mdx b/client-sdks/python/api-reference/components/chatformattextconfig.mdx deleted file mode 100644 index 27273256..00000000 --- a/client-sdks/python/api-reference/components/chatformattextconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatFormatTextConfig - Python SDK -sidebarTitle: ChatFormatTextConfig -description: ChatFormatTextConfig method reference -seoTitle: ChatFormatTextConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformattextconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatTextConfig | OpenRouter Python SDK -'og:description': >- - ChatFormatTextConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatTextConfig%20-%20Python%20SDK&description=ChatFormatTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Default text response format - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ChatFormatTextConfigType](/client-sdks/python/api-reference/components/chatformattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatformattextconfigtype.mdx b/client-sdks/python/api-reference/components/chatformattextconfigtype.mdx deleted file mode 100644 index fb4bbfec..00000000 --- a/client-sdks/python/api-reference/components/chatformattextconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatFormatTextConfigType - Python SDK -sidebarTitle: ChatFormatTextConfigType -description: ChatFormatTextConfigType method reference -seoTitle: ChatFormatTextConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatformattextconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatTextConfigType | OpenRouter Python SDK -'og:description': >- - ChatFormatTextConfigType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatTextConfigType%20-%20Python%20SDK&description=ChatFormatTextConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatfunctiontool.mdx b/client-sdks/python/api-reference/components/chatfunctiontool.mdx deleted file mode 100644 index 47ee92e8..00000000 --- a/client-sdks/python/api-reference/components/chatfunctiontool.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: ChatFunctionTool - Python SDK -sidebarTitle: ChatFunctionTool -description: ChatFunctionTool method reference -seoTitle: ChatFunctionTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatfunctiontool -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionTool | OpenRouter Python SDK -'og:description': >- - ChatFunctionTool method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionTool%20-%20Python%20SDK&description=ChatFunctionTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool definition for function calling (regular function or OpenRouter built-in server tool) - -## Supported Types - -### `components.ChatFunctionToolFunction` - -```python lines -value: components.ChatFunctionToolFunction = /* values here */ -``` - -### `components.DatetimeServerTool` - -```python lines -value: components.DatetimeServerTool = /* values here */ -``` - -### `components.ImageGenerationServerToolOpenRouter` - -```python lines -value: components.ImageGenerationServerToolOpenRouter = /* values here */ -``` - -### `components.ChatSearchModelsServerTool` - -```python lines -value: components.ChatSearchModelsServerTool = /* values here */ -``` - -### `components.WebFetchServerTool` - -```python lines -value: components.WebFetchServerTool = /* values here */ -``` - -### `components.OpenRouterWebSearchServerTool` - -```python lines -value: components.OpenRouterWebSearchServerTool = /* values here */ -``` - -### `components.ChatWebSearchShorthand` - -```python lines -value: components.ChatWebSearchShorthand = /* values here */ -``` - -### `components.ChatWebSearchShorthand` - -```python lines -value: components.ChatWebSearchShorthand = /* values here */ -``` - -### `components.ChatWebSearchShorthand` - -```python lines -value: components.ChatWebSearchShorthand = /* values here */ -``` - -### `components.ChatWebSearchShorthand` - -```python lines -value: components.ChatWebSearchShorthand = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatfunctiontoolfunction.mdx b/client-sdks/python/api-reference/components/chatfunctiontoolfunction.mdx deleted file mode 100644 index 435a9196..00000000 --- a/client-sdks/python/api-reference/components/chatfunctiontoolfunction.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatFunctionToolFunction - Python SDK -sidebarTitle: ChatFunctionToolFunction -description: ChatFunctionToolFunction method reference -seoTitle: ChatFunctionToolFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatfunctiontoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunction | OpenRouter Python SDK -'og:description': >- - ChatFunctionToolFunction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunction%20-%20Python%20SDK&description=ChatFunctionToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.ChatContentCacheControl]](../components/chatcontentcachecontrol.md) | :heavy_minus_sign: | Cache control for the content part | `{"type": "ephemeral"}` | -| `function` | [components.ChatFunctionToolFunctionFunction](/client-sdks/python/api-reference/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](/client-sdks/python/api-reference/components/chatfunctiontooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatfunctiontoolfunctionfunction.mdx b/client-sdks/python/api-reference/components/chatfunctiontoolfunctionfunction.mdx deleted file mode 100644 index 938d439d..00000000 --- a/client-sdks/python/api-reference/components/chatfunctiontoolfunctionfunction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatFunctionToolFunctionFunction - Python SDK -sidebarTitle: ChatFunctionToolFunctionFunction -description: ChatFunctionToolFunctionFunction method reference -seoTitle: ChatFunctionToolFunctionFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatfunctiontoolfunctionfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunctionFunction | OpenRouter Python SDK -'og:description': >- - ChatFunctionToolFunctionFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunctionFunction%20-%20Python%20SDK&description=ChatFunctionToolFunctionFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function definition for tool calling - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `name` | *str* | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | Function parameters as JSON Schema object | `{"properties": {"location": {"description": "City name","type": "string"}`
\},
"required": [
"location"
],
"type": "object"
\} | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatfunctiontooltype.mdx b/client-sdks/python/api-reference/components/chatfunctiontooltype.mdx deleted file mode 100644 index 75948011..00000000 --- a/client-sdks/python/api-reference/components/chatfunctiontooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatFunctionToolType - Python SDK -sidebarTitle: ChatFunctionToolType -description: ChatFunctionToolType method reference -seoTitle: ChatFunctionToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatfunctiontooltype -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolType | OpenRouter Python SDK -'og:description': >- - ChatFunctionToolType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolType%20-%20Python%20SDK&description=ChatFunctionToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatjsonschemaconfig.mdx b/client-sdks/python/api-reference/components/chatjsonschemaconfig.mdx deleted file mode 100644 index 3f36cdb6..00000000 --- a/client-sdks/python/api-reference/components/chatjsonschemaconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatJSONSchemaConfig - Python SDK -sidebarTitle: ChatJSONSchemaConfig -description: ChatJSONSchemaConfig method reference -seoTitle: ChatJSONSchemaConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatJSONSchemaConfig | OpenRouter Python SDK -'og:description': >- - ChatJSONSchemaConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatJSONSchemaConfig%20-%20Python%20SDK&description=ChatJSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON Schema configuration object - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `name` | *str* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `schema_` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | JSON Schema object | `{"properties": {"answer": {"type": "number"}`
\},
"required": [
"answer"
],
"type": "object"
\} | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatmessages.mdx b/client-sdks/python/api-reference/components/chatmessages.mdx deleted file mode 100644 index 5abc9b50..00000000 --- a/client-sdks/python/api-reference/components/chatmessages.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ChatMessages - Python SDK -sidebarTitle: ChatMessages -description: ChatMessages method reference -seoTitle: ChatMessages | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chatmessages' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessages | OpenRouter Python SDK -'og:description': >- - ChatMessages method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessages%20-%20Python%20SDK&description=ChatMessages%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Chat completion message with role-based discrimination - -## Supported Types - -### `components.ChatAssistantMessage` - -```python lines -value: components.ChatAssistantMessage = /* values here */ -``` - -### `components.ChatDeveloperMessage` - -```python lines -value: components.ChatDeveloperMessage = /* values here */ -``` - -### `components.ChatSystemMessage` - -```python lines -value: components.ChatSystemMessage = /* values here */ -``` - -### `components.ChatToolMessage` - -```python lines -value: components.ChatToolMessage = /* values here */ -``` - -### `components.ChatUserMessage` - -```python lines -value: components.ChatUserMessage = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatnamedtoolchoice.mdx b/client-sdks/python/api-reference/components/chatnamedtoolchoice.mdx deleted file mode 100644 index 8594a753..00000000 --- a/client-sdks/python/api-reference/components/chatnamedtoolchoice.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatNamedToolChoice - Python SDK -sidebarTitle: ChatNamedToolChoice -description: ChatNamedToolChoice method reference -seoTitle: ChatNamedToolChoice | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatnamedtoolchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoice | OpenRouter Python SDK -'og:description': >- - ChatNamedToolChoice method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoice%20-%20Python%20SDK&description=ChatNamedToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Named tool choice for specific function - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `function` | [components.ChatNamedToolChoiceFunction](/client-sdks/python/api-reference/components/chatnamedtoolchoicefunction) | :heavy_check_mark: | N/A | -| `type` | [components.ChatNamedToolChoiceType](/client-sdks/python/api-reference/components/chatnamedtoolchoicetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatnamedtoolchoicefunction.mdx b/client-sdks/python/api-reference/components/chatnamedtoolchoicefunction.mdx deleted file mode 100644 index 92aa6303..00000000 --- a/client-sdks/python/api-reference/components/chatnamedtoolchoicefunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatNamedToolChoiceFunction - Python SDK -sidebarTitle: ChatNamedToolChoiceFunction -description: ChatNamedToolChoiceFunction method reference -seoTitle: ChatNamedToolChoiceFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatnamedtoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceFunction | OpenRouter Python SDK -'og:description': >- - ChatNamedToolChoiceFunction method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceFunction%20-%20Python%20SDK&description=ChatNamedToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *str* | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatnamedtoolchoicetype.mdx b/client-sdks/python/api-reference/components/chatnamedtoolchoicetype.mdx deleted file mode 100644 index de044fe5..00000000 --- a/client-sdks/python/api-reference/components/chatnamedtoolchoicetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatNamedToolChoiceType - Python SDK -sidebarTitle: ChatNamedToolChoiceType -description: ChatNamedToolChoiceType method reference -seoTitle: ChatNamedToolChoiceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatnamedtoolchoicetype -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceType | OpenRouter Python SDK -'og:description': >- - ChatNamedToolChoiceType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceType%20-%20Python%20SDK&description=ChatNamedToolChoiceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatreasoningsummaryverbosityenum.mdx b/client-sdks/python/api-reference/components/chatreasoningsummaryverbosityenum.mdx deleted file mode 100644 index 836a34de..00000000 --- a/client-sdks/python/api-reference/components/chatreasoningsummaryverbosityenum.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatReasoningSummaryVerbosityEnum - Python SDK -sidebarTitle: ChatReasoningSummaryVerbosityEnum -description: ChatReasoningSummaryVerbosityEnum method reference -seoTitle: ChatReasoningSummaryVerbosityEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatreasoningsummaryverbosityenum -'og:site_name': OpenRouter Documentation -'og:title': ChatReasoningSummaryVerbosityEnum | OpenRouter Python SDK -'og:description': >- - ChatReasoningSummaryVerbosityEnum method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatReasoningSummaryVerbosityEnum%20-%20Python%20SDK&description=ChatReasoningSummaryVerbosityEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `CONCISE` | concise | -| `DETAILED` | detailed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatrequest.mdx b/client-sdks/python/api-reference/components/chatrequest.mdx deleted file mode 100644 index 6ddb2af3..00000000 --- a/client-sdks/python/api-reference/components/chatrequest.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: ChatRequest - Python SDK -sidebarTitle: ChatRequest -description: ChatRequest method reference -seoTitle: ChatRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chatrequest' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequest | OpenRouter Python SDK -'og:description': >- - ChatRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequest%20-%20Python%20SDK&description=ChatRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Chat completion request parameters - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `debug` | [Optional[components.ChatDebugOptions]](../components/chatdebugoptions.md) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | `{"echo_upstream_body": true}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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"}` | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | `{"50256": -100}` | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `messages` | List[[components.ChatMessages](/client-sdks/python/api-reference/components/chatmessages)] | :heavy_check_mark: | List of messages for the conversation | [
`{"content": "Hello!","role": "user"}`
] | -| `metadata` | Dict[str, *str*] | :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"}` | -| `modalities` | List[[components.Modality](/client-sdks/python/api-reference/components/modality)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](/client-sdks/python/api-reference/components/chatrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [Optional[components.ChatRequestReasoning]](../components/chatrequestreasoning.md) | :heavy_minus_sign: | Configuration options for reasoning models | `{"effort": "medium","summary": "concise"}` | -| `response_format` | [Optional[components.ResponseFormat]](../components/responseformat.md) | :heavy_minus_sign: | Response format configuration | `{"type": "json_object"}` | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](../components/chatrequestservicetier.md) | :heavy_minus_sign: | The service tier to use for processing this request. | auto | -| `session_id` | *Optional[str]* | :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[components.Stop]](../components/stop.md) | :heavy_minus_sign: | Stop sequences (up to 4) | [
""
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | Streaming configuration options | `{"include_usage": true}` | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](../components/chattoolchoice.md) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](/client-sdks/python/api-reference/components/chatfunctiontool)] | :heavy_minus_sign: | Available tools for function calling | [
`{"function": {"description": "Get weather","name": "get_weather"}`,
"type": "function"
\}
] | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](../components/traceconfig.md) | :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` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | user-123 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatrequesteffort.mdx b/client-sdks/python/api-reference/components/chatrequesteffort.mdx deleted file mode 100644 index 79c61fd9..00000000 --- a/client-sdks/python/api-reference/components/chatrequesteffort.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatRequestEffort - Python SDK -sidebarTitle: ChatRequestEffort -description: ChatRequestEffort method reference -seoTitle: ChatRequestEffort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatrequesteffort -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestEffort | OpenRouter Python SDK -'og:description': >- - ChatRequestEffort method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestEffort%20-%20Python%20SDK&description=ChatRequestEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Constrains effort on reasoning for reasoning models - -## Values - -| Name | Value | -| --------- | --------- | -| `XHIGH` | xhigh | -| `HIGH` | high | -| `MEDIUM` | medium | -| `LOW` | low | -| `MINIMAL` | minimal | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatrequestplugin.mdx b/client-sdks/python/api-reference/components/chatrequestplugin.mdx deleted file mode 100644 index 0b7a1060..00000000 --- a/client-sdks/python/api-reference/components/chatrequestplugin.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: ChatRequestPlugin - Python SDK -sidebarTitle: ChatRequestPlugin -description: ChatRequestPlugin method reference -seoTitle: ChatRequestPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestPlugin | OpenRouter Python SDK -'og:description': >- - ChatRequestPlugin method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestPlugin%20-%20Python%20SDK&description=ChatRequestPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AutoRouterPlugin` - -```python lines -value: components.AutoRouterPlugin = /* values here */ -``` - -### `components.ContextCompressionPlugin` - -```python lines -value: components.ContextCompressionPlugin = /* values here */ -``` - -### `components.FileParserPlugin` - -```python lines -value: components.FileParserPlugin = /* values here */ -``` - -### `components.FusionPlugin` - -```python lines -value: components.FusionPlugin = /* values here */ -``` - -### `components.ModerationPlugin` - -```python lines -value: components.ModerationPlugin = /* values here */ -``` - -### `components.ParetoRouterPlugin` - -```python lines -value: components.ParetoRouterPlugin = /* values here */ -``` - -### `components.ResponseHealingPlugin` - -```python lines -value: components.ResponseHealingPlugin = /* values here */ -``` - -### `components.WebSearchPlugin` - -```python lines -value: components.WebSearchPlugin = /* values here */ -``` - -### `components.WebFetchPlugin` - -```python lines -value: components.WebFetchPlugin = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatrequestreasoning.mdx b/client-sdks/python/api-reference/components/chatrequestreasoning.mdx deleted file mode 100644 index d2fb9be3..00000000 --- a/client-sdks/python/api-reference/components/chatrequestreasoning.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatRequestReasoning - Python SDK -sidebarTitle: ChatRequestReasoning -description: ChatRequestReasoning method reference -seoTitle: ChatRequestReasoning | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatrequestreasoning -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestReasoning | OpenRouter Python SDK -'og:description': >- - ChatRequestReasoning method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestReasoning%20-%20Python%20SDK&description=ChatRequestReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration options for reasoning models - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.ChatRequestEffort]](../components/chatrequesteffort.md) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [OptionalNullable[components.ChatReasoningSummaryVerbosityEnum]](../components/chatreasoningsummaryverbosityenum.md) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatrequestservicetier.mdx b/client-sdks/python/api-reference/components/chatrequestservicetier.mdx deleted file mode 100644 index d5eab0ef..00000000 --- a/client-sdks/python/api-reference/components/chatrequestservicetier.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatRequestServiceTier - Python SDK -sidebarTitle: ChatRequestServiceTier -description: ChatRequestServiceTier method reference -seoTitle: ChatRequestServiceTier | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatrequestservicetier -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestServiceTier | OpenRouter Python SDK -'og:description': >- - ChatRequestServiceTier method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestServiceTier%20-%20Python%20SDK&description=ChatRequestServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The service tier to use for processing this request. - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DEFAULT` | default | -| `FLEX` | flex | -| `PRIORITY` | priority | -| `SCALE` | scale | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatresult.mdx b/client-sdks/python/api-reference/components/chatresult.mdx deleted file mode 100644 index 0b139a8c..00000000 --- a/client-sdks/python/api-reference/components/chatresult.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatResult - Python SDK -sidebarTitle: ChatResult -description: ChatResult method reference -seoTitle: ChatResult | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chatresult' -'og:site_name': OpenRouter Documentation -'og:title': ChatResult | OpenRouter Python SDK -'og:description': >- - ChatResult method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResult%20-%20Python%20SDK&description=ChatResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Chat completion response - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatChoice](/client-sdks/python/api-reference/components/chatchoice)] | :heavy_check_mark: | List of completion choices | | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `id` | *str* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | -| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatResultObject](/client-sdks/python/api-reference/components/chatresultobject) | :heavy_check_mark: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../components/openroutermetadata.md) | :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"
\} | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Nullable[str]* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../components/chatusage.md) | :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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatresultobject.mdx b/client-sdks/python/api-reference/components/chatresultobject.mdx deleted file mode 100644 index 9e34c4ad..00000000 --- a/client-sdks/python/api-reference/components/chatresultobject.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatResultObject - Python SDK -sidebarTitle: ChatResultObject -description: ChatResultObject method reference -seoTitle: ChatResultObject | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatresultobject -'og:site_name': OpenRouter Documentation -'og:title': ChatResultObject | OpenRouter Python SDK -'og:description': >- - ChatResultObject method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResultObject%20-%20Python%20SDK&description=ChatResultObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `CHAT_COMPLETION` | chat.completion | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatsearchmodelsservertool.mdx b/client-sdks/python/api-reference/components/chatsearchmodelsservertool.mdx deleted file mode 100644 index 91baf4c1..00000000 --- a/client-sdks/python/api-reference/components/chatsearchmodelsservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatSearchModelsServerTool - Python SDK -sidebarTitle: ChatSearchModelsServerTool -description: ChatSearchModelsServerTool method reference -seoTitle: ChatSearchModelsServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatsearchmodelsservertool -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerTool | OpenRouter Python SDK -'og:description': >- - ChatSearchModelsServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerTool%20-%20Python%20SDK&description=ChatSearchModelsServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches and filters AI models available on OpenRouter - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.SearchModelsServerToolConfig]](../components/searchmodelsservertoolconfig.md) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | `{"max_results": 5}` | -| `type` | [components.ChatSearchModelsServerToolType](/client-sdks/python/api-reference/components/chatsearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatsearchmodelsservertooltype.mdx b/client-sdks/python/api-reference/components/chatsearchmodelsservertooltype.mdx deleted file mode 100644 index e7529a3b..00000000 --- a/client-sdks/python/api-reference/components/chatsearchmodelsservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatSearchModelsServerToolType - Python SDK -sidebarTitle: ChatSearchModelsServerToolType -description: ChatSearchModelsServerToolType method reference -seoTitle: ChatSearchModelsServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatsearchmodelsservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerToolType | OpenRouter Python SDK -'og:description': >- - ChatSearchModelsServerToolType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerToolType%20-%20Python%20SDK&description=ChatSearchModelsServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `OPENROUTER_EXPERIMENTAL_SEARCH_MODELS` | openrouter:experimental__search_models | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatservertoolchoice.mdx b/client-sdks/python/api-reference/components/chatservertoolchoice.mdx deleted file mode 100644 index 07e0da35..00000000 --- a/client-sdks/python/api-reference/components/chatservertoolchoice.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatServerToolChoice - Python SDK -sidebarTitle: ChatServerToolChoice -description: ChatServerToolChoice method reference -seoTitle: ChatServerToolChoice | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatservertoolchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatServerToolChoice | OpenRouter Python SDK -'og:description': >- - ChatServerToolChoice method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatServerToolChoice%20-%20Python%20SDK&description=ChatServerToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter extension: force a specific server tool by naming it directly in `tool_choice.type` instead of wrapping it in `{ type: "function", function: { name } }`. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | *str* | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamchoice.mdx b/client-sdks/python/api-reference/components/chatstreamchoice.mdx deleted file mode 100644 index b5887eff..00000000 --- a/client-sdks/python/api-reference/components/chatstreamchoice.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatStreamChoice - Python SDK -sidebarTitle: ChatStreamChoice -description: ChatStreamChoice method reference -seoTitle: ChatStreamChoice | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChoice | OpenRouter Python SDK -'og:description': >- - ChatStreamChoice method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChoice%20-%20Python%20SDK&description=ChatStreamChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Streaming completion choice chunk - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [components.ChatStreamDelta](/client-sdks/python/api-reference/components/chatstreamdelta) | :heavy_check_mark: | Delta changes in streaming response | `{"content": "Hello","role": "assistant"}` | -| `finish_reason` | [Nullable[components.ChatFinishReasonEnum]](../components/chatfinishreasonenum.md) | :heavy_check_mark: | N/A | stop | -| `index` | *int* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [OptionalNullable[components.ChatTokenLogprobs]](../components/chattokenlogprobs.md) | :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/client-sdks/python/api-reference/components/chatstreamchunk.mdx b/client-sdks/python/api-reference/components/chatstreamchunk.mdx deleted file mode 100644 index b327640c..00000000 --- a/client-sdks/python/api-reference/components/chatstreamchunk.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamChunk - Python SDK -sidebarTitle: ChatStreamChunk -description: ChatStreamChunk method reference -seoTitle: ChatStreamChunk | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamchunk -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunk | OpenRouter Python SDK -'og:description': >- - ChatStreamChunk method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunk%20-%20Python%20SDK&description=ChatStreamChunk%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Streaming chat completion chunk - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | List[[components.ChatStreamChoice](/client-sdks/python/api-reference/components/chatstreamchoice)] | :heavy_check_mark: | List of streaming chunk choices | | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `error` | [Optional[components.Error]](../components/error.md) | :heavy_minus_sign: | Error information | `{"code": 429,"message": "Rate limit exceeded"}` | -| `id` | *str* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | -| `model` | *str* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [components.ChatStreamChunkObject](/client-sdks/python/api-reference/components/chatstreamchunkobject) | :heavy_check_mark: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../components/openroutermetadata.md) | :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"
\} | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `usage` | [Optional[components.ChatUsage]](../components/chatusage.md) | :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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamchunkobject.mdx b/client-sdks/python/api-reference/components/chatstreamchunkobject.mdx deleted file mode 100644 index 671e14d3..00000000 --- a/client-sdks/python/api-reference/components/chatstreamchunkobject.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatStreamChunkObject - Python SDK -sidebarTitle: ChatStreamChunkObject -description: ChatStreamChunkObject method reference -seoTitle: ChatStreamChunkObject | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamchunkobject -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunkObject | OpenRouter Python SDK -'og:description': >- - ChatStreamChunkObject method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunkObject%20-%20Python%20SDK&description=ChatStreamChunkObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `CHAT_COMPLETION_CHUNK` | chat.completion.chunk | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamdelta.mdx b/client-sdks/python/api-reference/components/chatstreamdelta.mdx deleted file mode 100644 index 4068f92d..00000000 --- a/client-sdks/python/api-reference/components/chatstreamdelta.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatStreamDelta - Python SDK -sidebarTitle: ChatStreamDelta -description: ChatStreamDelta method reference -seoTitle: ChatStreamDelta | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamdelta -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDelta | OpenRouter Python SDK -'og:description': >- - ChatStreamDelta method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDelta%20-%20Python%20SDK&description=ChatStreamDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Delta changes in streaming response - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [Optional[components.ChatAudioOutput]](../components/chataudiooutput.md) | :heavy_minus_sign: | N/A | `{"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f","expires_at": 1677652400,"id": "audio_abc123","transcript": "Hello! How can I help you today?"}` | -| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | Message content delta | Hello | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | Reasoning content delta | I need to | -| `reasoning_details` | List[[components.ReasoningDetailUnion](/client-sdks/python/api-reference/components/reasoningdetailunion)] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"text": "Let me think about this...","type": "text"}`
] | -| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | Refusal message delta | `` | -| `role` | [Optional[components.ChatStreamDeltaRole]](../components/chatstreamdeltarole.md) | :heavy_minus_sign: | The role of the message author | assistant | -| `tool_calls` | List[[components.ChatStreamToolCall](/client-sdks/python/api-reference/components/chatstreamtoolcall)] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamdeltarole.mdx b/client-sdks/python/api-reference/components/chatstreamdeltarole.mdx deleted file mode 100644 index 01ba4fdd..00000000 --- a/client-sdks/python/api-reference/components/chatstreamdeltarole.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatStreamDeltaRole - Python SDK -sidebarTitle: ChatStreamDeltaRole -description: ChatStreamDeltaRole method reference -seoTitle: ChatStreamDeltaRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamdeltarole -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDeltaRole | OpenRouter Python SDK -'og:description': >- - ChatStreamDeltaRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDeltaRole%20-%20Python%20SDK&description=ChatStreamDeltaRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The role of the message author - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamingresponse.mdx b/client-sdks/python/api-reference/components/chatstreamingresponse.mdx deleted file mode 100644 index 98f25ea7..00000000 --- a/client-sdks/python/api-reference/components/chatstreamingresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatStreamingResponse - Python SDK -sidebarTitle: ChatStreamingResponse -description: ChatStreamingResponse method reference -seoTitle: ChatStreamingResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponse | OpenRouter Python SDK -'og:description': >- - ChatStreamingResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponse%20-%20Python%20SDK&description=ChatStreamingResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ChatStreamChunk](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/chatstreamoptions.mdx b/client-sdks/python/api-reference/components/chatstreamoptions.mdx deleted file mode 100644 index a066df56..00000000 --- a/client-sdks/python/api-reference/components/chatstreamoptions.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatStreamOptions - Python SDK -sidebarTitle: ChatStreamOptions -description: ChatStreamOptions method reference -seoTitle: ChatStreamOptions | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamoptions -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamOptions | OpenRouter Python SDK -'og:description': >- - ChatStreamOptions method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamOptions%20-%20Python%20SDK&description=ChatStreamOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Streaming configuration options - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`include_usage`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamtoolcall.mdx b/client-sdks/python/api-reference/components/chatstreamtoolcall.mdx deleted file mode 100644 index a0f80998..00000000 --- a/client-sdks/python/api-reference/components/chatstreamtoolcall.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatStreamToolCall - Python SDK -sidebarTitle: ChatStreamToolCall -description: ChatStreamToolCall method reference -seoTitle: ChatStreamToolCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamtoolcall -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCall | OpenRouter Python SDK -'og:description': >- - ChatStreamToolCall method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCall%20-%20Python%20SDK&description=ChatStreamToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool call delta for streaming responses - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `function` | [Optional[components.ChatStreamToolCallFunction]](../components/chatstreamtoolcallfunction.md) | :heavy_minus_sign: | Function call details | | -| `id` | *Optional[str]* | :heavy_minus_sign: | Tool call identifier | call_abc123 | -| `index` | *int* | :heavy_check_mark: | Tool call index in the array | 0 | -| `type` | [Optional[components.ChatStreamToolCallType]](../components/chatstreamtoolcalltype.md) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamtoolcallfunction.mdx b/client-sdks/python/api-reference/components/chatstreamtoolcallfunction.mdx deleted file mode 100644 index 150d30ff..00000000 --- a/client-sdks/python/api-reference/components/chatstreamtoolcallfunction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatStreamToolCallFunction - Python SDK -sidebarTitle: ChatStreamToolCallFunction -description: ChatStreamToolCallFunction method reference -seoTitle: ChatStreamToolCallFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamtoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallFunction | OpenRouter Python SDK -'og:description': >- - ChatStreamToolCallFunction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallFunction%20-%20Python%20SDK&description=ChatStreamToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function call details - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *Optional[str]* | :heavy_minus_sign: | Function arguments as JSON string | `{"location": "..."}` | -| `name` | *Optional[str]* | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatstreamtoolcalltype.mdx b/client-sdks/python/api-reference/components/chatstreamtoolcalltype.mdx deleted file mode 100644 index 04c3a6c9..00000000 --- a/client-sdks/python/api-reference/components/chatstreamtoolcalltype.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatStreamToolCallType - Python SDK -sidebarTitle: ChatStreamToolCallType -description: ChatStreamToolCallType method reference -seoTitle: ChatStreamToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatstreamtoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallType | OpenRouter Python SDK -'og:description': >- - ChatStreamToolCallType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallType%20-%20Python%20SDK&description=ChatStreamToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool call type - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatsystemmessage.mdx b/client-sdks/python/api-reference/components/chatsystemmessage.mdx deleted file mode 100644 index c2acb08c..00000000 --- a/client-sdks/python/api-reference/components/chatsystemmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatSystemMessage - Python SDK -sidebarTitle: ChatSystemMessage -description: ChatSystemMessage method reference -seoTitle: ChatSystemMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatsystemmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessage | OpenRouter Python SDK -'og:description': >- - ChatSystemMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessage%20-%20Python%20SDK&description=ChatSystemMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -System message for setting behavior - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content` | [components.ChatSystemMessageContent](/client-sdks/python/api-reference/components/chatsystemmessagecontent) | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `role` | [components.ChatSystemMessageRole](/client-sdks/python/api-reference/components/chatsystemmessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatsystemmessagecontent.mdx b/client-sdks/python/api-reference/components/chatsystemmessagecontent.mdx deleted file mode 100644 index c6cc8894..00000000 --- a/client-sdks/python/api-reference/components/chatsystemmessagecontent.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatSystemMessageContent - Python SDK -sidebarTitle: ChatSystemMessageContent -description: ChatSystemMessageContent method reference -seoTitle: ChatSystemMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatsystemmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessageContent | OpenRouter Python SDK -'og:description': >- - ChatSystemMessageContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessageContent%20-%20Python%20SDK&description=ChatSystemMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -System message content - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatContentText]` - -```python lines -value: List[components.ChatContentText] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatsystemmessagerole.mdx b/client-sdks/python/api-reference/components/chatsystemmessagerole.mdx deleted file mode 100644 index 92b728d8..00000000 --- a/client-sdks/python/api-reference/components/chatsystemmessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatSystemMessageRole - Python SDK -sidebarTitle: ChatSystemMessageRole -description: ChatSystemMessageRole method reference -seoTitle: ChatSystemMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatsystemmessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessageRole | OpenRouter Python SDK -'og:description': >- - ChatSystemMessageRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessageRole%20-%20Python%20SDK&description=ChatSystemMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattokenlogprob.mdx b/client-sdks/python/api-reference/components/chattokenlogprob.mdx deleted file mode 100644 index c9d2a34d..00000000 --- a/client-sdks/python/api-reference/components/chattokenlogprob.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ChatTokenLogprob - Python SDK -sidebarTitle: ChatTokenLogprob -description: ChatTokenLogprob method reference -seoTitle: ChatTokenLogprob | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattokenlogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprob | OpenRouter Python SDK -'og:description': >- - ChatTokenLogprob method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprob%20-%20Python%20SDK&description=ChatTokenLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Token log probability information - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | UTF-8 bytes of the token | -| `logprob` | *float* | :heavy_check_mark: | Log probability of the token | -| `token` | *str* | :heavy_check_mark: | The token | -| `top_logprobs` | List[[components.ChatTokenLogprobTopLogprob](/client-sdks/python/api-reference/components/chattokenlogprobtoplogprob)] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattokenlogprobs.mdx b/client-sdks/python/api-reference/components/chattokenlogprobs.mdx deleted file mode 100644 index 539a3e0b..00000000 --- a/client-sdks/python/api-reference/components/chattokenlogprobs.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatTokenLogprobs - Python SDK -sidebarTitle: ChatTokenLogprobs -description: ChatTokenLogprobs method reference -seoTitle: ChatTokenLogprobs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattokenlogprobs -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobs | OpenRouter Python SDK -'og:description': >- - ChatTokenLogprobs method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobs%20-%20Python%20SDK&description=ChatTokenLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Log probabilities for the completion - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `content` | List[[components.ChatTokenLogprob](/client-sdks/python/api-reference/components/chattokenlogprob)] | :heavy_check_mark: | Log probabilities for content tokens | -| `refusal` | List[[components.ChatTokenLogprob](/client-sdks/python/api-reference/components/chattokenlogprob)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattokenlogprobtoplogprob.mdx b/client-sdks/python/api-reference/components/chattokenlogprobtoplogprob.mdx deleted file mode 100644 index a679e2d5..00000000 --- a/client-sdks/python/api-reference/components/chattokenlogprobtoplogprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatTokenLogprobTopLogprob - Python SDK -sidebarTitle: ChatTokenLogprobTopLogprob -description: ChatTokenLogprobTopLogprob method reference -seoTitle: ChatTokenLogprobTopLogprob | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattokenlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobTopLogprob | OpenRouter Python SDK -'og:description': >- - ChatTokenLogprobTopLogprob method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobTopLogprob%20-%20Python%20SDK&description=ChatTokenLogprobTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolcall.mdx b/client-sdks/python/api-reference/components/chattoolcall.mdx deleted file mode 100644 index d7bbb573..00000000 --- a/client-sdks/python/api-reference/components/chattoolcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatToolCall - Python SDK -sidebarTitle: ChatToolCall -description: ChatToolCall method reference -seoTitle: ChatToolCall | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chattoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCall | OpenRouter Python SDK -'og:description': >- - ChatToolCall method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCall%20-%20Python%20SDK&description=ChatToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool call made by the assistant - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `function` | [components.ChatToolCallFunction](/client-sdks/python/api-reference/components/chattoolcallfunction) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | Tool call identifier | -| `type` | [components.ChatToolCallType](/client-sdks/python/api-reference/components/chattoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolcallfunction.mdx b/client-sdks/python/api-reference/components/chattoolcallfunction.mdx deleted file mode 100644 index 22af1a8b..00000000 --- a/client-sdks/python/api-reference/components/chattoolcallfunction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatToolCallFunction - Python SDK -sidebarTitle: ChatToolCallFunction -description: ChatToolCallFunction method reference -seoTitle: ChatToolCallFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallFunction | OpenRouter Python SDK -'og:description': >- - ChatToolCallFunction method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallFunction%20-%20Python%20SDK&description=ChatToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | Function arguments as JSON string | -| `name` | *str* | :heavy_check_mark: | Function name to call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolcalltype.mdx b/client-sdks/python/api-reference/components/chattoolcalltype.mdx deleted file mode 100644 index 45b89d15..00000000 --- a/client-sdks/python/api-reference/components/chattoolcalltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolCallType - Python SDK -sidebarTitle: ChatToolCallType -description: ChatToolCallType method reference -seoTitle: ChatToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallType | OpenRouter Python SDK -'og:description': >- - ChatToolCallType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallType%20-%20Python%20SDK&description=ChatToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolchoice.mdx b/client-sdks/python/api-reference/components/chattoolchoice.mdx deleted file mode 100644 index 6930d88f..00000000 --- a/client-sdks/python/api-reference/components/chattoolchoice.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ChatToolChoice - Python SDK -sidebarTitle: ChatToolChoice -description: ChatToolChoice method reference -seoTitle: ChatToolChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chattoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoice | OpenRouter Python SDK -'og:description': >- - ChatToolChoice method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoice%20-%20Python%20SDK&description=ChatToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool choice configuration - -## Supported Types - -### `components.ChatToolChoiceNone` - -```python lines -value: components.ChatToolChoiceNone = /* values here */ -``` - -### `components.ChatToolChoiceAuto` - -```python lines -value: components.ChatToolChoiceAuto = /* values here */ -``` - -### `components.ChatToolChoiceRequired` - -```python lines -value: components.ChatToolChoiceRequired = /* values here */ -``` - -### `components.ChatNamedToolChoice` - -```python lines -value: components.ChatNamedToolChoice = /* values here */ -``` - -### `components.ChatServerToolChoice` - -```python lines -value: components.ChatServerToolChoice = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolchoiceauto.mdx b/client-sdks/python/api-reference/components/chattoolchoiceauto.mdx deleted file mode 100644 index a83ade31..00000000 --- a/client-sdks/python/api-reference/components/chattoolchoiceauto.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolChoiceAuto - Python SDK -sidebarTitle: ChatToolChoiceAuto -description: ChatToolChoiceAuto method reference -seoTitle: ChatToolChoiceAuto | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceAuto | OpenRouter Python SDK -'og:description': >- - ChatToolChoiceAuto method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceAuto%20-%20Python%20SDK&description=ChatToolChoiceAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolchoicenone.mdx b/client-sdks/python/api-reference/components/chattoolchoicenone.mdx deleted file mode 100644 index 0cc3c94d..00000000 --- a/client-sdks/python/api-reference/components/chattoolchoicenone.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolChoiceNone - Python SDK -sidebarTitle: ChatToolChoiceNone -description: ChatToolChoiceNone method reference -seoTitle: ChatToolChoiceNone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceNone | OpenRouter Python SDK -'og:description': >- - ChatToolChoiceNone method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceNone%20-%20Python%20SDK&description=ChatToolChoiceNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolchoicerequired.mdx b/client-sdks/python/api-reference/components/chattoolchoicerequired.mdx deleted file mode 100644 index 7a14f5d3..00000000 --- a/client-sdks/python/api-reference/components/chattoolchoicerequired.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolChoiceRequired - Python SDK -sidebarTitle: ChatToolChoiceRequired -description: ChatToolChoiceRequired method reference -seoTitle: ChatToolChoiceRequired | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceRequired | OpenRouter Python SDK -'og:description': >- - ChatToolChoiceRequired method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceRequired%20-%20Python%20SDK&description=ChatToolChoiceRequired%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `REQUIRED` | required | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolmessage.mdx b/client-sdks/python/api-reference/components/chattoolmessage.mdx deleted file mode 100644 index 1d8698c8..00000000 --- a/client-sdks/python/api-reference/components/chattoolmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatToolMessage - Python SDK -sidebarTitle: ChatToolMessage -description: ChatToolMessage method reference -seoTitle: ChatToolMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessage | OpenRouter Python SDK -'og:description': >- - ChatToolMessage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessage%20-%20Python%20SDK&description=ChatToolMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool response message - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatToolMessageContent](/client-sdks/python/api-reference/components/chattoolmessagecontent) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `role` | [components.ChatToolMessageRole](/client-sdks/python/api-reference/components/chattoolmessagerole) | :heavy_check_mark: | N/A | | -| `tool_call_id` | *str* | :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/client-sdks/python/api-reference/components/chattoolmessagecontent.mdx b/client-sdks/python/api-reference/components/chattoolmessagecontent.mdx deleted file mode 100644 index 02795add..00000000 --- a/client-sdks/python/api-reference/components/chattoolmessagecontent.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatToolMessageContent - Python SDK -sidebarTitle: ChatToolMessageContent -description: ChatToolMessageContent method reference -seoTitle: ChatToolMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessageContent | OpenRouter Python SDK -'og:description': >- - ChatToolMessageContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessageContent%20-%20Python%20SDK&description=ChatToolMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tool response content - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatContentItems]` - -```python lines -value: List[components.ChatContentItems] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chattoolmessagerole.mdx b/client-sdks/python/api-reference/components/chattoolmessagerole.mdx deleted file mode 100644 index d20b3989..00000000 --- a/client-sdks/python/api-reference/components/chattoolmessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatToolMessageRole - Python SDK -sidebarTitle: ChatToolMessageRole -description: ChatToolMessageRole method reference -seoTitle: ChatToolMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chattoolmessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessageRole | OpenRouter Python SDK -'og:description': >- - ChatToolMessageRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessageRole%20-%20Python%20SDK&description=ChatToolMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TOOL` | tool | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatusage.mdx b/client-sdks/python/api-reference/components/chatusage.mdx deleted file mode 100644 index 09eafe0a..00000000 --- a/client-sdks/python/api-reference/components/chatusage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatUsage - Python SDK -sidebarTitle: ChatUsage -description: ChatUsage method reference -seoTitle: ChatUsage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/chatusage' -'og:site_name': OpenRouter Documentation -'og:title': ChatUsage | OpenRouter Python SDK -'og:description': >- - ChatUsage method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUsage%20-%20Python%20SDK&description=ChatUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `completion_tokens` | *int* | :heavy_check_mark: | Number of tokens in the completion | | -| `completion_tokens_details` | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign: | Detailed completion token usage | | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | | -| `cost_details` | [OptionalNullable[components.CostDetails]](../components/costdetails.md) | :heavy_minus_sign: | Breakdown of upstream inference costs | `{"upstream_inference_completions_cost": 0.0004,"upstream_inference_cost": null,"upstream_inference_prompt_cost": 0.0008}` | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the prompt | | -| `prompt_tokens_details` | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md) | :heavy_minus_sign: | Detailed prompt token usage | | -| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatusermessage.mdx b/client-sdks/python/api-reference/components/chatusermessage.mdx deleted file mode 100644 index 7209ae35..00000000 --- a/client-sdks/python/api-reference/components/chatusermessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatUserMessage - Python SDK -sidebarTitle: ChatUserMessage -description: ChatUserMessage method reference -seoTitle: ChatUserMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatusermessage -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessage | OpenRouter Python SDK -'og:description': >- - ChatUserMessage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessage%20-%20Python%20SDK&description=ChatUserMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -User message - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content` | [components.ChatUserMessageContent](/client-sdks/python/api-reference/components/chatusermessagecontent) | :heavy_check_mark: | User message content | What is the capital of France? | -| `name` | *Optional[str]* | :heavy_minus_sign: | Optional name for the user | User | -| `role` | [components.ChatUserMessageRole](/client-sdks/python/api-reference/components/chatusermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatusermessagecontent.mdx b/client-sdks/python/api-reference/components/chatusermessagecontent.mdx deleted file mode 100644 index 977564fe..00000000 --- a/client-sdks/python/api-reference/components/chatusermessagecontent.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatUserMessageContent - Python SDK -sidebarTitle: ChatUserMessageContent -description: ChatUserMessageContent method reference -seoTitle: ChatUserMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatusermessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessageContent | OpenRouter Python SDK -'og:description': >- - ChatUserMessageContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessageContent%20-%20Python%20SDK&description=ChatUserMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -User message content - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatContentItems]` - -```python lines -value: List[components.ChatContentItems] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatusermessagerole.mdx b/client-sdks/python/api-reference/components/chatusermessagerole.mdx deleted file mode 100644 index feb0377f..00000000 --- a/client-sdks/python/api-reference/components/chatusermessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatUserMessageRole - Python SDK -sidebarTitle: ChatUserMessageRole -description: ChatUserMessageRole method reference -seoTitle: ChatUserMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatusermessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessageRole | OpenRouter Python SDK -'og:description': >- - ChatUserMessageRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessageRole%20-%20Python%20SDK&description=ChatUserMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/chatwebsearchshorthand.mdx b/client-sdks/python/api-reference/components/chatwebsearchshorthand.mdx deleted file mode 100644 index 5077e875..00000000 --- a/client-sdks/python/api-reference/components/chatwebsearchshorthand.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatWebSearchShorthand - Python SDK -sidebarTitle: ChatWebSearchShorthand -description: ChatWebSearchShorthand method reference -seoTitle: ChatWebSearchShorthand | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatwebsearchshorthand -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthand | OpenRouter Python SDK -'og:description': >- - ChatWebSearchShorthand method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthand%20-%20Python%20SDK&description=ChatWebSearchShorthand%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search tool using OpenAI Responses API syntax. Automatically converted to openrouter:web_search. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `excluded_domains` | List[*str*] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `max_total_results` | *Optional[int]* | :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 | -| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.md) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../components/searchqualitylevel.md) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `type` | [components.ChatWebSearchShorthandType](/client-sdks/python/api-reference/components/chatwebsearchshorthandtype) | :heavy_check_mark: | N/A | | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.md) | :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/client-sdks/python/api-reference/components/chatwebsearchshorthandtype.mdx b/client-sdks/python/api-reference/components/chatwebsearchshorthandtype.mdx deleted file mode 100644 index 63b154f7..00000000 --- a/client-sdks/python/api-reference/components/chatwebsearchshorthandtype.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatWebSearchShorthandType - Python SDK -sidebarTitle: ChatWebSearchShorthandType -description: ChatWebSearchShorthandType method reference -seoTitle: ChatWebSearchShorthandType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/chatwebsearchshorthandtype -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthandType | OpenRouter Python SDK -'og:description': >- - ChatWebSearchShorthandType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthandType%20-%20Python%20SDK&description=ChatWebSearchShorthandType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `WEB_SEARCH` | web_search | -| `WEB_SEARCH_PREVIEW` | web_search_preview | -| `WEB_SEARCH_PREVIEW_2025_03_11` | web_search_preview_2025_03_11 | -| `WEB_SEARCH_2025_08_26` | web_search_2025_08_26 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/citation.mdx b/client-sdks/python/api-reference/components/citation.mdx deleted file mode 100644 index c42b1a6b..00000000 --- a/client-sdks/python/api-reference/components/citation.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Citation - Python SDK -sidebarTitle: Citation -description: Citation method reference -seoTitle: Citation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/citation' -'og:site_name': OpenRouter Documentation -'og:title': Citation | OpenRouter Python SDK -'og:description': >- - Citation method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Citation%20-%20Python%20SDK&description=Citation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicCitationCharLocationParam` - -```python lines -value: components.AnthropicCitationCharLocationParam = /* values here */ -``` - -### `components.AnthropicCitationContentBlockLocationParam` - -```python lines -value: components.AnthropicCitationContentBlockLocationParam = /* values here */ -``` - -### `components.AnthropicCitationPageLocationParam` - -```python lines -value: components.AnthropicCitationPageLocationParam = /* values here */ -``` - -### `components.AnthropicCitationSearchResultLocation` - -```python lines -value: components.AnthropicCitationSearchResultLocation = /* values here */ -``` - -### `components.AnthropicCitationWebSearchResultLocation` - -```python lines -value: components.AnthropicCitationWebSearchResultLocation = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/cleartoolinputs.mdx b/client-sdks/python/api-reference/components/cleartoolinputs.mdx deleted file mode 100644 index 05e801c7..00000000 --- a/client-sdks/python/api-reference/components/cleartoolinputs.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ClearToolInputs - Python SDK -sidebarTitle: ClearToolInputs -description: ClearToolInputs method reference -seoTitle: ClearToolInputs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/cleartoolinputs -'og:site_name': OpenRouter Documentation -'og:title': ClearToolInputs | OpenRouter Python SDK -'og:description': >- - ClearToolInputs method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ClearToolInputs%20-%20Python%20SDK&description=ClearToolInputs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `bool` - -```python lines -value: bool = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/code.mdx b/client-sdks/python/api-reference/components/code.mdx deleted file mode 100644 index 6725218a..00000000 --- a/client-sdks/python/api-reference/components/code.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Code - Python SDK -sidebarTitle: Code -description: Code method reference -seoTitle: Code | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/code' -'og:site_name': OpenRouter Documentation -'og:title': Code | OpenRouter Python SDK -'og:description': >- - Code method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Code%20-%20Python%20SDK&description=Code%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `SERVER_ERROR` | server_error | -| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded | -| `INVALID_PROMPT` | invalid_prompt | -| `VECTOR_STORE_TIMEOUT` | vector_store_timeout | -| `INVALID_IMAGE` | invalid_image | -| `INVALID_IMAGE_FORMAT` | invalid_image_format | -| `INVALID_BASE64_IMAGE` | invalid_base64_image | -| `INVALID_IMAGE_URL` | invalid_image_url | -| `IMAGE_TOO_LARGE` | image_too_large | -| `IMAGE_TOO_SMALL` | image_too_small | -| `IMAGE_PARSE_ERROR` | image_parse_error | -| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation | -| `INVALID_IMAGE_MODE` | invalid_image_mode | -| `IMAGE_FILE_TOO_LARGE` | image_file_too_large | -| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type | -| `EMPTY_IMAGE_FILE` | empty_image_file | -| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image | -| `IMAGE_FILE_NOT_FOUND` | image_file_not_found | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/codeinterpreterservertool.mdx b/client-sdks/python/api-reference/components/codeinterpreterservertool.mdx deleted file mode 100644 index ef4334f9..00000000 --- a/client-sdks/python/api-reference/components/codeinterpreterservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CodeInterpreterServerTool - Python SDK -sidebarTitle: CodeInterpreterServerTool -description: CodeInterpreterServerTool method reference -seoTitle: CodeInterpreterServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/codeinterpreterservertool -'og:site_name': OpenRouter Documentation -'og:title': CodeInterpreterServerTool | OpenRouter Python SDK -'og:description': >- - CodeInterpreterServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodeInterpreterServerTool%20-%20Python%20SDK&description=CodeInterpreterServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Code interpreter tool configuration - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `container` | [components.Container](/client-sdks/python/api-reference/components/container) | :heavy_check_mark: | N/A | -| `type` | [components.TypeCodeInterpreter](/client-sdks/python/api-reference/components/typecodeinterpreter) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/codexlocalshelltool.mdx b/client-sdks/python/api-reference/components/codexlocalshelltool.mdx deleted file mode 100644 index 91afb5b4..00000000 --- a/client-sdks/python/api-reference/components/codexlocalshelltool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CodexLocalShellTool - Python SDK -sidebarTitle: CodexLocalShellTool -description: CodexLocalShellTool method reference -seoTitle: CodexLocalShellTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/codexlocalshelltool -'og:site_name': OpenRouter Documentation -'og:title': CodexLocalShellTool | OpenRouter Python SDK -'og:description': >- - CodexLocalShellTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodexLocalShellTool%20-%20Python%20SDK&description=CodexLocalShellTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Local shell tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | [components.CodexLocalShellToolType](/client-sdks/python/api-reference/components/codexlocalshelltooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/codexlocalshelltooltype.mdx b/client-sdks/python/api-reference/components/codexlocalshelltooltype.mdx deleted file mode 100644 index baf90de3..00000000 --- a/client-sdks/python/api-reference/components/codexlocalshelltooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CodexLocalShellToolType - Python SDK -sidebarTitle: CodexLocalShellToolType -description: CodexLocalShellToolType method reference -seoTitle: CodexLocalShellToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/codexlocalshelltooltype -'og:site_name': OpenRouter Documentation -'og:title': CodexLocalShellToolType | OpenRouter Python SDK -'og:description': >- - CodexLocalShellToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodexLocalShellToolType%20-%20Python%20SDK&description=CodexLocalShellToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `LOCAL_SHELL` | local_shell | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/command.mdx b/client-sdks/python/api-reference/components/command.mdx deleted file mode 100644 index e81a59f1..00000000 --- a/client-sdks/python/api-reference/components/command.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Command - Python SDK -sidebarTitle: Command -description: Command method reference -seoTitle: Command | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/command' -'og:site_name': OpenRouter Documentation -'og:title': Command | OpenRouter Python SDK -'og:description': >- - Command method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Command%20-%20Python%20SDK&description=Command%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `VIEW` | view | -| `CREATE` | create | -| `STR_REPLACE` | str_replace | -| `INSERT` | insert | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/compactionitem.mdx b/client-sdks/python/api-reference/components/compactionitem.mdx deleted file mode 100644 index 2794a0e4..00000000 --- a/client-sdks/python/api-reference/components/compactionitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CompactionItem - Python SDK -sidebarTitle: CompactionItem -description: CompactionItem method reference -seoTitle: CompactionItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/compactionitem' -'og:site_name': OpenRouter Documentation -'og:title': CompactionItem | OpenRouter Python SDK -'og:description': >- - CompactionItem method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItem%20-%20Python%20SDK&description=CompactionItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A context compaction marker with encrypted summary - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `encrypted_content` | *str* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.CompactionItemType](/client-sdks/python/api-reference/components/compactionitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/compactionitemtype.mdx b/client-sdks/python/api-reference/components/compactionitemtype.mdx deleted file mode 100644 index 94d773fd..00000000 --- a/client-sdks/python/api-reference/components/compactionitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CompactionItemType - Python SDK -sidebarTitle: CompactionItemType -description: CompactionItemType method reference -seoTitle: CompactionItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/compactionitemtype -'og:site_name': OpenRouter Documentation -'og:title': CompactionItemType | OpenRouter Python SDK -'og:description': >- - CompactionItemType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItemType%20-%20Python%20SDK&description=CompactionItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMPACTION` | compaction | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/completiontokensdetails.mdx b/client-sdks/python/api-reference/components/completiontokensdetails.mdx deleted file mode 100644 index fdbbd209..00000000 --- a/client-sdks/python/api-reference/components/completiontokensdetails.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CompletionTokensDetails - Python SDK -sidebarTitle: CompletionTokensDetails -description: CompletionTokensDetails method reference -seoTitle: CompletionTokensDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/completiontokensdetails -'og:site_name': OpenRouter Documentation -'og:title': CompletionTokensDetails | OpenRouter Python SDK -'og:description': >- - CompletionTokensDetails method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionTokensDetails%20-%20Python%20SDK&description=CompletionTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Detailed completion token usage - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `accepted_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Accepted prediction tokens | -| `audio_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for audio output | -| `reasoning_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Tokens used for reasoning | -| `rejected_prediction_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/compoundfilter.mdx b/client-sdks/python/api-reference/components/compoundfilter.mdx deleted file mode 100644 index 78432756..00000000 --- a/client-sdks/python/api-reference/components/compoundfilter.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CompoundFilter - Python SDK -sidebarTitle: CompoundFilter -description: CompoundFilter method reference -seoTitle: CompoundFilter | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/compoundfilter' -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilter | OpenRouter Python SDK -'og:description': >- - CompoundFilter method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilter%20-%20Python%20SDK&description=CompoundFilter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A compound filter that combines multiple comparison or compound filters - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `filters` | List[Dict[str, *Nullable[Any]*]] | :heavy_check_mark: | N/A | -| `type` | [components.CompoundFilterType](/client-sdks/python/api-reference/components/compoundfiltertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/compoundfiltertype.mdx b/client-sdks/python/api-reference/components/compoundfiltertype.mdx deleted file mode 100644 index ee76949e..00000000 --- a/client-sdks/python/api-reference/components/compoundfiltertype.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CompoundFilterType - Python SDK -sidebarTitle: CompoundFilterType -description: CompoundFilterType method reference -seoTitle: CompoundFilterType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/compoundfiltertype -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilterType | OpenRouter Python SDK -'og:description': >- - CompoundFilterType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilterType%20-%20Python%20SDK&description=CompoundFilterType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `AND` | and | -| `OR` | or | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/computeruseservertool.mdx b/client-sdks/python/api-reference/components/computeruseservertool.mdx deleted file mode 100644 index 308561eb..00000000 --- a/client-sdks/python/api-reference/components/computeruseservertool.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ComputerUseServerTool - Python SDK -sidebarTitle: ComputerUseServerTool -description: ComputerUseServerTool method reference -seoTitle: ComputerUseServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/computeruseservertool -'og:site_name': OpenRouter Documentation -'og:title': ComputerUseServerTool | OpenRouter Python SDK -'og:description': >- - ComputerUseServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ComputerUseServerTool%20-%20Python%20SDK&description=ComputerUseServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Computer use preview tool configuration - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `display_height` | *int* | :heavy_check_mark: | N/A | -| `display_width` | *int* | :heavy_check_mark: | N/A | -| `environment` | [components.Environment](/client-sdks/python/api-reference/components/environment) | :heavy_check_mark: | N/A | -| `type` | [components.ComputerUseServerToolType](/client-sdks/python/api-reference/components/computeruseservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/computeruseservertooltype.mdx b/client-sdks/python/api-reference/components/computeruseservertooltype.mdx deleted file mode 100644 index 9e48fd1e..00000000 --- a/client-sdks/python/api-reference/components/computeruseservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ComputerUseServerToolType - Python SDK -sidebarTitle: ComputerUseServerToolType -description: ComputerUseServerToolType method reference -seoTitle: ComputerUseServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/computeruseservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ComputerUseServerToolType | OpenRouter Python SDK -'og:description': >- - ComputerUseServerToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ComputerUseServerToolType%20-%20Python%20SDK&description=ComputerUseServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `COMPUTER_USE_PREVIEW` | computer_use_preview | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/conflictresponseerrordata.mdx b/client-sdks/python/api-reference/components/conflictresponseerrordata.mdx deleted file mode 100644 index dbc5a54c..00000000 --- a/client-sdks/python/api-reference/components/conflictresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ConflictResponseErrorData - Python SDK -sidebarTitle: ConflictResponseErrorData -description: ConflictResponseErrorData method reference -seoTitle: ConflictResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/conflictresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseErrorData | OpenRouter Python SDK -'og:description': >- - ConflictResponseErrorData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseErrorData%20-%20Python%20SDK&description=ConflictResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ConflictResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/connectorid.mdx b/client-sdks/python/api-reference/components/connectorid.mdx deleted file mode 100644 index 4b7e6f1a..00000000 --- a/client-sdks/python/api-reference/components/connectorid.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ConnectorID - Python SDK -sidebarTitle: ConnectorID -description: ConnectorID method reference -seoTitle: ConnectorID | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/connectorid' -'og:site_name': OpenRouter Documentation -'og:title': ConnectorID | OpenRouter Python SDK -'og:description': >- - ConnectorID method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConnectorID%20-%20Python%20SDK&description=ConnectorID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `CONNECTOR_DROPBOX` | connector_dropbox | -| `CONNECTOR_GMAIL` | connector_gmail | -| `CONNECTOR_GOOGLECALENDAR` | connector_googlecalendar | -| `CONNECTOR_GOOGLEDRIVE` | connector_googledrive | -| `CONNECTOR_MICROSOFTTEAMS` | connector_microsoftteams | -| `CONNECTOR_OUTLOOKCALENDAR` | connector_outlookcalendar | -| `CONNECTOR_OUTLOOKEMAIL` | connector_outlookemail | -| `CONNECTOR_SHAREPOINT` | connector_sharepoint | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/container.mdx b/client-sdks/python/api-reference/components/container.mdx deleted file mode 100644 index dcd41d77..00000000 --- a/client-sdks/python/api-reference/components/container.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Container - Python SDK -sidebarTitle: Container -description: Container method reference -seoTitle: Container | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/container' -'og:site_name': OpenRouter Documentation -'og:title': Container | OpenRouter Python SDK -'og:description': >- - Container method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Container%20-%20Python%20SDK&description=Container%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `components.ContainerAuto` - -```python lines -value: components.ContainerAuto = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/containerauto.mdx b/client-sdks/python/api-reference/components/containerauto.mdx deleted file mode 100644 index 1d7fdce8..00000000 --- a/client-sdks/python/api-reference/components/containerauto.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContainerAuto - Python SDK -sidebarTitle: ContainerAuto -description: ContainerAuto method reference -seoTitle: ContainerAuto | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/containerauto' -'og:site_name': OpenRouter Documentation -'og:title': ContainerAuto | OpenRouter Python SDK -'og:description': >- - ContainerAuto method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerAuto%20-%20Python%20SDK&description=ContainerAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `file_ids` | List[*str*] | :heavy_minus_sign: | N/A | -| `memory_limit` | [OptionalNullable[components.MemoryLimit]](../components/memorylimit.md) | :heavy_minus_sign: | N/A | -| `type` | [components.ContainerType](/client-sdks/python/api-reference/components/containertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/containertype.mdx b/client-sdks/python/api-reference/components/containertype.mdx deleted file mode 100644 index c501acd9..00000000 --- a/client-sdks/python/api-reference/components/containertype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ContainerType - Python SDK -sidebarTitle: ContainerType -description: ContainerType method reference -seoTitle: ContainerType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/containertype' -'og:site_name': OpenRouter Documentation -'og:title': ContainerType | OpenRouter Python SDK -'og:description': >- - ContainerType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerType%20-%20Python%20SDK&description=ContainerType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentcompaction.mdx b/client-sdks/python/api-reference/components/contentcompaction.mdx deleted file mode 100644 index 7d7c15bf..00000000 --- a/client-sdks/python/api-reference/components/contentcompaction.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContentCompaction - Python SDK -sidebarTitle: ContentCompaction -description: ContentCompaction method reference -seoTitle: ContentCompaction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentcompaction -'og:site_name': OpenRouter Documentation -'og:title': ContentCompaction | OpenRouter Python SDK -'og:description': >- - ContentCompaction method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentCompaction%20-%20Python%20SDK&description=ContentCompaction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `type` | [components.MessagesMessageParamTypeCompaction](/client-sdks/python/api-reference/components/messagesmessageparamtypecompaction) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilteraction.mdx b/client-sdks/python/api-reference/components/contentfilteraction.mdx deleted file mode 100644 index 977f1380..00000000 --- a/client-sdks/python/api-reference/components/contentfilteraction.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentFilterAction - Python SDK -sidebarTitle: ContentFilterAction -description: ContentFilterAction method reference -seoTitle: ContentFilterAction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilteraction -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterAction | OpenRouter Python SDK -'og:description': >- - ContentFilterAction method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterAction%20-%20Python%20SDK&description=ContentFilterAction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Action taken when the pattern matches - -## Values - -| Name | Value | -| -------- | -------- | -| `REDACT` | redact | -| `BLOCK` | block | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilterbuiltinaction.mdx b/client-sdks/python/api-reference/components/contentfilterbuiltinaction.mdx deleted file mode 100644 index 4bfdac54..00000000 --- a/client-sdks/python/api-reference/components/contentfilterbuiltinaction.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterBuiltinAction - Python SDK -sidebarTitle: ContentFilterBuiltinAction -description: ContentFilterBuiltinAction method reference -seoTitle: ContentFilterBuiltinAction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilterbuiltinaction -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinAction | OpenRouter Python SDK -'og:description': >- - ContentFilterBuiltinAction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinAction%20-%20Python%20SDK&description=ContentFilterBuiltinAction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Action taken when the builtin filter triggers - -## Values - -| Name | Value | -| -------- | -------- | -| `REDACT` | redact | -| `BLOCK` | block | -| `FLAG` | flag | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilterbuiltinentry.mdx b/client-sdks/python/api-reference/components/contentfilterbuiltinentry.mdx deleted file mode 100644 index 9a8be350..00000000 --- a/client-sdks/python/api-reference/components/contentfilterbuiltinentry.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterBuiltinEntry - Python SDK -sidebarTitle: ContentFilterBuiltinEntry -description: ContentFilterBuiltinEntry method reference -seoTitle: ContentFilterBuiltinEntry | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilterbuiltinentry -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntry | OpenRouter Python SDK -'og:description': >- - ContentFilterBuiltinEntry method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntry%20-%20Python%20SDK&description=ContentFilterBuiltinEntry%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry. Builtin filters include PII detectors and the regex-based prompt injection detector. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [components.ContentFilterBuiltinAction](/client-sdks/python/api-reference/components/contentfilterbuiltinaction) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| `label` | *Optional[str]* | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `slug` | [components.ContentFilterBuiltinSlug](/client-sdks/python/api-reference/components/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput.mdx b/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput.mdx deleted file mode 100644 index eee0f968..00000000 --- a/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterBuiltinEntryInput - Python SDK -sidebarTitle: ContentFilterBuiltinEntryInput -description: ContentFilterBuiltinEntryInput method reference -seoTitle: ContentFilterBuiltinEntryInput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilterbuiltinentryinput -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntryInput | OpenRouter Python SDK -'og:description': >- - ContentFilterBuiltinEntryInput method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntryInput%20-%20Python%20SDK&description=ContentFilterBuiltinEntryInput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry for create/update requests. Labels are system-assigned and cannot be set by the caller. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [components.ContentFilterBuiltinAction](/client-sdks/python/api-reference/components/contentfilterbuiltinaction) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| ~~`label`~~ | *Optional[str]* | :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. | | -| `slug` | [components.ContentFilterBuiltinSlug](/client-sdks/python/api-reference/components/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilterbuiltinslug.mdx b/client-sdks/python/api-reference/components/contentfilterbuiltinslug.mdx deleted file mode 100644 index ea888582..00000000 --- a/client-sdks/python/api-reference/components/contentfilterbuiltinslug.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ContentFilterBuiltinSlug - Python SDK -sidebarTitle: ContentFilterBuiltinSlug -description: ContentFilterBuiltinSlug method reference -seoTitle: ContentFilterBuiltinSlug | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilterbuiltinslug -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinSlug | OpenRouter Python SDK -'og:description': >- - ContentFilterBuiltinSlug method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinSlug%20-%20Python%20SDK&description=ContentFilterBuiltinSlug%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The builtin filter identifier - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `EMAIL` | email | -| `PHONE` | phone | -| `SSN` | ssn | -| `CREDIT_CARD` | credit-card | -| `IP_ADDRESS` | ip-address | -| `PERSON_NAME` | person-name | -| `ADDRESS` | address | -| `REGEX_PROMPT_INJECTION` | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentfilterentry.mdx b/client-sdks/python/api-reference/components/contentfilterentry.mdx deleted file mode 100644 index e478195f..00000000 --- a/client-sdks/python/api-reference/components/contentfilterentry.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentFilterEntry - Python SDK -sidebarTitle: ContentFilterEntry -description: ContentFilterEntry method reference -seoTitle: ContentFilterEntry | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentfilterentry -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterEntry | OpenRouter Python SDK -'og:description': >- - ContentFilterEntry method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterEntry%20-%20Python%20SDK&description=ContentFilterEntry%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A custom regex content filter that scans request messages for matching patterns. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `action` | [components.ContentFilterAction](/client-sdks/python/api-reference/components/contentfilteraction) | :heavy_check_mark: | Action taken when the pattern matches | block | -| `label` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `pattern` | *str* | :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/client-sdks/python/api-reference/components/contentpartaddedevent.mdx b/client-sdks/python/api-reference/components/contentpartaddedevent.mdx deleted file mode 100644 index 423af5f7..00000000 --- a/client-sdks/python/api-reference/components/contentpartaddedevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ContentPartAddedEvent - Python SDK -sidebarTitle: ContentPartAddedEvent -description: ContentPartAddedEvent method reference -seoTitle: ContentPartAddedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEvent | OpenRouter Python SDK -'og:description': >- - ContentPartAddedEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEvent%20-%20Python%20SDK&description=ContentPartAddedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a new content part is added to an output item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `part` | [components.ContentPartAddedEventPart](/client-sdks/python/api-reference/components/contentpartaddedeventpart) | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartAddedEventType](/client-sdks/python/api-reference/components/contentpartaddedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartaddedeventpart.mdx b/client-sdks/python/api-reference/components/contentpartaddedeventpart.mdx deleted file mode 100644 index 70abf95c..00000000 --- a/client-sdks/python/api-reference/components/contentpartaddedeventpart.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartAddedEventPart - Python SDK -sidebarTitle: ContentPartAddedEventPart -description: ContentPartAddedEventPart method reference -seoTitle: ContentPartAddedEventPart | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartaddedeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEventPart | OpenRouter Python SDK -'og:description': >- - ContentPartAddedEventPart method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEventPart%20-%20Python%20SDK&description=ContentPartAddedEventPart%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.ReasoningTextContent` - -```python lines -value: components.ReasoningTextContent = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartaddedeventtype.mdx b/client-sdks/python/api-reference/components/contentpartaddedeventtype.mdx deleted file mode 100644 index 73c7a2e9..00000000 --- a/client-sdks/python/api-reference/components/contentpartaddedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartAddedEventType - Python SDK -sidebarTitle: ContentPartAddedEventType -description: ContentPartAddedEventType method reference -seoTitle: ContentPartAddedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEventType | OpenRouter Python SDK -'og:description': >- - ContentPartAddedEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEventType%20-%20Python%20SDK&description=ContentPartAddedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `RESPONSE_CONTENT_PART_ADDED` | response.content_part.added | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartdoneevent.mdx b/client-sdks/python/api-reference/components/contentpartdoneevent.mdx deleted file mode 100644 index dc0fb12a..00000000 --- a/client-sdks/python/api-reference/components/contentpartdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ContentPartDoneEvent - Python SDK -sidebarTitle: ContentPartDoneEvent -description: ContentPartDoneEvent method reference -seoTitle: ContentPartDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEvent | OpenRouter Python SDK -'og:description': >- - ContentPartDoneEvent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEvent%20-%20Python%20SDK&description=ContentPartDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a content part is complete - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `part` | [components.ContentPartDoneEventPart](/client-sdks/python/api-reference/components/contentpartdoneeventpart) | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartDoneEventType](/client-sdks/python/api-reference/components/contentpartdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartdoneeventpart.mdx b/client-sdks/python/api-reference/components/contentpartdoneeventpart.mdx deleted file mode 100644 index 29330210..00000000 --- a/client-sdks/python/api-reference/components/contentpartdoneeventpart.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartDoneEventPart - Python SDK -sidebarTitle: ContentPartDoneEventPart -description: ContentPartDoneEventPart method reference -seoTitle: ContentPartDoneEventPart | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartdoneeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEventPart | OpenRouter Python SDK -'og:description': >- - ContentPartDoneEventPart method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEventPart%20-%20Python%20SDK&description=ContentPartDoneEventPart%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.ReasoningTextContent` - -```python lines -value: components.ReasoningTextContent = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartdoneeventtype.mdx b/client-sdks/python/api-reference/components/contentpartdoneeventtype.mdx deleted file mode 100644 index f571110a..00000000 --- a/client-sdks/python/api-reference/components/contentpartdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartDoneEventType - Python SDK -sidebarTitle: ContentPartDoneEventType -description: ContentPartDoneEventType method reference -seoTitle: ContentPartDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEventType | OpenRouter Python SDK -'og:description': >- - ContentPartDoneEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEventType%20-%20Python%20SDK&description=ContentPartDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_CONTENT_PART_DONE` | response.content_part.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartimage.mdx b/client-sdks/python/api-reference/components/contentpartimage.mdx deleted file mode 100644 index 0a5ae250..00000000 --- a/client-sdks/python/api-reference/components/contentpartimage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentPartImage - Python SDK -sidebarTitle: ContentPartImage -description: ContentPartImage method reference -seoTitle: ContentPartImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartimage -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImage | OpenRouter Python SDK -'og:description': >- - ContentPartImage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImage%20-%20Python%20SDK&description=ContentPartImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `image_url` | [components.ContentPartImageImageURL](/client-sdks/python/api-reference/components/contentpartimageimageurl) | :heavy_check_mark: | N/A | -| `type` | [components.ContentPartImageType](/client-sdks/python/api-reference/components/contentpartimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartimageimageurl.mdx b/client-sdks/python/api-reference/components/contentpartimageimageurl.mdx deleted file mode 100644 index 70b49066..00000000 --- a/client-sdks/python/api-reference/components/contentpartimageimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartImageImageURL - Python SDK -sidebarTitle: ContentPartImageImageURL -description: ContentPartImageImageURL method reference -seoTitle: ContentPartImageImageURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageImageURL | OpenRouter Python SDK -'og:description': >- - ContentPartImageImageURL method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageImageURL%20-%20Python%20SDK&description=ContentPartImageImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartimagetype.mdx b/client-sdks/python/api-reference/components/contentpartimagetype.mdx deleted file mode 100644 index 9acd2fb6..00000000 --- a/client-sdks/python/api-reference/components/contentpartimagetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartImageType - Python SDK -sidebarTitle: ContentPartImageType -description: ContentPartImageType method reference -seoTitle: ContentPartImageType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartimagetype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageType | OpenRouter Python SDK -'og:description': >- - ContentPartImageType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageType%20-%20Python%20SDK&description=ContentPartImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `IMAGE_URL` | image_url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputaudio.mdx b/client-sdks/python/api-reference/components/contentpartinputaudio.mdx deleted file mode 100644 index 1ea96049..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputaudio.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentPartInputAudio - Python SDK -sidebarTitle: ContentPartInputAudio -description: ContentPartInputAudio method reference -seoTitle: ContentPartInputAudio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputAudio | OpenRouter Python SDK -'og:description': >- - ContentPartInputAudio method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputAudio%20-%20Python%20SDK&description=ContentPartInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_audio` | [components.MultimodalMedia](/client-sdks/python/api-reference/components/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | [components.ContentPartInputAudioType](/client-sdks/python/api-reference/components/contentpartinputaudiotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputaudiotype.mdx b/client-sdks/python/api-reference/components/contentpartinputaudiotype.mdx deleted file mode 100644 index a5c42bde..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputaudiotype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputAudioType - Python SDK -sidebarTitle: ContentPartInputAudioType -description: ContentPartInputAudioType method reference -seoTitle: ContentPartInputAudioType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputaudiotype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputAudioType | OpenRouter Python SDK -'og:description': >- - ContentPartInputAudioType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputAudioType%20-%20Python%20SDK&description=ContentPartInputAudioType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_AUDIO` | input_audio | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputfile.mdx b/client-sdks/python/api-reference/components/contentpartinputfile.mdx deleted file mode 100644 index 4be49dca..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputfile.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentPartInputFile - Python SDK -sidebarTitle: ContentPartInputFile -description: ContentPartInputFile method reference -seoTitle: ContentPartInputFile | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputfile -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputFile | OpenRouter Python SDK -'og:description': >- - ContentPartInputFile method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputFile%20-%20Python%20SDK&description=ContentPartInputFile%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_file` | [components.MultimodalMedia](/client-sdks/python/api-reference/components/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | [components.ContentPartInputFileType](/client-sdks/python/api-reference/components/contentpartinputfiletype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputfiletype.mdx b/client-sdks/python/api-reference/components/contentpartinputfiletype.mdx deleted file mode 100644 index af23777c..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputfiletype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputFileType - Python SDK -sidebarTitle: ContentPartInputFileType -description: ContentPartInputFileType method reference -seoTitle: ContentPartInputFileType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputfiletype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputFileType | OpenRouter Python SDK -'og:description': >- - ContentPartInputFileType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputFileType%20-%20Python%20SDK&description=ContentPartInputFileType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INPUT_FILE` | input_file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputvideo.mdx b/client-sdks/python/api-reference/components/contentpartinputvideo.mdx deleted file mode 100644 index eaeaf794..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputvideo.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentPartInputVideo - Python SDK -sidebarTitle: ContentPartInputVideo -description: ContentPartInputVideo method reference -seoTitle: ContentPartInputVideo | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputvideo -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputVideo | OpenRouter Python SDK -'og:description': >- - ContentPartInputVideo method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputVideo%20-%20Python%20SDK&description=ContentPartInputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `input_video` | [components.MultimodalMedia](/client-sdks/python/api-reference/components/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | [components.ContentPartInputVideoType](/client-sdks/python/api-reference/components/contentpartinputvideotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentpartinputvideotype.mdx b/client-sdks/python/api-reference/components/contentpartinputvideotype.mdx deleted file mode 100644 index c960b51b..00000000 --- a/client-sdks/python/api-reference/components/contentpartinputvideotype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentPartInputVideoType - Python SDK -sidebarTitle: ContentPartInputVideoType -description: ContentPartInputVideoType method reference -seoTitle: ContentPartInputVideoType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentpartinputvideotype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputVideoType | OpenRouter Python SDK -'og:description': >- - ContentPartInputVideoType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputVideoType%20-%20Python%20SDK&description=ContentPartInputVideoType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_VIDEO` | input_video | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentredactedthinking.mdx b/client-sdks/python/api-reference/components/contentredactedthinking.mdx deleted file mode 100644 index abe2abdb..00000000 --- a/client-sdks/python/api-reference/components/contentredactedthinking.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentRedactedThinking - Python SDK -sidebarTitle: ContentRedactedThinking -description: ContentRedactedThinking method reference -seoTitle: ContentRedactedThinking | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentredactedthinking -'og:site_name': OpenRouter Documentation -'og:title': ContentRedactedThinking | OpenRouter Python SDK -'og:description': >- - ContentRedactedThinking method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentRedactedThinking%20-%20Python%20SDK&description=ContentRedactedThinking%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeRedactedThinking](/client-sdks/python/api-reference/components/typeredactedthinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentservertooluse.mdx b/client-sdks/python/api-reference/components/contentservertooluse.mdx deleted file mode 100644 index e34d5d57..00000000 --- a/client-sdks/python/api-reference/components/contentservertooluse.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentServerToolUse - Python SDK -sidebarTitle: ContentServerToolUse -description: ContentServerToolUse method reference -seoTitle: ContentServerToolUse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentservertooluse -'og:site_name': OpenRouter Documentation -'og:title': ContentServerToolUse | OpenRouter Python SDK -'og:description': >- - ContentServerToolUse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentServerToolUse%20-%20Python%20SDK&description=ContentServerToolUse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `input` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeServerToolUse](/client-sdks/python/api-reference/components/typeservertooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentthinking.mdx b/client-sdks/python/api-reference/components/contentthinking.mdx deleted file mode 100644 index 169f2fd6..00000000 --- a/client-sdks/python/api-reference/components/contentthinking.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContentThinking - Python SDK -sidebarTitle: ContentThinking -description: ContentThinking method reference -seoTitle: ContentThinking | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentthinking -'og:site_name': OpenRouter Documentation -'og:title': ContentThinking | OpenRouter Python SDK -'og:description': >- - ContentThinking method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentThinking%20-%20Python%20SDK&description=ContentThinking%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `signature` | *str* | :heavy_check_mark: | N/A | -| `thinking` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeThinking](/client-sdks/python/api-reference/components/typethinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contenttoolreference.mdx b/client-sdks/python/api-reference/components/contenttoolreference.mdx deleted file mode 100644 index 6b37a7b3..00000000 --- a/client-sdks/python/api-reference/components/contenttoolreference.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentToolReference - Python SDK -sidebarTitle: ContentToolReference -description: ContentToolReference method reference -seoTitle: ContentToolReference | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contenttoolreference -'og:site_name': OpenRouter Documentation -'og:title': ContentToolReference | OpenRouter Python SDK -'og:description': >- - ContentToolReference method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolReference%20-%20Python%20SDK&description=ContentToolReference%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `tool_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeToolReference](/client-sdks/python/api-reference/components/typetoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contenttoolresult.mdx b/client-sdks/python/api-reference/components/contenttoolresult.mdx deleted file mode 100644 index df950945..00000000 --- a/client-sdks/python/api-reference/components/contenttoolresult.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ContentToolResult - Python SDK -sidebarTitle: ContentToolResult -description: ContentToolResult method reference -seoTitle: ContentToolResult | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contenttoolresult -'og:site_name': OpenRouter Documentation -'og:title': ContentToolResult | OpenRouter Python SDK -'og:description': >- - ContentToolResult method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolResult%20-%20Python%20SDK&description=ContentToolResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | [Optional[components.MessagesMessageParamContentUnion2]](../components/messagesmessageparamcontentunion2.md) | :heavy_minus_sign: | N/A | | -| `is_error` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeToolResult](/client-sdks/python/api-reference/components/typetoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contenttooluse.mdx b/client-sdks/python/api-reference/components/contenttooluse.mdx deleted file mode 100644 index a1e97d7c..00000000 --- a/client-sdks/python/api-reference/components/contenttooluse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentToolUse - Python SDK -sidebarTitle: ContentToolUse -description: ContentToolUse method reference -seoTitle: ContentToolUse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/contenttooluse' -'og:site_name': OpenRouter Documentation -'og:title': ContentToolUse | OpenRouter Python SDK -'og:description': >- - ContentToolUse method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolUse%20-%20Python%20SDK&description=ContentToolUse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `input` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeToolUse](/client-sdks/python/api-reference/components/typetooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentwebsearchtoolresult.mdx b/client-sdks/python/api-reference/components/contentwebsearchtoolresult.mdx deleted file mode 100644 index 7e598930..00000000 --- a/client-sdks/python/api-reference/components/contentwebsearchtoolresult.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ContentWebSearchToolResult - Python SDK -sidebarTitle: ContentWebSearchToolResult -description: ContentWebSearchToolResult method reference -seoTitle: ContentWebSearchToolResult | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentwebsearchtoolresult -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResult | OpenRouter Python SDK -'og:description': >- - ContentWebSearchToolResult method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResult%20-%20Python%20SDK&description=ContentWebSearchToolResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | [components.MessagesMessageParamContentUnion3](/client-sdks/python/api-reference/components/messagesmessageparamcontentunion3) | :heavy_check_mark: | N/A | | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.TypeWebSearchToolResult](/client-sdks/python/api-reference/components/typewebsearchtoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contentwebsearchtoolresulterror.mdx b/client-sdks/python/api-reference/components/contentwebsearchtoolresulterror.mdx deleted file mode 100644 index 3aa7b826..00000000 --- a/client-sdks/python/api-reference/components/contentwebsearchtoolresulterror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentWebSearchToolResultError - Python SDK -sidebarTitle: ContentWebSearchToolResultError -description: ContentWebSearchToolResultError method reference -seoTitle: ContentWebSearchToolResultError | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contentwebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResultError | OpenRouter Python SDK -'og:description': >- - ContentWebSearchToolResultError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResultError%20-%20Python%20SDK&description=ContentWebSearchToolResultError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `error_code` | [components.ErrorCode](/client-sdks/python/api-reference/components/errorcode) | :heavy_check_mark: | N/A | -| `type` | [components.TypeWebSearchToolResultError](/client-sdks/python/api-reference/components/typewebsearchtoolresulterror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contextcompressionengine.mdx b/client-sdks/python/api-reference/components/contextcompressionengine.mdx deleted file mode 100644 index bc4bf31f..00000000 --- a/client-sdks/python/api-reference/components/contextcompressionengine.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContextCompressionEngine - Python SDK -sidebarTitle: ContextCompressionEngine -description: ContextCompressionEngine method reference -seoTitle: ContextCompressionEngine | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contextcompressionengine -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionEngine | OpenRouter Python SDK -'og:description': >- - ContextCompressionEngine method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionEngine%20-%20Python%20SDK&description=ContextCompressionEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The compression engine to use. Defaults to "middle-out". - -## Values - -| Name | Value | -| ------------ | ------------ | -| `MIDDLE_OUT` | middle-out | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contextcompressionplugin.mdx b/client-sdks/python/api-reference/components/contextcompressionplugin.mdx deleted file mode 100644 index a3675749..00000000 --- a/client-sdks/python/api-reference/components/contextcompressionplugin.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContextCompressionPlugin - Python SDK -sidebarTitle: ContextCompressionPlugin -description: ContextCompressionPlugin method reference -seoTitle: ContextCompressionPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contextcompressionplugin -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionPlugin | OpenRouter Python SDK -'og:description': >- - ContextCompressionPlugin method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionPlugin%20-%20Python%20SDK&description=ContextCompressionPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.ContextCompressionEngine]](../components/contextcompressionengine.md) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `id` | [components.ContextCompressionPluginID](/client-sdks/python/api-reference/components/contextcompressionpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contextcompressionpluginid.mdx b/client-sdks/python/api-reference/components/contextcompressionpluginid.mdx deleted file mode 100644 index 172a87da..00000000 --- a/client-sdks/python/api-reference/components/contextcompressionpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContextCompressionPluginID - Python SDK -sidebarTitle: ContextCompressionPluginID -description: ContextCompressionPluginID method reference -seoTitle: ContextCompressionPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contextcompressionpluginid -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionPluginID | OpenRouter Python SDK -'og:description': >- - ContextCompressionPluginID method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionPluginID%20-%20Python%20SDK&description=ContextCompressionPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `CONTEXT_COMPRESSION` | context-compression | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contextmanagement.mdx b/client-sdks/python/api-reference/components/contextmanagement.mdx deleted file mode 100644 index b5d50464..00000000 --- a/client-sdks/python/api-reference/components/contextmanagement.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContextManagement - Python SDK -sidebarTitle: ContextManagement -description: ContextManagement method reference -seoTitle: ContextManagement | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/contextmanagement -'og:site_name': OpenRouter Documentation -'og:title': ContextManagement | OpenRouter Python SDK -'og:description': >- - ContextManagement method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextManagement%20-%20Python%20SDK&description=ContextManagement%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `edits` | List[[components.Edit](/client-sdks/python/api-reference/components/edit)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/contradiction.mdx b/client-sdks/python/api-reference/components/contradiction.mdx deleted file mode 100644 index a74a3c70..00000000 --- a/client-sdks/python/api-reference/components/contradiction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Contradiction - Python SDK -sidebarTitle: Contradiction -description: Contradiction method reference -seoTitle: Contradiction | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/contradiction' -'og:site_name': OpenRouter Documentation -'og:title': Contradiction | OpenRouter Python SDK -'og:description': >- - Contradiction method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Contradiction%20-%20Python%20SDK&description=Contradiction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `stances` | List[[components.Stance](/client-sdks/python/api-reference/components/stance)] | :heavy_check_mark: | N/A | -| `topic` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/costdetails.mdx b/client-sdks/python/api-reference/components/costdetails.mdx deleted file mode 100644 index 3854bd08..00000000 --- a/client-sdks/python/api-reference/components/costdetails.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CostDetails - Python SDK -sidebarTitle: CostDetails -description: CostDetails method reference -seoTitle: CostDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/costdetails' -'og:site_name': OpenRouter Documentation -'og:title': CostDetails | OpenRouter Python SDK -'og:description': >- - CostDetails method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CostDetails%20-%20Python%20SDK&description=CostDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Breakdown of upstream inference costs - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `upstream_inference_completions_cost` | *float* | :heavy_check_mark: | N/A | -| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `upstream_inference_prompt_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/createbyokkeyrequest.mdx b/client-sdks/python/api-reference/components/createbyokkeyrequest.mdx deleted file mode 100644 index 7c1a7305..00000000 --- a/client-sdks/python/api-reference/components/createbyokkeyrequest.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: CreateBYOKKeyRequest - Python SDK -sidebarTitle: CreateBYOKKeyRequest -description: CreateBYOKKeyRequest method reference -seoTitle: CreateBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - CreateBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyRequest%20-%20Python%20SDK&description=CreateBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `is_fallback` | *Optional[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` | *str* | :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[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [components.BYOKProviderSlug](/client-sdks/python/api-reference/components/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `workspace_id` | *Optional[str]* | :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/client-sdks/python/api-reference/components/createbyokkeyresponse.mdx b/client-sdks/python/api-reference/components/createbyokkeyresponse.mdx deleted file mode 100644 index 0a11bbbe..00000000 --- a/client-sdks/python/api-reference/components/createbyokkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateBYOKKeyResponse - Python SDK -sidebarTitle: CreateBYOKKeyResponse -description: CreateBYOKKeyResponse method reference -seoTitle: CreateBYOKKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createbyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyResponse | OpenRouter Python SDK -'og:description': >- - CreateBYOKKeyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyResponse%20-%20Python%20SDK&description=CreateBYOKKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.BYOKKey](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/createguardrailrequest.mdx b/client-sdks/python/api-reference/components/createguardrailrequest.mdx deleted file mode 100644 index 3f69713c..00000000 --- a/client-sdks/python/api-reference/components/createguardrailrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateGuardrailRequest - Python SDK -sidebarTitle: CreateGuardrailRequest -description: CreateGuardrailRequest method reference -seoTitle: CreateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - CreateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20Python%20SDK&description=CreateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `content_filters` | List[[components.ContentFilterEntry](/client-sdks/python/api-reference/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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| ~~`enforce_zdr`~~ | *OptionalNullable[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 50 | -| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | :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/client-sdks/python/api-reference/components/createguardrailresponse.mdx b/client-sdks/python/api-reference/components/createguardrailresponse.mdx deleted file mode 100644 index 6172da1e..00000000 --- a/client-sdks/python/api-reference/components/createguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateGuardrailResponse - Python SDK -sidebarTitle: CreateGuardrailResponse -description: CreateGuardrailResponse method reference -seoTitle: CreateGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResponse | OpenRouter Python SDK -'og:description': >- - CreateGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResponse%20-%20Python%20SDK&description=CreateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](/client-sdks/python/api-reference/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/python/api-reference/components/createobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/components/createobservabilitydestinationrequest.mdx deleted file mode 100644 index 5fe3ed6f..00000000 --- a/client-sdks/python/api-reference/components/createobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateObservabilityDestinationRequest - Python SDK -sidebarTitle: CreateObservabilityDestinationRequest -description: CreateObservabilityDestinationRequest method reference -seoTitle: CreateObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - CreateObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequest%20-%20Python%20SDK&description=CreateObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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. | `` | -| `config` | Dict[str, *Nullable[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` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | `` | -| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.CreateObservabilityDestinationRequestType](/client-sdks/python/api-reference/components/createobservabilitydestinationrequesttype) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `workspace_id` | *Optional[str]* | :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/client-sdks/python/api-reference/components/createobservabilitydestinationrequesttype.mdx b/client-sdks/python/api-reference/components/createobservabilitydestinationrequesttype.mdx deleted file mode 100644 index d83715f3..00000000 --- a/client-sdks/python/api-reference/components/createobservabilitydestinationrequesttype.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: CreateObservabilityDestinationRequestType - Python SDK -sidebarTitle: CreateObservabilityDestinationRequestType -description: CreateObservabilityDestinationRequestType method reference -seoTitle: CreateObservabilityDestinationRequestType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createobservabilitydestinationrequesttype -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequestType | OpenRouter Python SDK -'og:description': >- - CreateObservabilityDestinationRequestType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequestType%20-%20Python%20SDK&description=CreateObservabilityDestinationRequestType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The destination type. Only stable destination types are accepted. - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `ARIZE` | arize | -| `BRAINTRUST` | braintrust | -| `CLICKHOUSE` | clickhouse | -| `DATADOG` | datadog | -| `GRAFANA` | grafana | -| `LANGFUSE` | langfuse | -| `LANGSMITH` | langsmith | -| `NEWRELIC` | newrelic | -| `OPIK` | opik | -| `OTEL_COLLECTOR` | otel-collector | -| `POSTHOG` | posthog | -| `RAMP` | ramp | -| `S3` | s3 | -| `SENTRY` | sentry | -| `SNOWFLAKE` | snowflake | -| `WEAVE` | weave | -| `WEBHOOK` | webhook | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/createobservabilitydestinationresponse.mdx b/client-sdks/python/api-reference/components/createobservabilitydestinationresponse.mdx deleted file mode 100644 index be7fa32e..00000000 --- a/client-sdks/python/api-reference/components/createobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateObservabilityDestinationResponse - Python SDK -sidebarTitle: CreateObservabilityDestinationResponse -description: CreateObservabilityDestinationResponse method reference -seoTitle: CreateObservabilityDestinationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationResponse | OpenRouter Python SDK -'og:description': >- - CreateObservabilityDestinationResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationResponse%20-%20Python%20SDK&description=CreateObservabilityDestinationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/createpresetfrominferenceresponse.mdx b/client-sdks/python/api-reference/components/createpresetfrominferenceresponse.mdx deleted file mode 100644 index 1d5efe9d..00000000 --- a/client-sdks/python/api-reference/components/createpresetfrominferenceresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreatePresetFromInferenceResponse - Python SDK -sidebarTitle: CreatePresetFromInferenceResponse -description: CreatePresetFromInferenceResponse method reference -seoTitle: CreatePresetFromInferenceResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createpresetfrominferenceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetFromInferenceResponse | OpenRouter Python SDK -'og:description': >- - CreatePresetFromInferenceResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetFromInferenceResponse%20-%20Python%20SDK&description=CreatePresetFromInferenceResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Response containing the created preset with its designated version. - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.PresetWithDesignatedVersion](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/createworkspacerequest.mdx b/client-sdks/python/api-reference/components/createworkspacerequest.mdx deleted file mode 100644 index d3d9bdbe..00000000 --- a/client-sdks/python/api-reference/components/createworkspacerequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateWorkspaceRequest - Python SDK -sidebarTitle: CreateWorkspaceRequest -description: CreateWorkspaceRequest method reference -seoTitle: CreateWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - CreateWorkspaceRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceRequest%20-%20Python%20SDK&description=CreateWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/createworkspaceresponse.mdx b/client-sdks/python/api-reference/components/createworkspaceresponse.mdx deleted file mode 100644 index b792defa..00000000 --- a/client-sdks/python/api-reference/components/createworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateWorkspaceResponse - Python SDK -sidebarTitle: CreateWorkspaceResponse -description: CreateWorkspaceResponse method reference -seoTitle: CreateWorkspaceResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/createworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceResponse | OpenRouter Python SDK -'og:description': >- - CreateWorkspaceResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceResponse%20-%20Python%20SDK&description=CreateWorkspaceResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](/client-sdks/python/api-reference/components/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/python/api-reference/components/customtool.mdx b/client-sdks/python/api-reference/components/customtool.mdx deleted file mode 100644 index 28056a1c..00000000 --- a/client-sdks/python/api-reference/components/customtool.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CustomTool - Python SDK -sidebarTitle: CustomTool -description: CustomTool method reference -seoTitle: CustomTool | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/customtool' -'og:site_name': OpenRouter Documentation -'og:title': CustomTool | OpenRouter Python SDK -'og:description': >- - CustomTool method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomTool%20-%20Python%20SDK&description=CustomTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Custom tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `format_` | [Optional[components.Format]](/client-sdks/python/api-reference/components/format-) | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolTypeCustom](/client-sdks/python/api-reference/components/customtooltypecustom) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallinputdeltaevent.mdx b/client-sdks/python/api-reference/components/customtoolcallinputdeltaevent.mdx deleted file mode 100644 index 9f01fa8e..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallinputdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomToolCallInputDeltaEvent - Python SDK -sidebarTitle: CustomToolCallInputDeltaEvent -description: CustomToolCallInputDeltaEvent method reference -seoTitle: CustomToolCallInputDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallinputdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDeltaEvent | OpenRouter Python SDK -'og:description': >- - CustomToolCallInputDeltaEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDeltaEvent%20-%20Python%20SDK&description=CustomToolCallInputDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input is being streamed. Mirrors `response.function_call_arguments.delta` but for `custom` tools whose input is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallInputDeltaEventType](/client-sdks/python/api-reference/components/customtoolcallinputdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallinputdeltaeventtype.mdx b/client-sdks/python/api-reference/components/customtoolcallinputdeltaeventtype.mdx deleted file mode 100644 index b06b9f8c..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallinputdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolCallInputDeltaEventType - Python SDK -sidebarTitle: CustomToolCallInputDeltaEventType -description: CustomToolCallInputDeltaEventType method reference -seoTitle: CustomToolCallInputDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallinputdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDeltaEventType | OpenRouter Python SDK -'og:description': >- - CustomToolCallInputDeltaEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDeltaEventType%20-%20Python%20SDK&description=CustomToolCallInputDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_CUSTOM_TOOL_CALL_INPUT_DELTA` | response.custom_tool_call_input.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallinputdoneevent.mdx b/client-sdks/python/api-reference/components/customtoolcallinputdoneevent.mdx deleted file mode 100644 index 7ff32833..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallinputdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CustomToolCallInputDoneEvent - Python SDK -sidebarTitle: CustomToolCallInputDoneEvent -description: CustomToolCallInputDoneEvent method reference -seoTitle: CustomToolCallInputDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallinputdoneevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDoneEvent | OpenRouter Python SDK -'og:description': >- - CustomToolCallInputDoneEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDoneEvent%20-%20Python%20SDK&description=CustomToolCallInputDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input streaming is complete. Mirrors `response.function_call_arguments.done` but for `custom` tools. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `input` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallInputDoneEventType](/client-sdks/python/api-reference/components/customtoolcallinputdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallinputdoneeventtype.mdx b/client-sdks/python/api-reference/components/customtoolcallinputdoneeventtype.mdx deleted file mode 100644 index dc79c19c..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallinputdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolCallInputDoneEventType - Python SDK -sidebarTitle: CustomToolCallInputDoneEventType -description: CustomToolCallInputDoneEventType method reference -seoTitle: CustomToolCallInputDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallinputdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDoneEventType | OpenRouter Python SDK -'og:description': >- - CustomToolCallInputDoneEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDoneEventType%20-%20Python%20SDK&description=CustomToolCallInputDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_CUSTOM_TOOL_CALL_INPUT_DONE` | response.custom_tool_call_input.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallitem.mdx b/client-sdks/python/api-reference/components/customtoolcallitem.mdx deleted file mode 100644 index c0559785..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: CustomToolCallItem - Python SDK -sidebarTitle: CustomToolCallItem -description: CustomToolCallItem method reference -seoTitle: CustomToolCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallitem -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItem | OpenRouter Python SDK -'og:description': >- - CustomToolCallItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItem%20-%20Python%20SDK&description=CustomToolCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `input` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [components.CustomToolCallItemType](/client-sdks/python/api-reference/components/customtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcallitemtype.mdx b/client-sdks/python/api-reference/components/customtoolcallitemtype.mdx deleted file mode 100644 index 5031f19f..00000000 --- a/client-sdks/python/api-reference/components/customtoolcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolCallItemType - Python SDK -sidebarTitle: CustomToolCallItemType -description: CustomToolCallItemType method reference -seoTitle: CustomToolCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItemType | OpenRouter Python SDK -'og:description': >- - CustomToolCallItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItemType%20-%20Python%20SDK&description=CustomToolCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `CUSTOM_TOOL_CALL` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitem.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitem.mdx deleted file mode 100644 index 8b36dcec..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CustomToolCallOutputItem - Python SDK -sidebarTitle: CustomToolCallOutputItem -description: CustomToolCallOutputItem method reference -seoTitle: CustomToolCallOutputItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItem | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItem%20-%20Python%20SDK&description=CustomToolCallOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The output from a custom (freeform-grammar) tool call execution. Mirrors `function_call_output` but is matched to a `custom_tool_call` rather than a `function_call`. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `output` | [components.CustomToolCallOutputItemOutputUnion2](/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion2) | :heavy_check_mark: | N/A | -| `type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](/client-sdks/python/api-reference/components/customtoolcalloutputitemtypecustomtoolcalloutput) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemdetail.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemdetail.mdx deleted file mode 100644 index 520e5f0e..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemdetail.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CustomToolCallOutputItemDetail - Python SDK -sidebarTitle: CustomToolCallOutputItemDetail -description: CustomToolCallOutputItemDetail method reference -seoTitle: CustomToolCallOutputItemDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemDetail | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemDetail method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemDetail%20-%20Python%20SDK&description=CustomToolCallOutputItemDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | -| `ORIGINAL` | original | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputinputimage.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputinputimage.mdx deleted file mode 100644 index 398cb693..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputInputImage - Python SDK -sidebarTitle: CustomToolCallOutputItemOutputInputImage -description: CustomToolCallOutputItemOutputInputImage method reference -seoTitle: CustomToolCallOutputItemOutputInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputInputImage | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemOutputInputImage method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputInputImage%20-%20Python%20SDK&description=CustomToolCallOutputItemOutputInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `detail` | [components.CustomToolCallOutputItemDetail](/client-sdks/python/api-reference/components/customtoolcalloutputitemdetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.CustomToolCallOutputItemOutputType](/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputtype.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputtype.mdx deleted file mode 100644 index 44cfcab6..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputType - Python SDK -sidebarTitle: CustomToolCallOutputItemOutputType -description: CustomToolCallOutputItemOutputType method reference -seoTitle: CustomToolCallOutputItemOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemoutputtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputType | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemOutputType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputType%20-%20Python%20SDK&description=CustomToolCallOutputItemOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion1.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion1.mdx deleted file mode 100644 index 1a835f38..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion1 - Python SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion1 -description: CustomToolCallOutputItemOutputUnion1 method reference -seoTitle: CustomToolCallOutputItemOutputUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion1 | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion1%20-%20Python%20SDK&description=CustomToolCallOutputItemOutputUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` - -### `components.CustomToolCallOutputItemOutputInputImage` - -```python lines -value: components.CustomToolCallOutputItemOutputInputImage = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion2.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion2.mdx deleted file mode 100644 index c55461ad..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion2 - Python SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion2 -description: CustomToolCallOutputItemOutputUnion2 method reference -seoTitle: CustomToolCallOutputItemOutputUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion2 | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion2%20-%20Python%20SDK&description=CustomToolCallOutputItemOutputUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.CustomToolCallOutputItemOutputUnion1]` - -```python lines -value: List[components.CustomToolCallOutputItemOutputUnion1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx b/client-sdks/python/api-reference/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx deleted file mode 100644 index a59a78bf..00000000 --- a/client-sdks/python/api-reference/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolCallOutputItemTypeCustomToolCallOutput - Python SDK -sidebarTitle: CustomToolCallOutputItemTypeCustomToolCallOutput -description: CustomToolCallOutputItemTypeCustomToolCallOutput method reference -seoTitle: CustomToolCallOutputItemTypeCustomToolCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtoolcalloutputitemtypecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemTypeCustomToolCallOutput | OpenRouter Python SDK -'og:description': >- - CustomToolCallOutputItemTypeCustomToolCallOutput method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemTypeCustomToolCallOutput%20-%20Python%20SDK&description=CustomToolCallOutputItemTypeCustomToolCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `CUSTOM_TOOL_CALL_OUTPUT` | custom_tool_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/customtooltypecustom.mdx b/client-sdks/python/api-reference/components/customtooltypecustom.mdx deleted file mode 100644 index 2841ac4a..00000000 --- a/client-sdks/python/api-reference/components/customtooltypecustom.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CustomToolTypeCustom - Python SDK -sidebarTitle: CustomToolTypeCustom -description: CustomToolTypeCustom method reference -seoTitle: CustomToolTypeCustom | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/customtooltypecustom -'og:site_name': OpenRouter Documentation -'og:title': CustomToolTypeCustom | OpenRouter Python SDK -'og:description': >- - CustomToolTypeCustom method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolTypeCustom%20-%20Python%20SDK&description=CustomToolTypeCustom%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `CUSTOM` | custom | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/datacollection.mdx b/client-sdks/python/api-reference/components/datacollection.mdx deleted file mode 100644 index 856a4a5e..00000000 --- a/client-sdks/python/api-reference/components/datacollection.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: DataCollection - Python SDK -sidebarTitle: DataCollection -description: DataCollection method reference -seoTitle: DataCollection | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/datacollection' -'og:site_name': OpenRouter Documentation -'og:title': DataCollection | OpenRouter Python SDK -'og:description': >- - DataCollection method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DataCollection%20-%20Python%20SDK&description=DataCollection%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| ------- | ------- | -| `DENY` | deny | -| `ALLOW` | allow | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/datetimeservertool.mdx b/client-sdks/python/api-reference/components/datetimeservertool.mdx deleted file mode 100644 index 3e759f6d..00000000 --- a/client-sdks/python/api-reference/components/datetimeservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DatetimeServerTool - Python SDK -sidebarTitle: DatetimeServerTool -description: DatetimeServerTool method reference -seoTitle: DatetimeServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/datetimeservertool -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerTool | OpenRouter Python SDK -'og:description': >- - DatetimeServerTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerTool%20-%20Python%20SDK&description=DatetimeServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: returns the current date and time - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [Optional[components.DatetimeServerToolConfig]](../components/datetimeservertoolconfig.md) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | `{"timezone": "America/New_York"}` | -| `type` | [components.DatetimeServerToolType](/client-sdks/python/api-reference/components/datetimeservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/datetimeservertoolconfig.mdx b/client-sdks/python/api-reference/components/datetimeservertoolconfig.mdx deleted file mode 100644 index 8534d313..00000000 --- a/client-sdks/python/api-reference/components/datetimeservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DatetimeServerToolConfig - Python SDK -sidebarTitle: DatetimeServerToolConfig -description: DatetimeServerToolConfig method reference -seoTitle: DatetimeServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/datetimeservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolConfig | OpenRouter Python SDK -'og:description': >- - DatetimeServerToolConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolConfig%20-%20Python%20SDK&description=DatetimeServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:datetime server tool - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `timezone` | *Optional[str]* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/datetimeservertooltype.mdx b/client-sdks/python/api-reference/components/datetimeservertooltype.mdx deleted file mode 100644 index 89a18ef8..00000000 --- a/client-sdks/python/api-reference/components/datetimeservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DatetimeServerToolType - Python SDK -sidebarTitle: DatetimeServerToolType -description: DatetimeServerToolType method reference -seoTitle: DatetimeServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/datetimeservertooltype -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolType | OpenRouter Python SDK -'og:description': >- - DatetimeServerToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolType%20-%20Python%20SDK&description=DatetimeServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `OPENROUTER_DATETIME` | openrouter:datetime | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/defaultparameters.mdx b/client-sdks/python/api-reference/components/defaultparameters.mdx deleted file mode 100644 index 714cca20..00000000 --- a/client-sdks/python/api-reference/components/defaultparameters.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: DefaultParameters - Python SDK -sidebarTitle: DefaultParameters -description: DefaultParameters method reference -seoTitle: DefaultParameters | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/defaultparameters -'og:site_name': OpenRouter Documentation -'og:title': DefaultParameters | OpenRouter Python SDK -'og:description': >- - DefaultParameters method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DefaultParameters%20-%20Python%20SDK&description=DefaultParameters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Default parameters for this model - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `repetition_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `top_k` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/deletebyokkeyresponse.mdx b/client-sdks/python/api-reference/components/deletebyokkeyresponse.mdx deleted file mode 100644 index 2b0a2f1c..00000000 --- a/client-sdks/python/api-reference/components/deletebyokkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteBYOKKeyResponse - Python SDK -sidebarTitle: DeleteBYOKKeyResponse -description: DeleteBYOKKeyResponse method reference -seoTitle: DeleteBYOKKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/deletebyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyResponse | OpenRouter Python SDK -'og:description': >- - DeleteBYOKKeyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyResponse%20-%20Python%20SDK&description=DeleteBYOKKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/deleteguardrailresponse.mdx b/client-sdks/python/api-reference/components/deleteguardrailresponse.mdx deleted file mode 100644 index e07b5975..00000000 --- a/client-sdks/python/api-reference/components/deleteguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteGuardrailResponse - Python SDK -sidebarTitle: DeleteGuardrailResponse -description: DeleteGuardrailResponse method reference -seoTitle: DeleteGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/deleteguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailResponse | OpenRouter Python SDK -'og:description': >- - DeleteGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailResponse%20-%20Python%20SDK&description=DeleteGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/deleteobservabilitydestinationresponse.mdx b/client-sdks/python/api-reference/components/deleteobservabilitydestinationresponse.mdx deleted file mode 100644 index 2f276697..00000000 --- a/client-sdks/python/api-reference/components/deleteobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteObservabilityDestinationResponse - Python SDK -sidebarTitle: DeleteObservabilityDestinationResponse -description: DeleteObservabilityDestinationResponse method reference -seoTitle: DeleteObservabilityDestinationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/deleteobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationResponse | OpenRouter Python SDK -'og:description': >- - DeleteObservabilityDestinationResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationResponse%20-%20Python%20SDK&description=DeleteObservabilityDestinationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/deleteworkspaceresponse.mdx b/client-sdks/python/api-reference/components/deleteworkspaceresponse.mdx deleted file mode 100644 index 026dc03b..00000000 --- a/client-sdks/python/api-reference/components/deleteworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteWorkspaceResponse - Python SDK -sidebarTitle: DeleteWorkspaceResponse -description: DeleteWorkspaceResponse method reference -seoTitle: DeleteWorkspaceResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/deleteworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceResponse | OpenRouter Python SDK -'og:description': >- - DeleteWorkspaceResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceResponse%20-%20Python%20SDK&description=DeleteWorkspaceResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessage.mdx b/client-sdks/python/api-reference/components/easyinputmessage.mdx deleted file mode 100644 index 9a119826..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EasyInputMessage - Python SDK -sidebarTitle: EasyInputMessage -description: EasyInputMessage method reference -seoTitle: EasyInputMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessage | OpenRouter Python SDK -'og:description': >- - EasyInputMessage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessage%20-%20Python%20SDK&description=EasyInputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [OptionalNullable[components.EasyInputMessageContentUnion2]](../components/easyinputmessagecontentunion2.md) | :heavy_minus_sign: | N/A | | -| `phase` | [OptionalNullable[components.EasyInputMessagePhaseUnion]](../components/easyinputmessagephaseunion.md) | :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](/client-sdks/python/api-reference/components/easyinputmessageroleunion) | :heavy_check_mark: | N/A | | -| `type` | [Optional[components.EasyInputMessageTypeMessage]](../components/easyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagecontentinputimage.mdx b/client-sdks/python/api-reference/components/easyinputmessagecontentinputimage.mdx deleted file mode 100644 index a92a02f7..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagecontentinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EasyInputMessageContentInputImage - Python SDK -sidebarTitle: EasyInputMessageContentInputImage -description: EasyInputMessageContentInputImage method reference -seoTitle: EasyInputMessageContentInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagecontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentInputImage | OpenRouter Python SDK -'og:description': >- - EasyInputMessageContentInputImage method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentInputImage%20-%20Python%20SDK&description=EasyInputMessageContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `detail` | [components.EasyInputMessageDetail](/client-sdks/python/api-reference/components/easyinputmessagedetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.EasyInputMessageTypeInputImage](/client-sdks/python/api-reference/components/easyinputmessagetypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagecontentunion1.mdx b/client-sdks/python/api-reference/components/easyinputmessagecontentunion1.mdx deleted file mode 100644 index d7601de3..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagecontentunion1.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: EasyInputMessageContentUnion1 - Python SDK -sidebarTitle: EasyInputMessageContentUnion1 -description: EasyInputMessageContentUnion1 method reference -seoTitle: EasyInputMessageContentUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagecontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion1 | OpenRouter Python SDK -'og:description': >- - EasyInputMessageContentUnion1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion1%20-%20Python%20SDK&description=EasyInputMessageContentUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` - -### `components.EasyInputMessageContentInputImage` - -```python lines -value: components.EasyInputMessageContentInputImage = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputAudio` - -```python lines -value: components.InputAudio = /* values here */ -``` - -### `components.InputVideo` - -```python lines -value: components.InputVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagecontentunion2.mdx b/client-sdks/python/api-reference/components/easyinputmessagecontentunion2.mdx deleted file mode 100644 index ff2a44e0..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagecontentunion2.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: EasyInputMessageContentUnion2 - Python SDK -sidebarTitle: EasyInputMessageContentUnion2 -description: EasyInputMessageContentUnion2 method reference -seoTitle: EasyInputMessageContentUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagecontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion2 | OpenRouter Python SDK -'og:description': >- - EasyInputMessageContentUnion2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion2%20-%20Python%20SDK&description=EasyInputMessageContentUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.EasyInputMessageContentUnion1]` - -```python lines -value: List[components.EasyInputMessageContentUnion1] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagedetail.mdx b/client-sdks/python/api-reference/components/easyinputmessagedetail.mdx deleted file mode 100644 index e26aa975..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagedetail.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EasyInputMessageDetail - Python SDK -sidebarTitle: EasyInputMessageDetail -description: EasyInputMessageDetail method reference -seoTitle: EasyInputMessageDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagedetail -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageDetail | OpenRouter Python SDK -'og:description': >- - EasyInputMessageDetail method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageDetail%20-%20Python%20SDK&description=EasyInputMessageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | -| `ORIGINAL` | original | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagephasecommentary.mdx b/client-sdks/python/api-reference/components/easyinputmessagephasecommentary.mdx deleted file mode 100644 index 5ba9e2ce..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagephasecommentary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessagePhaseCommentary - Python SDK -sidebarTitle: EasyInputMessagePhaseCommentary -description: EasyInputMessagePhaseCommentary method reference -seoTitle: EasyInputMessagePhaseCommentary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseCommentary | OpenRouter Python SDK -'og:description': >- - EasyInputMessagePhaseCommentary method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseCommentary%20-%20Python%20SDK&description=EasyInputMessagePhaseCommentary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMMENTARY` | commentary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagephasefinalanswer.mdx b/client-sdks/python/api-reference/components/easyinputmessagephasefinalanswer.mdx deleted file mode 100644 index 6026ad3f..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessagePhaseFinalAnswer - Python SDK -sidebarTitle: EasyInputMessagePhaseFinalAnswer -description: EasyInputMessagePhaseFinalAnswer method reference -seoTitle: EasyInputMessagePhaseFinalAnswer | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseFinalAnswer | OpenRouter Python SDK -'og:description': >- - EasyInputMessagePhaseFinalAnswer method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseFinalAnswer%20-%20Python%20SDK&description=EasyInputMessagePhaseFinalAnswer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FINAL_ANSWER` | final_answer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagephaseunion.mdx b/client-sdks/python/api-reference/components/easyinputmessagephaseunion.mdx deleted file mode 100644 index e63e44c0..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagephaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: EasyInputMessagePhaseUnion - Python SDK -sidebarTitle: EasyInputMessagePhaseUnion -description: EasyInputMessagePhaseUnion method reference -seoTitle: EasyInputMessagePhaseUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseUnion | OpenRouter Python SDK -'og:description': >- - EasyInputMessagePhaseUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseUnion%20-%20Python%20SDK&description=EasyInputMessagePhaseUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `components.EasyInputMessagePhaseCommentary` - -```python lines -value: components.EasyInputMessagePhaseCommentary = /* values here */ -``` - -### `components.EasyInputMessagePhaseFinalAnswer` - -```python lines -value: components.EasyInputMessagePhaseFinalAnswer = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessageroleassistant.mdx b/client-sdks/python/api-reference/components/easyinputmessageroleassistant.mdx deleted file mode 100644 index d4e54e37..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessageroleassistant.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageRoleAssistant - Python SDK -sidebarTitle: EasyInputMessageRoleAssistant -description: EasyInputMessageRoleAssistant method reference -seoTitle: EasyInputMessageRoleAssistant | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessageroleassistant -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleAssistant | OpenRouter Python SDK -'og:description': >- - EasyInputMessageRoleAssistant method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleAssistant%20-%20Python%20SDK&description=EasyInputMessageRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessageroledeveloper.mdx b/client-sdks/python/api-reference/components/easyinputmessageroledeveloper.mdx deleted file mode 100644 index 094af608..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessageroledeveloper.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageRoleDeveloper - Python SDK -sidebarTitle: EasyInputMessageRoleDeveloper -description: EasyInputMessageRoleDeveloper method reference -seoTitle: EasyInputMessageRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessageroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleDeveloper | OpenRouter Python SDK -'og:description': >- - EasyInputMessageRoleDeveloper method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleDeveloper%20-%20Python%20SDK&description=EasyInputMessageRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagerolesystem.mdx b/client-sdks/python/api-reference/components/easyinputmessagerolesystem.mdx deleted file mode 100644 index 5f6c5c18..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagerolesystem.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageRoleSystem - Python SDK -sidebarTitle: EasyInputMessageRoleSystem -description: EasyInputMessageRoleSystem method reference -seoTitle: EasyInputMessageRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagerolesystem -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleSystem | OpenRouter Python SDK -'og:description': >- - EasyInputMessageRoleSystem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleSystem%20-%20Python%20SDK&description=EasyInputMessageRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessageroleunion.mdx b/client-sdks/python/api-reference/components/easyinputmessageroleunion.mdx deleted file mode 100644 index 57528663..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessageroleunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: EasyInputMessageRoleUnion - Python SDK -sidebarTitle: EasyInputMessageRoleUnion -description: EasyInputMessageRoleUnion method reference -seoTitle: EasyInputMessageRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessageroleunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUnion | OpenRouter Python SDK -'og:description': >- - EasyInputMessageRoleUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUnion%20-%20Python%20SDK&description=EasyInputMessageRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.EasyInputMessageRoleUser` - -```python lines -value: components.EasyInputMessageRoleUser = /* values here */ -``` - -### `components.EasyInputMessageRoleSystem` - -```python lines -value: components.EasyInputMessageRoleSystem = /* values here */ -``` - -### `components.EasyInputMessageRoleAssistant` - -```python lines -value: components.EasyInputMessageRoleAssistant = /* values here */ -``` - -### `components.EasyInputMessageRoleDeveloper` - -```python lines -value: components.EasyInputMessageRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessageroleuser.mdx b/client-sdks/python/api-reference/components/easyinputmessageroleuser.mdx deleted file mode 100644 index 6322cb3e..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessageroleuser.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageRoleUser - Python SDK -sidebarTitle: EasyInputMessageRoleUser -description: EasyInputMessageRoleUser method reference -seoTitle: EasyInputMessageRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessageroleuser -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUser | OpenRouter Python SDK -'og:description': >- - EasyInputMessageRoleUser method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUser%20-%20Python%20SDK&description=EasyInputMessageRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagetypeinputimage.mdx b/client-sdks/python/api-reference/components/easyinputmessagetypeinputimage.mdx deleted file mode 100644 index 5d1d4d0c..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagetypeinputimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageTypeInputImage - Python SDK -sidebarTitle: EasyInputMessageTypeInputImage -description: EasyInputMessageTypeInputImage method reference -seoTitle: EasyInputMessageTypeInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagetypeinputimage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageTypeInputImage | OpenRouter Python SDK -'og:description': >- - EasyInputMessageTypeInputImage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageTypeInputImage%20-%20Python%20SDK&description=EasyInputMessageTypeInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/easyinputmessagetypemessage.mdx b/client-sdks/python/api-reference/components/easyinputmessagetypemessage.mdx deleted file mode 100644 index 567f335f..00000000 --- a/client-sdks/python/api-reference/components/easyinputmessagetypemessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EasyInputMessageTypeMessage - Python SDK -sidebarTitle: EasyInputMessageTypeMessage -description: EasyInputMessageTypeMessage method reference -seoTitle: EasyInputMessageTypeMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/easyinputmessagetypemessage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageTypeMessage | OpenRouter Python SDK -'og:description': >- - EasyInputMessageTypeMessage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageTypeMessage%20-%20Python%20SDK&description=EasyInputMessageTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata.mdx b/client-sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata.mdx deleted file mode 100644 index 41294f68..00000000 --- a/client-sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseErrorData - Python SDK -sidebarTitle: EdgeNetworkTimeoutResponseErrorData -description: EdgeNetworkTimeoutResponseErrorData method reference -seoTitle: EdgeNetworkTimeoutResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseErrorData | OpenRouter Python SDK -'og:description': >- - EdgeNetworkTimeoutResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseErrorData%20-%20Python%20SDK&description=EdgeNetworkTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for EdgeNetworkTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/edit.mdx b/client-sdks/python/api-reference/components/edit.mdx deleted file mode 100644 index 3cf2441a..00000000 --- a/client-sdks/python/api-reference/components/edit.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Edit - Python SDK -sidebarTitle: Edit -description: Edit method reference -seoTitle: Edit | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/edit' -'og:site_name': OpenRouter Documentation -'og:title': Edit | OpenRouter Python SDK -'og:description': >- - Edit method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Edit%20-%20Python%20SDK&description=Edit%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.EditClearToolUses20250919` - -```python lines -value: components.EditClearToolUses20250919 = /* values here */ -``` - -### `components.EditClearThinking20251015` - -```python lines -value: components.EditClearThinking20251015 = /* values here */ -``` - -### `components.EditCompact20260112` - -```python lines -value: components.EditCompact20260112 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/editclearthinking20251015.mdx b/client-sdks/python/api-reference/components/editclearthinking20251015.mdx deleted file mode 100644 index 7cd19c01..00000000 --- a/client-sdks/python/api-reference/components/editclearthinking20251015.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EditClearThinking20251015 - Python SDK -sidebarTitle: EditClearThinking20251015 -description: EditClearThinking20251015 method reference -seoTitle: EditClearThinking20251015 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/editclearthinking20251015 -'og:site_name': OpenRouter Documentation -'og:title': EditClearThinking20251015 | OpenRouter Python SDK -'og:description': >- - EditClearThinking20251015 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearThinking20251015%20-%20Python%20SDK&description=EditClearThinking20251015%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `keep` | [Optional[components.Keep]](../components/keep.md) | :heavy_minus_sign: | N/A | -| `type` | [components.TypeClearThinking20251015](/client-sdks/python/api-reference/components/typeclearthinking20251015) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/editcleartooluses20250919.mdx b/client-sdks/python/api-reference/components/editcleartooluses20250919.mdx deleted file mode 100644 index ab26b8b1..00000000 --- a/client-sdks/python/api-reference/components/editcleartooluses20250919.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: EditClearToolUses20250919 - Python SDK -sidebarTitle: EditClearToolUses20250919 -description: EditClearToolUses20250919 method reference -seoTitle: EditClearToolUses20250919 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/editcleartooluses20250919 -'og:site_name': OpenRouter Documentation -'og:title': EditClearToolUses20250919 | OpenRouter Python SDK -'og:description': >- - EditClearToolUses20250919 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearToolUses20250919%20-%20Python%20SDK&description=EditClearToolUses20250919%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `clear_at_least` | [OptionalNullable[components.AnthropicInputTokensClearAtLeast]](../components/anthropicinputtokensclearatleast.md) | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 50000}` | -| `clear_tool_inputs` | [OptionalNullable[components.ClearToolInputs]](../components/cleartoolinputs.md) | :heavy_minus_sign: | N/A | | -| `exclude_tools` | List[*str*] | :heavy_minus_sign: | N/A | | -| `keep` | [Optional[components.AnthropicToolUsesKeep]](../components/anthropictooluseskeep.md) | :heavy_minus_sign: | N/A | `{"type": "tool_uses","value": 5}` | -| `trigger` | [Optional[components.Trigger]](../components/trigger.md) | :heavy_minus_sign: | N/A | | -| `type` | [components.TypeClearToolUses20250919](/client-sdks/python/api-reference/components/typecleartooluses20250919) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/editcompact20260112.mdx b/client-sdks/python/api-reference/components/editcompact20260112.mdx deleted file mode 100644 index f3d7a95e..00000000 --- a/client-sdks/python/api-reference/components/editcompact20260112.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EditCompact20260112 - Python SDK -sidebarTitle: EditCompact20260112 -description: EditCompact20260112 method reference -seoTitle: EditCompact20260112 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/editcompact20260112 -'og:site_name': OpenRouter Documentation -'og:title': EditCompact20260112 | OpenRouter Python SDK -'og:description': >- - EditCompact20260112 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditCompact20260112%20-%20Python%20SDK&description=EditCompact20260112%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `pause_after_compaction` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `trigger` | [OptionalNullable[components.TriggerInputTokens]](../components/triggerinputtokens.md) | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 100000}` | -| `type` | [components.TypeCompact20260112](/client-sdks/python/api-reference/components/typecompact20260112) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/edittypeinputtokens.mdx b/client-sdks/python/api-reference/components/edittypeinputtokens.mdx deleted file mode 100644 index 3062f368..00000000 --- a/client-sdks/python/api-reference/components/edittypeinputtokens.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: EditTypeInputTokens - Python SDK -sidebarTitle: EditTypeInputTokens -description: EditTypeInputTokens method reference -seoTitle: EditTypeInputTokens | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/edittypeinputtokens -'og:site_name': OpenRouter Documentation -'og:title': EditTypeInputTokens | OpenRouter Python SDK -'og:description': >- - EditTypeInputTokens method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditTypeInputTokens%20-%20Python%20SDK&description=EditTypeInputTokens%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `INPUT_TOKENS` | input_tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/endpointinfo.mdx b/client-sdks/python/api-reference/components/endpointinfo.mdx deleted file mode 100644 index cd7f9320..00000000 --- a/client-sdks/python/api-reference/components/endpointinfo.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EndpointInfo - Python SDK -sidebarTitle: EndpointInfo -description: EndpointInfo method reference -seoTitle: EndpointInfo | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/endpointinfo' -'og:site_name': OpenRouter Documentation -'og:title': EndpointInfo | OpenRouter Python SDK -'og:description': >- - EndpointInfo method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointInfo%20-%20Python%20SDK&description=EndpointInfo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *str* | :heavy_check_mark: | N/A | -| `selected` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/endpointsmetadata.mdx b/client-sdks/python/api-reference/components/endpointsmetadata.mdx deleted file mode 100644 index 7e174941..00000000 --- a/client-sdks/python/api-reference/components/endpointsmetadata.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EndpointsMetadata - Python SDK -sidebarTitle: EndpointsMetadata -description: EndpointsMetadata method reference -seoTitle: EndpointsMetadata | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/endpointsmetadata -'og:site_name': OpenRouter Documentation -'og:title': EndpointsMetadata | OpenRouter Python SDK -'og:description': >- - EndpointsMetadata method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointsMetadata%20-%20Python%20SDK&description=EndpointsMetadata%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `available` | List[[components.EndpointInfo](/client-sdks/python/api-reference/components/endpointinfo)] | :heavy_check_mark: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/endpointstatus.mdx b/client-sdks/python/api-reference/components/endpointstatus.mdx deleted file mode 100644 index de94f7cc..00000000 --- a/client-sdks/python/api-reference/components/endpointstatus.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EndpointStatus - Python SDK -sidebarTitle: EndpointStatus -description: EndpointStatus method reference -seoTitle: EndpointStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/endpointstatus' -'og:site_name': OpenRouter Documentation -'og:title': EndpointStatus | OpenRouter Python SDK -'og:description': >- - EndpointStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointStatus%20-%20Python%20SDK&description=EndpointStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ZERO` | 0 | -| `MINUS_1` | -1 | -| `MINUS_2` | -2 | -| `MINUS_3` | -3 | -| `MINUS_5` | -5 | -| `MINUS_10` | -10 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/environment.mdx b/client-sdks/python/api-reference/components/environment.mdx deleted file mode 100644 index 56cf8353..00000000 --- a/client-sdks/python/api-reference/components/environment.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Environment - Python SDK -sidebarTitle: Environment -description: Environment method reference -seoTitle: Environment | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/environment' -'og:site_name': OpenRouter Documentation -'og:title': Environment | OpenRouter Python SDK -'og:description': >- - Environment method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Environment%20-%20Python%20SDK&description=Environment%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `WINDOWS` | windows | -| `MAC` | mac | -| `LINUX` | linux | -| `UBUNTU` | ubuntu | -| `BROWSER` | browser | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/error.mdx b/client-sdks/python/api-reference/components/error.mdx deleted file mode 100644 index 9f0ed4dd..00000000 --- a/client-sdks/python/api-reference/components/error.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Error - Python SDK -sidebarTitle: Error -description: Error method reference -seoTitle: Error | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/error' -'og:site_name': OpenRouter Documentation -'og:title': Error | OpenRouter Python SDK -'og:description': >- - Error method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Error%20-%20Python%20SDK&description=Error%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `code` | *int* | :heavy_check_mark: | Error code | 429 | -| `message` | *str* | :heavy_check_mark: | Error message | Rate limit exceeded | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/errorcode.mdx b/client-sdks/python/api-reference/components/errorcode.mdx deleted file mode 100644 index d4cb0785..00000000 --- a/client-sdks/python/api-reference/components/errorcode.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ErrorCode - Python SDK -sidebarTitle: ErrorCode -description: ErrorCode method reference -seoTitle: ErrorCode | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/errorcode' -'og:site_name': OpenRouter Documentation -'og:title': ErrorCode | OpenRouter Python SDK -'og:description': >- - ErrorCode method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorCode%20-%20Python%20SDK&description=ErrorCode%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `INVALID_TOOL_INPUT` | invalid_tool_input | -| `UNAVAILABLE` | unavailable | -| `MAX_USES_EXCEEDED` | max_uses_exceeded | -| `TOO_MANY_REQUESTS` | too_many_requests | -| `QUERY_TOO_LONG` | query_too_long | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/errorevent.mdx b/client-sdks/python/api-reference/components/errorevent.mdx deleted file mode 100644 index 9f9641ad..00000000 --- a/client-sdks/python/api-reference/components/errorevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ErrorEvent - Python SDK -sidebarTitle: ErrorEvent -description: ErrorEvent method reference -seoTitle: ErrorEvent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/errorevent' -'og:site_name': OpenRouter Documentation -'og:title': ErrorEvent | OpenRouter Python SDK -'og:description': >- - ErrorEvent method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorEvent%20-%20Python%20SDK&description=ErrorEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when an error occurs during streaming - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `code` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ErrorEventType](/client-sdks/python/api-reference/components/erroreventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/erroreventtype.mdx b/client-sdks/python/api-reference/components/erroreventtype.mdx deleted file mode 100644 index 57860add..00000000 --- a/client-sdks/python/api-reference/components/erroreventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ErrorEventType - Python SDK -sidebarTitle: ErrorEventType -description: ErrorEventType method reference -seoTitle: ErrorEventType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/erroreventtype' -'og:site_name': OpenRouter Documentation -'og:title': ErrorEventType | OpenRouter Python SDK -'og:description': >- - ErrorEventType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorEventType%20-%20Python%20SDK&description=ErrorEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `ERROR` | error | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/failedmodel.mdx b/client-sdks/python/api-reference/components/failedmodel.mdx deleted file mode 100644 index 25477ac4..00000000 --- a/client-sdks/python/api-reference/components/failedmodel.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FailedModel - Python SDK -sidebarTitle: FailedModel -description: FailedModel method reference -seoTitle: FailedModel | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/failedmodel' -'og:site_name': OpenRouter Documentation -'og:title': FailedModel | OpenRouter Python SDK -'og:description': >- - FailedModel method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FailedModel%20-%20Python%20SDK&description=FailedModel%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `error` | *str* | :heavy_check_mark: | Error message describing why the model failed. | -| `model` | *str* | :heavy_check_mark: | Slug of the analysis model that failed. | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fieldt.mdx b/client-sdks/python/api-reference/components/fieldt.mdx deleted file mode 100644 index 0c489e01..00000000 --- a/client-sdks/python/api-reference/components/fieldt.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FieldT - Python SDK -sidebarTitle: FieldT -description: FieldT method reference -seoTitle: FieldT | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/fieldt' -'og:site_name': OpenRouter Documentation -'og:title': FieldT | OpenRouter Python SDK -'og:description': >- - FieldT method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FieldT%20-%20Python%20SDK&description=FieldT%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `MODEL` | model | -| `PROVIDER` | provider | -| `SESSION_ID` | session_id | -| `USER_ID` | user_id | -| `API_KEY_NAME` | api_key_name | -| `FINISH_REASON` | finish_reason | -| `INPUT` | input | -| `OUTPUT` | output | -| `TOTAL_COST` | total_cost | -| `TOTAL_TOKENS` | total_tokens | -| `PROMPT_TOKENS` | prompt_tokens | -| `COMPLETION_TOKENS` | completion_tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/file.mdx b/client-sdks/python/api-reference/components/file.mdx deleted file mode 100644 index 10ed3f0a..00000000 --- a/client-sdks/python/api-reference/components/file.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: File - Python SDK -sidebarTitle: File -description: File method reference -seoTitle: File | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/file' -'og:site_name': OpenRouter Documentation -'og:title': File | OpenRouter Python SDK -'og:description': >- - File method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=File%20-%20Python%20SDK&description=File%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `file_data` | *Optional[str]* | :heavy_minus_sign: | File content as base64 data URL or URL | -| `file_id` | *Optional[str]* | :heavy_minus_sign: | File ID for previously uploaded files | -| `filename` | *Optional[str]* | :heavy_minus_sign: | Original filename | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filecitation.mdx b/client-sdks/python/api-reference/components/filecitation.mdx deleted file mode 100644 index b9fe5192..00000000 --- a/client-sdks/python/api-reference/components/filecitation.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FileCitation - Python SDK -sidebarTitle: FileCitation -description: FileCitation method reference -seoTitle: FileCitation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filecitation' -'og:site_name': OpenRouter Documentation -'og:title': FileCitation | OpenRouter Python SDK -'og:description': >- - FileCitation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitation%20-%20Python%20SDK&description=FileCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FileCitationType](/client-sdks/python/api-reference/components/filecitationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filecitationtype.mdx b/client-sdks/python/api-reference/components/filecitationtype.mdx deleted file mode 100644 index ac7877ef..00000000 --- a/client-sdks/python/api-reference/components/filecitationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FileCitationType - Python SDK -sidebarTitle: FileCitationType -description: FileCitationType method reference -seoTitle: FileCitationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/filecitationtype -'og:site_name': OpenRouter Documentation -'og:title': FileCitationType | OpenRouter Python SDK -'og:description': >- - FileCitationType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitationType%20-%20Python%20SDK&description=FileCitationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FILE_CITATION` | file_citation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fileparserplugin.mdx b/client-sdks/python/api-reference/components/fileparserplugin.mdx deleted file mode 100644 index d227921f..00000000 --- a/client-sdks/python/api-reference/components/fileparserplugin.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FileParserPlugin - Python SDK -sidebarTitle: FileParserPlugin -description: FileParserPlugin method reference -seoTitle: FileParserPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fileparserplugin -'og:site_name': OpenRouter Documentation -'og:title': FileParserPlugin | OpenRouter Python SDK -'og:description': >- - FileParserPlugin method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileParserPlugin%20-%20Python%20SDK&description=FileParserPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `id` | [components.FileParserPluginID](/client-sdks/python/api-reference/components/fileparserpluginid) | :heavy_check_mark: | N/A | | -| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.md) | :heavy_minus_sign: | Options for PDF parsing. | `{"engine": "cloudflare-ai"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fileparserpluginid.mdx b/client-sdks/python/api-reference/components/fileparserpluginid.mdx deleted file mode 100644 index f5684622..00000000 --- a/client-sdks/python/api-reference/components/fileparserpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FileParserPluginID - Python SDK -sidebarTitle: FileParserPluginID -description: FileParserPluginID method reference -seoTitle: FileParserPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fileparserpluginid -'og:site_name': OpenRouter Documentation -'og:title': FileParserPluginID | OpenRouter Python SDK -'og:description': >- - FileParserPluginID method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileParserPluginID%20-%20Python%20SDK&description=FileParserPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `FILE_PARSER` | file-parser | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filepath.mdx b/client-sdks/python/api-reference/components/filepath.mdx deleted file mode 100644 index b71622a1..00000000 --- a/client-sdks/python/api-reference/components/filepath.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FilePath - Python SDK -sidebarTitle: FilePath -description: FilePath method reference -seoTitle: FilePath | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filepath' -'og:site_name': OpenRouter Documentation -'og:title': FilePath | OpenRouter Python SDK -'og:description': >- - FilePath method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePath%20-%20Python%20SDK&description=FilePath%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FilePathType](/client-sdks/python/api-reference/components/filepathtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filepathtype.mdx b/client-sdks/python/api-reference/components/filepathtype.mdx deleted file mode 100644 index 989413bb..00000000 --- a/client-sdks/python/api-reference/components/filepathtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FilePathType - Python SDK -sidebarTitle: FilePathType -description: FilePathType method reference -seoTitle: FilePathType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filepathtype' -'og:site_name': OpenRouter Documentation -'og:title': FilePathType | OpenRouter Python SDK -'og:description': >- - FilePathType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePathType%20-%20Python%20SDK&description=FilePathType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `FILE_PATH` | file_path | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filesearchservertool.mdx b/client-sdks/python/api-reference/components/filesearchservertool.mdx deleted file mode 100644 index 54b18dc6..00000000 --- a/client-sdks/python/api-reference/components/filesearchservertool.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FileSearchServerTool - Python SDK -sidebarTitle: FileSearchServerTool -description: FileSearchServerTool method reference -seoTitle: FileSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/filesearchservertool -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerTool | OpenRouter Python SDK -'og:description': >- - FileSearchServerTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerTool%20-%20Python%20SDK&description=FileSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -File search tool configuration - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `filters` | [OptionalNullable[components.FiltersUnion]](../components/filtersunion.md) | :heavy_minus_sign: | N/A | -| `max_num_results` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `ranking_options` | [Optional[components.RankingOptions]](../components/rankingoptions.md) | :heavy_minus_sign: | N/A | -| `type` | [components.TypeFileSearch](/client-sdks/python/api-reference/components/typefilesearch) | :heavy_check_mark: | N/A | -| `vector_store_ids` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filesearchservertoolvalue1.mdx b/client-sdks/python/api-reference/components/filesearchservertoolvalue1.mdx deleted file mode 100644 index abfa754e..00000000 --- a/client-sdks/python/api-reference/components/filesearchservertoolvalue1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FileSearchServerToolValue1 - Python SDK -sidebarTitle: FileSearchServerToolValue1 -description: FileSearchServerToolValue1 method reference -seoTitle: FileSearchServerToolValue1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/filesearchservertoolvalue1 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue1 | OpenRouter Python SDK -'og:description': >- - FileSearchServerToolValue1 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue1%20-%20Python%20SDK&description=FileSearchServerToolValue1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filesearchservertoolvalue2.mdx b/client-sdks/python/api-reference/components/filesearchservertoolvalue2.mdx deleted file mode 100644 index 3383ac90..00000000 --- a/client-sdks/python/api-reference/components/filesearchservertoolvalue2.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: FileSearchServerToolValue2 - Python SDK -sidebarTitle: FileSearchServerToolValue2 -description: FileSearchServerToolValue2 method reference -seoTitle: FileSearchServerToolValue2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/filesearchservertoolvalue2 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue2 | OpenRouter Python SDK -'og:description': >- - FileSearchServerToolValue2 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue2%20-%20Python%20SDK&description=FileSearchServerToolValue2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `bool` - -```python lines -value: bool = /* values here */ -``` - -### `List[components.FileSearchServerToolValue1]` - -```python lines -value: List[components.FileSearchServerToolValue1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filters.mdx b/client-sdks/python/api-reference/components/filters.mdx deleted file mode 100644 index 3d8b76b5..00000000 --- a/client-sdks/python/api-reference/components/filters.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Filters - Python SDK -sidebarTitle: Filters -description: Filters method reference -seoTitle: Filters | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filters' -'og:site_name': OpenRouter Documentation -'og:title': Filters | OpenRouter Python SDK -'og:description': >- - Filters method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Filters%20-%20Python%20SDK&description=Filters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `key` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.FiltersType](/client-sdks/python/api-reference/components/filterstype) | :heavy_check_mark: | N/A | -| `value` | [components.FileSearchServerToolValue2](/client-sdks/python/api-reference/components/filesearchservertoolvalue2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filterstype.mdx b/client-sdks/python/api-reference/components/filterstype.mdx deleted file mode 100644 index 81dc2c09..00000000 --- a/client-sdks/python/api-reference/components/filterstype.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: FiltersType - Python SDK -sidebarTitle: FiltersType -description: FiltersType method reference -seoTitle: FiltersType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filterstype' -'og:site_name': OpenRouter Documentation -'og:title': FiltersType | OpenRouter Python SDK -'og:description': >- - FiltersType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersType%20-%20Python%20SDK&description=FiltersType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `EQ` | eq | -| `NE` | ne | -| `GT` | gt | -| `GTE` | gte | -| `LT` | lt | -| `LTE` | lte | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/filtersunion.mdx b/client-sdks/python/api-reference/components/filtersunion.mdx deleted file mode 100644 index 117ac411..00000000 --- a/client-sdks/python/api-reference/components/filtersunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FiltersUnion - Python SDK -sidebarTitle: FiltersUnion -description: FiltersUnion method reference -seoTitle: FiltersUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/filtersunion' -'og:site_name': OpenRouter Documentation -'og:title': FiltersUnion | OpenRouter Python SDK -'og:description': >- - FiltersUnion method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersUnion%20-%20Python%20SDK&description=FiltersUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.Filters` - -```python lines -value: components.Filters = /* values here */ -``` - -### `components.CompoundFilter` - -```python lines -value: components.CompoundFilter = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/forbiddenresponseerrordata.mdx b/client-sdks/python/api-reference/components/forbiddenresponseerrordata.mdx deleted file mode 100644 index dae3d833..00000000 --- a/client-sdks/python/api-reference/components/forbiddenresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ForbiddenResponseErrorData - Python SDK -sidebarTitle: ForbiddenResponseErrorData -description: ForbiddenResponseErrorData method reference -seoTitle: ForbiddenResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/forbiddenresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseErrorData | OpenRouter Python SDK -'og:description': >- - ForbiddenResponseErrorData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseErrorData%20-%20Python%20SDK&description=ForbiddenResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ForbiddenResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/format-.mdx b/client-sdks/python/api-reference/components/format-.mdx deleted file mode 100644 index b5941432..00000000 --- a/client-sdks/python/api-reference/components/format-.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Format - Python SDK -sidebarTitle: Format -description: Format method reference -seoTitle: Format | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/format-' -'og:site_name': OpenRouter Documentation -'og:title': Format | OpenRouter Python SDK -'og:description': >- - Format method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Format%20-%20Python%20SDK&description=Format%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.FormatText` - -```python lines -value: components.FormatText = /* values here */ -``` - -### `components.FormatGrammar` - -```python lines -value: components.FormatGrammar = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatenum.mdx b/client-sdks/python/api-reference/components/formatenum.mdx deleted file mode 100644 index 1cfdf90a..00000000 --- a/client-sdks/python/api-reference/components/formatenum.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FormatEnum - Python SDK -sidebarTitle: FormatEnum -description: FormatEnum method reference -seoTitle: FormatEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/formatenum' -'og:site_name': OpenRouter Documentation -'og:title': FormatEnum | OpenRouter Python SDK -'og:description': >- - FormatEnum method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatEnum%20-%20Python%20SDK&description=FormatEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `MP3` | mp3 | -| `WAV` | wav | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatgrammar.mdx b/client-sdks/python/api-reference/components/formatgrammar.mdx deleted file mode 100644 index b99d0e9d..00000000 --- a/client-sdks/python/api-reference/components/formatgrammar.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FormatGrammar - Python SDK -sidebarTitle: FormatGrammar -description: FormatGrammar method reference -seoTitle: FormatGrammar | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/formatgrammar' -'og:site_name': OpenRouter Documentation -'og:title': FormatGrammar | OpenRouter Python SDK -'og:description': >- - FormatGrammar method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatGrammar%20-%20Python%20SDK&description=FormatGrammar%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `definition` | *str* | :heavy_check_mark: | N/A | -| `syntax` | [components.Syntax](/client-sdks/python/api-reference/components/syntax) | :heavy_check_mark: | N/A | -| `type` | [components.FormatTypeGrammar](/client-sdks/python/api-reference/components/formattypegrammar) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatjsonobjectconfig.mdx b/client-sdks/python/api-reference/components/formatjsonobjectconfig.mdx deleted file mode 100644 index 3f14af15..00000000 --- a/client-sdks/python/api-reference/components/formatjsonobjectconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FormatJSONObjectConfig - Python SDK -sidebarTitle: FormatJSONObjectConfig -description: FormatJSONObjectConfig method reference -seoTitle: FormatJSONObjectConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formatjsonobjectconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONObjectConfig | OpenRouter Python SDK -'og:description': >- - FormatJSONObjectConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONObjectConfig%20-%20Python%20SDK&description=FormatJSONObjectConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON object response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.FormatJSONObjectConfigType](/client-sdks/python/api-reference/components/formatjsonobjectconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatjsonobjectconfigtype.mdx b/client-sdks/python/api-reference/components/formatjsonobjectconfigtype.mdx deleted file mode 100644 index 1a974ebb..00000000 --- a/client-sdks/python/api-reference/components/formatjsonobjectconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FormatJSONObjectConfigType - Python SDK -sidebarTitle: FormatJSONObjectConfigType -description: FormatJSONObjectConfigType method reference -seoTitle: FormatJSONObjectConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formatjsonobjectconfigtype -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONObjectConfigType | OpenRouter Python SDK -'og:description': >- - FormatJSONObjectConfigType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONObjectConfigType%20-%20Python%20SDK&description=FormatJSONObjectConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_OBJECT` | json_object | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatjsonschemaconfig.mdx b/client-sdks/python/api-reference/components/formatjsonschemaconfig.mdx deleted file mode 100644 index d774d576..00000000 --- a/client-sdks/python/api-reference/components/formatjsonschemaconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FormatJSONSchemaConfig - Python SDK -sidebarTitle: FormatJSONSchemaConfig -description: FormatJSONSchemaConfig method reference -seoTitle: FormatJSONSchemaConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONSchemaConfig | OpenRouter Python SDK -'og:description': >- - FormatJSONSchemaConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONSchemaConfig%20-%20Python%20SDK&description=FormatJSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON schema constrained response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `schema_` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.FormatJSONSchemaConfigType](/client-sdks/python/api-reference/components/formatjsonschemaconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formatjsonschemaconfigtype.mdx b/client-sdks/python/api-reference/components/formatjsonschemaconfigtype.mdx deleted file mode 100644 index d9513d3c..00000000 --- a/client-sdks/python/api-reference/components/formatjsonschemaconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FormatJSONSchemaConfigType - Python SDK -sidebarTitle: FormatJSONSchemaConfigType -description: FormatJSONSchemaConfigType method reference -seoTitle: FormatJSONSchemaConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formatjsonschemaconfigtype -'og:site_name': OpenRouter Documentation -'og:title': FormatJSONSchemaConfigType | OpenRouter Python SDK -'og:description': >- - FormatJSONSchemaConfigType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJSONSchemaConfigType%20-%20Python%20SDK&description=FormatJSONSchemaConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_SCHEMA` | json_schema | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formats.mdx b/client-sdks/python/api-reference/components/formats.mdx deleted file mode 100644 index 08aac5d7..00000000 --- a/client-sdks/python/api-reference/components/formats.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Formats - Python SDK -sidebarTitle: Formats -description: Formats method reference -seoTitle: Formats | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/formats' -'og:site_name': OpenRouter Documentation -'og:title': Formats | OpenRouter Python SDK -'og:description': >- - Formats method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Formats%20-%20Python%20SDK&description=Formats%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text response format configuration - -## Supported Types - -### `components.FormatTextConfig` - -```python lines -value: components.FormatTextConfig = /* values here */ -``` - -### `components.FormatJSONObjectConfig` - -```python lines -value: components.FormatJSONObjectConfig = /* values here */ -``` - -### `components.FormatJSONSchemaConfig` - -```python lines -value: components.FormatJSONSchemaConfig = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formattext.mdx b/client-sdks/python/api-reference/components/formattext.mdx deleted file mode 100644 index b4a0b66f..00000000 --- a/client-sdks/python/api-reference/components/formattext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FormatText - Python SDK -sidebarTitle: FormatText -description: FormatText method reference -seoTitle: FormatText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/formattext' -'og:site_name': OpenRouter Documentation -'og:title': FormatText | OpenRouter Python SDK -'og:description': >- - FormatText method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatText%20-%20Python%20SDK&description=FormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `type` | [components.FormatTypeText](/client-sdks/python/api-reference/components/formattypetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formattextconfig.mdx b/client-sdks/python/api-reference/components/formattextconfig.mdx deleted file mode 100644 index 2e5bed4f..00000000 --- a/client-sdks/python/api-reference/components/formattextconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FormatTextConfig - Python SDK -sidebarTitle: FormatTextConfig -description: FormatTextConfig method reference -seoTitle: FormatTextConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formattextconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatTextConfig | OpenRouter Python SDK -'og:description': >- - FormatTextConfig method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTextConfig%20-%20Python%20SDK&description=FormatTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Plain text response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [components.FormatTextConfigType](/client-sdks/python/api-reference/components/formattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formattextconfigtype.mdx b/client-sdks/python/api-reference/components/formattextconfigtype.mdx deleted file mode 100644 index 1df55a78..00000000 --- a/client-sdks/python/api-reference/components/formattextconfigtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FormatTextConfigType - Python SDK -sidebarTitle: FormatTextConfigType -description: FormatTextConfigType method reference -seoTitle: FormatTextConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formattextconfigtype -'og:site_name': OpenRouter Documentation -'og:title': FormatTextConfigType | OpenRouter Python SDK -'og:description': >- - FormatTextConfigType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTextConfigType%20-%20Python%20SDK&description=FormatTextConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formattypegrammar.mdx b/client-sdks/python/api-reference/components/formattypegrammar.mdx deleted file mode 100644 index 3425de44..00000000 --- a/client-sdks/python/api-reference/components/formattypegrammar.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FormatTypeGrammar - Python SDK -sidebarTitle: FormatTypeGrammar -description: FormatTypeGrammar method reference -seoTitle: FormatTypeGrammar | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/formattypegrammar -'og:site_name': OpenRouter Documentation -'og:title': FormatTypeGrammar | OpenRouter Python SDK -'og:description': >- - FormatTypeGrammar method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTypeGrammar%20-%20Python%20SDK&description=FormatTypeGrammar%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `GRAMMAR` | grammar | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/formattypetext.mdx b/client-sdks/python/api-reference/components/formattypetext.mdx deleted file mode 100644 index f925560f..00000000 --- a/client-sdks/python/api-reference/components/formattypetext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FormatTypeText - Python SDK -sidebarTitle: FormatTypeText -description: FormatTypeText method reference -seoTitle: FormatTypeText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/formattypetext' -'og:site_name': OpenRouter Documentation -'og:title': FormatTypeText | OpenRouter Python SDK -'og:description': >- - FormatTypeText method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTypeText%20-%20Python%20SDK&description=FormatTypeText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/frameimage.mdx b/client-sdks/python/api-reference/components/frameimage.mdx deleted file mode 100644 index 31ec4092..00000000 --- a/client-sdks/python/api-reference/components/frameimage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FrameImage - Python SDK -sidebarTitle: FrameImage -description: FrameImage method reference -seoTitle: FrameImage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/frameimage' -'og:site_name': OpenRouter Documentation -'og:title': FrameImage | OpenRouter Python SDK -'og:description': >- - FrameImage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImage%20-%20Python%20SDK&description=FrameImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `image_url` | [components.FrameImageImageURL](/client-sdks/python/api-reference/components/frameimageimageurl) | :heavy_check_mark: | N/A | | -| `type` | [components.FrameImageType](/client-sdks/python/api-reference/components/frameimagetype) | :heavy_check_mark: | N/A | | -| `frame_type` | [components.FrameType](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/frameimageimageurl.mdx b/client-sdks/python/api-reference/components/frameimageimageurl.mdx deleted file mode 100644 index 720716e8..00000000 --- a/client-sdks/python/api-reference/components/frameimageimageurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FrameImageImageURL - Python SDK -sidebarTitle: FrameImageImageURL -description: FrameImageImageURL method reference -seoTitle: FrameImageImageURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/frameimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': FrameImageImageURL | OpenRouter Python SDK -'og:description': >- - FrameImageImageURL method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageImageURL%20-%20Python%20SDK&description=FrameImageImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/frameimagetype.mdx b/client-sdks/python/api-reference/components/frameimagetype.mdx deleted file mode 100644 index 010c4b6d..00000000 --- a/client-sdks/python/api-reference/components/frameimagetype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FrameImageType - Python SDK -sidebarTitle: FrameImageType -description: FrameImageType method reference -seoTitle: FrameImageType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/frameimagetype' -'og:site_name': OpenRouter Documentation -'og:title': FrameImageType | OpenRouter Python SDK -'og:description': >- - FrameImageType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageType%20-%20Python%20SDK&description=FrameImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `IMAGE_URL` | image_url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/frametype.mdx b/client-sdks/python/api-reference/components/frametype.mdx deleted file mode 100644 index 27de73f9..00000000 --- a/client-sdks/python/api-reference/components/frametype.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FrameType - Python SDK -sidebarTitle: FrameType -description: FrameType method reference -seoTitle: FrameType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/frametype' -'og:site_name': OpenRouter Documentation -'og:title': FrameType | OpenRouter Python SDK -'og:description': >- - FrameType method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameType%20-%20Python%20SDK&description=FrameType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Whether this image represents the first or last frame of the video - -## Values - -| Name | Value | -| ------------- | ------------- | -| `FIRST_FRAME` | first_frame | -| `LAST_FRAME` | last_frame | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallargsdeltaevent.mdx b/client-sdks/python/api-reference/components/functioncallargsdeltaevent.mdx deleted file mode 100644 index 5364c088..00000000 --- a/client-sdks/python/api-reference/components/functioncallargsdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FunctionCallArgsDeltaEvent - Python SDK -sidebarTitle: FunctionCallArgsDeltaEvent -description: FunctionCallArgsDeltaEvent method reference -seoTitle: FunctionCallArgsDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallargsdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDeltaEvent | OpenRouter Python SDK -'og:description': >- - FunctionCallArgsDeltaEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDeltaEvent%20-%20Python%20SDK&description=FunctionCallArgsDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments are being streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FunctionCallArgsDeltaEventType](/client-sdks/python/api-reference/components/functioncallargsdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallargsdeltaeventtype.mdx b/client-sdks/python/api-reference/components/functioncallargsdeltaeventtype.mdx deleted file mode 100644 index 5b551cb9..00000000 --- a/client-sdks/python/api-reference/components/functioncallargsdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FunctionCallArgsDeltaEventType - Python SDK -sidebarTitle: FunctionCallArgsDeltaEventType -description: FunctionCallArgsDeltaEventType method reference -seoTitle: FunctionCallArgsDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallargsdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDeltaEventType | OpenRouter Python SDK -'og:description': >- - FunctionCallArgsDeltaEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDeltaEventType%20-%20Python%20SDK&description=FunctionCallArgsDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA` | response.function_call_arguments.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallargsdoneevent.mdx b/client-sdks/python/api-reference/components/functioncallargsdoneevent.mdx deleted file mode 100644 index dc75862b..00000000 --- a/client-sdks/python/api-reference/components/functioncallargsdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FunctionCallArgsDoneEvent - Python SDK -sidebarTitle: FunctionCallArgsDoneEvent -description: FunctionCallArgsDoneEvent method reference -seoTitle: FunctionCallArgsDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallargsdoneevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDoneEvent | OpenRouter Python SDK -'og:description': >- - FunctionCallArgsDoneEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDoneEvent%20-%20Python%20SDK&description=FunctionCallArgsDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.FunctionCallArgsDoneEventType](/client-sdks/python/api-reference/components/functioncallargsdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallargsdoneeventtype.mdx b/client-sdks/python/api-reference/components/functioncallargsdoneeventtype.mdx deleted file mode 100644 index f6714e26..00000000 --- a/client-sdks/python/api-reference/components/functioncallargsdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FunctionCallArgsDoneEventType - Python SDK -sidebarTitle: FunctionCallArgsDoneEventType -description: FunctionCallArgsDoneEventType method reference -seoTitle: FunctionCallArgsDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallargsdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDoneEventType | OpenRouter Python SDK -'og:description': >- - FunctionCallArgsDoneEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDoneEventType%20-%20Python%20SDK&description=FunctionCallArgsDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE` | response.function_call_arguments.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallitem.mdx b/client-sdks/python/api-reference/components/functioncallitem.mdx deleted file mode 100644 index 2325608a..00000000 --- a/client-sdks/python/api-reference/components/functioncallitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FunctionCallItem - Python SDK -sidebarTitle: FunctionCallItem -description: FunctionCallItem method reference -seoTitle: FunctionCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallitem -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItem | OpenRouter Python SDK -'og:description': >- - FunctionCallItem method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItem%20-%20Python%20SDK&description=FunctionCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A function call initiated by the model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.FunctionCallItemType](/client-sdks/python/api-reference/components/functioncallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncallitemtype.mdx b/client-sdks/python/api-reference/components/functioncallitemtype.mdx deleted file mode 100644 index 8063f3aa..00000000 --- a/client-sdks/python/api-reference/components/functioncallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FunctionCallItemType - Python SDK -sidebarTitle: FunctionCallItemType -description: FunctionCallItemType method reference -seoTitle: FunctionCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncallitemtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItemType | OpenRouter Python SDK -'og:description': >- - FunctionCallItemType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItemType%20-%20Python%20SDK&description=FunctionCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitem.mdx b/client-sdks/python/api-reference/components/functioncalloutputitem.mdx deleted file mode 100644 index 26b7b88d..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: FunctionCallOutputItem - Python SDK -sidebarTitle: FunctionCallOutputItem -description: FunctionCallOutputItem method reference -seoTitle: FunctionCallOutputItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItem | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItem%20-%20Python%20SDK&description=FunctionCallOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The output from a function call execution - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `output` | [components.FunctionCallOutputItemOutputUnion2](/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion2) | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.FunctionCallOutputItemStatus]](../components/functioncalloutputitemstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](/client-sdks/python/api-reference/components/functioncalloutputitemtypefunctioncalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemdetail.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemdetail.mdx deleted file mode 100644 index e03c316d..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemdetail.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FunctionCallOutputItemDetail - Python SDK -sidebarTitle: FunctionCallOutputItemDetail -description: FunctionCallOutputItemDetail method reference -seoTitle: FunctionCallOutputItemDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemDetail | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemDetail method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemDetail%20-%20Python%20SDK&description=FunctionCallOutputItemDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | -| `ORIGINAL` | original | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemoutputinputimage.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemoutputinputimage.mdx deleted file mode 100644 index 0a89e3ab..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: FunctionCallOutputItemOutputInputImage - Python SDK -sidebarTitle: FunctionCallOutputItemOutputInputImage -description: FunctionCallOutputItemOutputInputImage method reference -seoTitle: FunctionCallOutputItemOutputInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputInputImage | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemOutputInputImage method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputInputImage%20-%20Python%20SDK&description=FunctionCallOutputItemOutputInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `detail` | [components.FunctionCallOutputItemDetail](/client-sdks/python/api-reference/components/functioncalloutputitemdetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.FunctionCallOutputItemOutputType](/client-sdks/python/api-reference/components/functioncalloutputitemoutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemoutputtype.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemoutputtype.mdx deleted file mode 100644 index 8ca422f8..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemoutputtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FunctionCallOutputItemOutputType - Python SDK -sidebarTitle: FunctionCallOutputItemOutputType -description: FunctionCallOutputItemOutputType method reference -seoTitle: FunctionCallOutputItemOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemoutputtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputType | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemOutputType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputType%20-%20Python%20SDK&description=FunctionCallOutputItemOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion1.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion1.mdx deleted file mode 100644 index 0590bd07..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion1 - Python SDK -sidebarTitle: FunctionCallOutputItemOutputUnion1 -description: FunctionCallOutputItemOutputUnion1 method reference -seoTitle: FunctionCallOutputItemOutputUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion1 | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemOutputUnion1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion1%20-%20Python%20SDK&description=FunctionCallOutputItemOutputUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` - -### `components.FunctionCallOutputItemOutputInputImage` - -```python lines -value: components.FunctionCallOutputItemOutputInputImage = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion2.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion2.mdx deleted file mode 100644 index 25e20a5b..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion2 - Python SDK -sidebarTitle: FunctionCallOutputItemOutputUnion2 -description: FunctionCallOutputItemOutputUnion2 method reference -seoTitle: FunctionCallOutputItemOutputUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion2 | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemOutputUnion2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion2%20-%20Python%20SDK&description=FunctionCallOutputItemOutputUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.FunctionCallOutputItemOutputUnion1]` - -```python lines -value: List[components.FunctionCallOutputItemOutputUnion1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemstatus.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemstatus.mdx deleted file mode 100644 index e18f1541..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: FunctionCallOutputItemStatus - Python SDK -sidebarTitle: FunctionCallOutputItemStatus -description: FunctionCallOutputItemStatus method reference -seoTitle: FunctionCallOutputItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemStatus | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemStatus%20-%20Python%20SDK&description=FunctionCallOutputItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/functioncalloutputitemtypefunctioncalloutput.mdx b/client-sdks/python/api-reference/components/functioncalloutputitemtypefunctioncalloutput.mdx deleted file mode 100644 index 8b12171d..00000000 --- a/client-sdks/python/api-reference/components/functioncalloutputitemtypefunctioncalloutput.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FunctionCallOutputItemTypeFunctionCallOutput - Python SDK -sidebarTitle: FunctionCallOutputItemTypeFunctionCallOutput -description: FunctionCallOutputItemTypeFunctionCallOutput method reference -seoTitle: FunctionCallOutputItemTypeFunctionCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/functioncalloutputitemtypefunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemTypeFunctionCallOutput | OpenRouter Python SDK -'og:description': >- - FunctionCallOutputItemTypeFunctionCallOutput method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemTypeFunctionCallOutput%20-%20Python%20SDK&description=FunctionCallOutputItemTypeFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FUNCTION_CALL_OUTPUT` | function_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionplugin.mdx b/client-sdks/python/api-reference/components/fusionplugin.mdx deleted file mode 100644 index f15d0f58..00000000 --- a/client-sdks/python/api-reference/components/fusionplugin.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionPlugin - Python SDK -sidebarTitle: FusionPlugin -description: FusionPlugin method reference -seoTitle: FusionPlugin | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/fusionplugin' -'og:site_name': OpenRouter Documentation -'og:title': FusionPlugin | OpenRouter Python SDK -'og:description': >- - FusionPlugin method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionPlugin%20-%20Python%20SDK&description=FusionPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis_models` | List[*str*] | :heavy_minus_sign: | Slugs of models to run in parallel as the "expert panel" the judge 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` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the fusion plugin for this request. Defaults to true. | | -| `id` | [components.FusionPluginID](/client-sdks/python/api-reference/components/fusionpluginid) | :heavy_check_mark: | N/A | | -| `max_tool_calls` | *Optional[int]* | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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` | *Optional[str]* | :heavy_minus_sign: | Slug of the model that performs both the judge 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 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionpluginid.mdx b/client-sdks/python/api-reference/components/fusionpluginid.mdx deleted file mode 100644 index de12d769..00000000 --- a/client-sdks/python/api-reference/components/fusionpluginid.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: FusionPluginID - Python SDK -sidebarTitle: FusionPluginID -description: FusionPluginID method reference -seoTitle: FusionPluginID | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/fusionpluginid' -'og:site_name': OpenRouter Documentation -'og:title': FusionPluginID | OpenRouter Python SDK -'og:description': >- - FusionPluginID method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionPluginID%20-%20Python%20SDK&description=FusionPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `FUSION` | fusion | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionservertoolconfig.mdx b/client-sdks/python/api-reference/components/fusionservertoolconfig.mdx deleted file mode 100644 index 28a2a80d..00000000 --- a/client-sdks/python/api-reference/components/fusionservertoolconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FusionServerToolConfig - Python SDK -sidebarTitle: FusionServerToolConfig -description: FusionServerToolConfig method reference -seoTitle: FusionServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fusionservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfig | OpenRouter Python SDK -'og:description': >- - FusionServerToolConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfig%20-%20Python%20SDK&description=FusionServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:fusion server tool. - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis_models` | List[*str*] | :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 a judge 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"
] | -| `max_completion_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the judge 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, the provider's default applies. | 16384 | -| `max_tool_calls` | *Optional[int]* | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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` | *Optional[str]* | :heavy_minus_sign: | Slug of the judge model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `reasoning` | [Optional[components.FusionServerToolConfigReasoning]](../components/fusionservertoolconfigreasoning.md) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature forwarded to panelist and judge inner calls. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionservertoolconfigeffort.mdx b/client-sdks/python/api-reference/components/fusionservertoolconfigeffort.mdx deleted file mode 100644 index 837220e8..00000000 --- a/client-sdks/python/api-reference/components/fusionservertoolconfigeffort.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FusionServerToolConfigEffort - Python SDK -sidebarTitle: FusionServerToolConfigEffort -description: FusionServerToolConfigEffort method reference -seoTitle: FusionServerToolConfigEffort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fusionservertoolconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigEffort | OpenRouter Python SDK -'og:description': >- - FusionServerToolConfigEffort method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigEffort%20-%20Python%20SDK&description=FusionServerToolConfigEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning effort level for panelist and judge inner calls. - -## Values - -| Name | Value | -| --------- | --------- | -| `XHIGH` | xhigh | -| `HIGH` | high | -| `MEDIUM` | medium | -| `LOW` | low | -| `MINIMAL` | minimal | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionservertoolconfigreasoning.mdx b/client-sdks/python/api-reference/components/fusionservertoolconfigreasoning.mdx deleted file mode 100644 index 19a6a0e7..00000000 --- a/client-sdks/python/api-reference/components/fusionservertoolconfigreasoning.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionServerToolConfigReasoning - Python SDK -sidebarTitle: FusionServerToolConfigReasoning -description: FusionServerToolConfigReasoning method reference -seoTitle: FusionServerToolConfigReasoning | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fusionservertoolconfigreasoning -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigReasoning | OpenRouter Python SDK -'og:description': >- - FusionServerToolConfigReasoning method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigReasoning%20-%20Python%20SDK&description=FusionServerToolConfigReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [Optional[components.FusionServerToolConfigEffort]](../components/fusionservertoolconfigeffort.md) | :heavy_minus_sign: | Reasoning effort level for panelist and judge inner calls. | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and judge 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/client-sdks/python/api-reference/components/fusionservertoolopenrouter.mdx b/client-sdks/python/api-reference/components/fusionservertoolopenrouter.mdx deleted file mode 100644 index 1508e49b..00000000 --- a/client-sdks/python/api-reference/components/fusionservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: FusionServerToolOpenRouter - Python SDK -sidebarTitle: FusionServerToolOpenRouter -description: FusionServerToolOpenRouter method reference -seoTitle: FusionServerToolOpenRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fusionservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolOpenRouter | OpenRouter Python SDK -'og:description': >- - FusionServerToolOpenRouter method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolOpenRouter%20-%20Python%20SDK&description=FusionServerToolOpenRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fans out the user prompt to a panel of analysis models, then asks a judge model to summarize their collective output as structured JSON the outer model can synthesize from. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.FusionServerToolConfig]](../components/fusionservertoolconfig.md) | :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](/client-sdks/python/api-reference/components/fusionservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/fusionservertoolopenroutertype.mdx b/client-sdks/python/api-reference/components/fusionservertoolopenroutertype.mdx deleted file mode 100644 index 48349bb2..00000000 --- a/client-sdks/python/api-reference/components/fusionservertoolopenroutertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FusionServerToolOpenRouterType - Python SDK -sidebarTitle: FusionServerToolOpenRouterType -description: FusionServerToolOpenRouterType method reference -seoTitle: FusionServerToolOpenRouterType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/fusionservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolOpenRouterType | OpenRouter Python SDK -'og:description': >- - FusionServerToolOpenRouterType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolOpenRouterType%20-%20Python%20SDK&description=FusionServerToolOpenRouterType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `OPENROUTER_FUSION` | openrouter:fusion | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/generationcontentdata.mdx b/client-sdks/python/api-reference/components/generationcontentdata.mdx deleted file mode 100644 index d5d5f9a7..00000000 --- a/client-sdks/python/api-reference/components/generationcontentdata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GenerationContentData - Python SDK -sidebarTitle: GenerationContentData -description: GenerationContentData method reference -seoTitle: GenerationContentData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/generationcontentdata -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentData | OpenRouter Python SDK -'og:description': >- - GenerationContentData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentData%20-%20Python%20SDK&description=GenerationContentData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `input` | [components.InputUnion](/client-sdks/python/api-reference/components/inputunion) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | -| `output` | [components.GenerationContentDataOutput](/client-sdks/python/api-reference/components/generationcontentdataoutput) | :heavy_check_mark: | The output from the generation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/generationcontentdataoutput.mdx b/client-sdks/python/api-reference/components/generationcontentdataoutput.mdx deleted file mode 100644 index 19ba8226..00000000 --- a/client-sdks/python/api-reference/components/generationcontentdataoutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GenerationContentDataOutput - Python SDK -sidebarTitle: GenerationContentDataOutput -description: GenerationContentDataOutput method reference -seoTitle: GenerationContentDataOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/generationcontentdataoutput -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentDataOutput | OpenRouter Python SDK -'og:description': >- - GenerationContentDataOutput method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentDataOutput%20-%20Python%20SDK&description=GenerationContentDataOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The output from the generation - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `completion` | *Nullable[str]* | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `reasoning` | *Nullable[str]* | :heavy_check_mark: | Reasoning/thinking output, if any | `` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/generationcontentresponse.mdx b/client-sdks/python/api-reference/components/generationcontentresponse.mdx deleted file mode 100644 index 8aff3847..00000000 --- a/client-sdks/python/api-reference/components/generationcontentresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GenerationContentResponse - Python SDK -sidebarTitle: GenerationContentResponse -description: GenerationContentResponse method reference -seoTitle: GenerationContentResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/generationcontentresponse -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentResponse | OpenRouter Python SDK -'og:description': >- - GenerationContentResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentResponse%20-%20Python%20SDK&description=GenerationContentResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content for a generation - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.GenerationContentData](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/generationresponse.mdx b/client-sdks/python/api-reference/components/generationresponse.mdx deleted file mode 100644 index a2bcab72..00000000 --- a/client-sdks/python/api-reference/components/generationresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GenerationResponse - Python SDK -sidebarTitle: GenerationResponse -description: GenerationResponse method reference -seoTitle: GenerationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/generationresponse -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponse | OpenRouter Python SDK -'og:description': >- - GenerationResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponse%20-%20Python%20SDK&description=GenerationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Generation response - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [components.GenerationResponseData](/client-sdks/python/api-reference/components/generationresponsedata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/generationresponsedata.mdx b/client-sdks/python/api-reference/components/generationresponsedata.mdx deleted file mode 100644 index 3f3b3435..00000000 --- a/client-sdks/python/api-reference/components/generationresponsedata.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: GenerationResponseData - Python SDK -sidebarTitle: GenerationResponseData -description: GenerationResponseData method reference -seoTitle: GenerationResponseData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/generationresponsedata -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponseData | OpenRouter Python SDK -'og:description': >- - GenerationResponseData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponseData%20-%20Python%20SDK&description=GenerationResponseData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Generation data - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `api_type` | [Nullable[components.APIType]](../components/apitype.md) | :heavy_check_mark: | Type of API used for the generation | | -| `app_id` | *Nullable[int]* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `cache_discount` | *Nullable[float]* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `cancelled` | *Nullable[bool]* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | External user identifier | user-123 | -| `finish_reason` | *Nullable[str]* | :heavy_check_mark: | Reason the generation finished | stop | -| `generation_time` | *Nullable[float]* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `http_referer` | *Nullable[str]* | :heavy_check_mark: | Referer header from the request | | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `is_byok` | *bool* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `latency` | *Nullable[float]* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `model` | *str* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `moderation_latency` | *Nullable[float]* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `native_tokens_cached` | *Nullable[int]* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `native_tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `native_tokens_completion_images` | *Nullable[int]* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `native_tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `native_tokens_reasoning` | *Nullable[int]* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `num_fetches` | *Nullable[int]* | :heavy_check_mark: | Number of web fetches performed | 0 | -| `num_input_audio_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `num_media_completion` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `num_media_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `num_search_results` | *Nullable[int]* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *str* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `preset_id` | *Nullable[str]* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `provider_responses` | List[[components.ProviderResponse](/client-sdks/python/api-reference/components/providerresponse)] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | -| `request_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `response_cache_source_id` | *OptionalNullable[str]* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `router` | *Nullable[str]* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `service_tier` | *Nullable[str]* | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `session_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `streamed` | *Nullable[bool]* | :heavy_check_mark: | Whether the response was streamed | true | -| `tokens_completion` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `tokens_prompt` | *Nullable[int]* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `total_cost` | *float* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `upstream_id` | *Nullable[str]* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `upstream_inference_cost` | *Nullable[float]* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `usage` | *float* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `user_agent` | *Nullable[str]* | :heavy_check_mark: | User-Agent header from the request | | -| `web_search_engine` | *Nullable[str]* | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/getbyokkeyresponse.mdx b/client-sdks/python/api-reference/components/getbyokkeyresponse.mdx deleted file mode 100644 index 04bcaa93..00000000 --- a/client-sdks/python/api-reference/components/getbyokkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetBYOKKeyResponse - Python SDK -sidebarTitle: GetBYOKKeyResponse -description: GetBYOKKeyResponse method reference -seoTitle: GetBYOKKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/getbyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyResponse | OpenRouter Python SDK -'og:description': >- - GetBYOKKeyResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyResponse%20-%20Python%20SDK&description=GetBYOKKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.BYOKKey](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/getguardrailresponse.mdx b/client-sdks/python/api-reference/components/getguardrailresponse.mdx deleted file mode 100644 index c3bc00be..00000000 --- a/client-sdks/python/api-reference/components/getguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetGuardrailResponse - Python SDK -sidebarTitle: GetGuardrailResponse -description: GetGuardrailResponse method reference -seoTitle: GetGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/getguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResponse | OpenRouter Python SDK -'og:description': >- - GetGuardrailResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResponse%20-%20Python%20SDK&description=GetGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](/client-sdks/python/api-reference/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/python/api-reference/components/getobservabilitydestinationresponse.mdx b/client-sdks/python/api-reference/components/getobservabilitydestinationresponse.mdx deleted file mode 100644 index d41279d8..00000000 --- a/client-sdks/python/api-reference/components/getobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetObservabilityDestinationResponse - Python SDK -sidebarTitle: GetObservabilityDestinationResponse -description: GetObservabilityDestinationResponse method reference -seoTitle: GetObservabilityDestinationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/getobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationResponse | OpenRouter Python SDK -'og:description': >- - GetObservabilityDestinationResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationResponse%20-%20Python%20SDK&description=GetObservabilityDestinationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/getworkspaceresponse.mdx b/client-sdks/python/api-reference/components/getworkspaceresponse.mdx deleted file mode 100644 index c763d04d..00000000 --- a/client-sdks/python/api-reference/components/getworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetWorkspaceResponse - Python SDK -sidebarTitle: GetWorkspaceResponse -description: GetWorkspaceResponse method reference -seoTitle: GetWorkspaceResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/getworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceResponse | OpenRouter Python SDK -'og:description': >- - GetWorkspaceResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceResponse%20-%20Python%20SDK&description=GetWorkspaceResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](/client-sdks/python/api-reference/components/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/python/api-reference/components/group.mdx b/client-sdks/python/api-reference/components/group.mdx deleted file mode 100644 index 708b621d..00000000 --- a/client-sdks/python/api-reference/components/group.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Group - Python SDK -sidebarTitle: Group -description: Group method reference -seoTitle: Group | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/group' -'og:site_name': OpenRouter Documentation -'og:title': Group | OpenRouter Python SDK -'og:description': >- - Group method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Group%20-%20Python%20SDK&description=Group%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `logic` | [Optional[components.Logic]](../components/logic.md) | :heavy_minus_sign: | N/A | -| `rules` | List[[components.Rule](/client-sdks/python/api-reference/components/rule)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/guardrail.mdx b/client-sdks/python/api-reference/components/guardrail.mdx deleted file mode 100644 index 63257918..00000000 --- a/client-sdks/python/api-reference/components/guardrail.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Guardrail - Python SDK -sidebarTitle: Guardrail -description: Guardrail method reference -seoTitle: Guardrail | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/guardrail' -'og:site_name': OpenRouter Documentation -'og:title': Guardrail | OpenRouter Python SDK -'og:description': >- - Guardrail method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrail%20-%20Python%20SDK&description=Guardrail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntry](/client-sdks/python/api-reference/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"}`
] | -| `content_filters` | List[[components.ContentFilterEntry](/client-sdks/python/api-reference/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"
\}
] | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| ~~`enforce_zdr`~~ | *OptionalNullable[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this guardrail belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/guardrailinterval.mdx b/client-sdks/python/api-reference/components/guardrailinterval.mdx deleted file mode 100644 index abfea07c..00000000 --- a/client-sdks/python/api-reference/components/guardrailinterval.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: GuardrailInterval - Python SDK -sidebarTitle: GuardrailInterval -description: GuardrailInterval method reference -seoTitle: GuardrailInterval | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/guardrailinterval -'og:site_name': OpenRouter Documentation -'og:title': GuardrailInterval | OpenRouter Python SDK -'og:description': >- - GuardrailInterval method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GuardrailInterval%20-%20Python%20SDK&description=GuardrailInterval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/ignore.mdx b/client-sdks/python/api-reference/components/ignore.mdx deleted file mode 100644 index 2eb73c2e..00000000 --- a/client-sdks/python/api-reference/components/ignore.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Ignore - Python SDK -sidebarTitle: Ignore -description: Ignore method reference -seoTitle: Ignore | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/ignore' -'og:site_name': OpenRouter Documentation -'og:title': Ignore | OpenRouter Python SDK -'og:description': >- - Ignore method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ignore%20-%20Python%20SDK&description=Ignore%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imageconfig.mdx b/client-sdks/python/api-reference/components/imageconfig.mdx deleted file mode 100644 index 06789bcb..00000000 --- a/client-sdks/python/api-reference/components/imageconfig.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ImageConfig - Python SDK -sidebarTitle: ImageConfig -description: ImageConfig method reference -seoTitle: ImageConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/imageconfig' -'og:site_name': OpenRouter Documentation -'og:title': ImageConfig | OpenRouter Python SDK -'og:description': >- - ImageConfig method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageConfig%20-%20Python%20SDK&description=ImageConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `List[Nullable[Any]]` - -```python lines -value: List[Nullable[Any]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallcompletedevent.mdx b/client-sdks/python/api-reference/components/imagegencallcompletedevent.mdx deleted file mode 100644 index 58174cb3..00000000 --- a/client-sdks/python/api-reference/components/imagegencallcompletedevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallCompletedEvent - Python SDK -sidebarTitle: ImageGenCallCompletedEvent -description: ImageGenCallCompletedEvent method reference -seoTitle: ImageGenCallCompletedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallCompletedEvent | OpenRouter Python SDK -'og:description': >- - ImageGenCallCompletedEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallCompletedEvent%20-%20Python%20SDK&description=ImageGenCallCompletedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call completed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallCompletedEventType](/client-sdks/python/api-reference/components/imagegencallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallcompletedeventtype.mdx b/client-sdks/python/api-reference/components/imagegencallcompletedeventtype.mdx deleted file mode 100644 index 1250b2f6..00000000 --- a/client-sdks/python/api-reference/components/imagegencallcompletedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenCallCompletedEventType - Python SDK -sidebarTitle: ImageGenCallCompletedEventType -description: ImageGenCallCompletedEventType method reference -seoTitle: ImageGenCallCompletedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallcompletedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallCompletedEventType | OpenRouter Python SDK -'og:description': >- - ImageGenCallCompletedEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallCompletedEventType%20-%20Python%20SDK&description=ImageGenCallCompletedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `RESPONSE_IMAGE_GENERATION_CALL_COMPLETED` | response.image_generation_call.completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallgeneratingevent.mdx b/client-sdks/python/api-reference/components/imagegencallgeneratingevent.mdx deleted file mode 100644 index e3d67d36..00000000 --- a/client-sdks/python/api-reference/components/imagegencallgeneratingevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallGeneratingEvent - Python SDK -sidebarTitle: ImageGenCallGeneratingEvent -description: ImageGenCallGeneratingEvent method reference -seoTitle: ImageGenCallGeneratingEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallgeneratingevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallGeneratingEvent | OpenRouter Python SDK -'og:description': >- - ImageGenCallGeneratingEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallGeneratingEvent%20-%20Python%20SDK&description=ImageGenCallGeneratingEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call is generating - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallGeneratingEventType](/client-sdks/python/api-reference/components/imagegencallgeneratingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallgeneratingeventtype.mdx b/client-sdks/python/api-reference/components/imagegencallgeneratingeventtype.mdx deleted file mode 100644 index eedc555c..00000000 --- a/client-sdks/python/api-reference/components/imagegencallgeneratingeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenCallGeneratingEventType - Python SDK -sidebarTitle: ImageGenCallGeneratingEventType -description: ImageGenCallGeneratingEventType method reference -seoTitle: ImageGenCallGeneratingEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallgeneratingeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallGeneratingEventType | OpenRouter Python SDK -'og:description': >- - ImageGenCallGeneratingEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallGeneratingEventType%20-%20Python%20SDK&description=ImageGenCallGeneratingEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_GENERATING` | response.image_generation_call.generating | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallinprogressevent.mdx b/client-sdks/python/api-reference/components/imagegencallinprogressevent.mdx deleted file mode 100644 index 0993c460..00000000 --- a/client-sdks/python/api-reference/components/imagegencallinprogressevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ImageGenCallInProgressEvent - Python SDK -sidebarTitle: ImageGenCallInProgressEvent -description: ImageGenCallInProgressEvent method reference -seoTitle: ImageGenCallInProgressEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallInProgressEvent | OpenRouter Python SDK -'og:description': >- - ImageGenCallInProgressEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallInProgressEvent%20-%20Python%20SDK&description=ImageGenCallInProgressEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call in progress - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallInProgressEventType](/client-sdks/python/api-reference/components/imagegencallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallinprogresseventtype.mdx b/client-sdks/python/api-reference/components/imagegencallinprogresseventtype.mdx deleted file mode 100644 index 6cd3b3cd..00000000 --- a/client-sdks/python/api-reference/components/imagegencallinprogresseventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenCallInProgressEventType - Python SDK -sidebarTitle: ImageGenCallInProgressEventType -description: ImageGenCallInProgressEventType method reference -seoTitle: ImageGenCallInProgressEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallInProgressEventType | OpenRouter Python SDK -'og:description': >- - ImageGenCallInProgressEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallInProgressEventType%20-%20Python%20SDK&description=ImageGenCallInProgressEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_IN_PROGRESS` | response.image_generation_call.in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallpartialimageevent.mdx b/client-sdks/python/api-reference/components/imagegencallpartialimageevent.mdx deleted file mode 100644 index 842cac33..00000000 --- a/client-sdks/python/api-reference/components/imagegencallpartialimageevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ImageGenCallPartialImageEvent - Python SDK -sidebarTitle: ImageGenCallPartialImageEvent -description: ImageGenCallPartialImageEvent method reference -seoTitle: ImageGenCallPartialImageEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallpartialimageevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallPartialImageEvent | OpenRouter Python SDK -'og:description': >- - ImageGenCallPartialImageEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallPartialImageEvent%20-%20Python%20SDK&description=ImageGenCallPartialImageEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call with partial image - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `partial_image_b64` | *str* | :heavy_check_mark: | N/A | -| `partial_image_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ImageGenCallPartialImageEventType](/client-sdks/python/api-reference/components/imagegencallpartialimageeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegencallpartialimageeventtype.mdx b/client-sdks/python/api-reference/components/imagegencallpartialimageeventtype.mdx deleted file mode 100644 index 6371f0b4..00000000 --- a/client-sdks/python/api-reference/components/imagegencallpartialimageeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenCallPartialImageEventType - Python SDK -sidebarTitle: ImageGenCallPartialImageEventType -description: ImageGenCallPartialImageEventType method reference -seoTitle: ImageGenCallPartialImageEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegencallpartialimageeventtype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallPartialImageEventType | OpenRouter Python SDK -'og:description': >- - ImageGenCallPartialImageEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallPartialImageEventType%20-%20Python%20SDK&description=ImageGenCallPartialImageEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_PARTIAL_IMAGE` | response.image_generation_call.partial_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationservertool.mdx b/client-sdks/python/api-reference/components/imagegenerationservertool.mdx deleted file mode 100644 index 3a9b6708..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ImageGenerationServerTool - Python SDK -sidebarTitle: ImageGenerationServerTool -description: ImageGenerationServerTool method reference -seoTitle: ImageGenerationServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertool -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerTool | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerTool%20-%20Python%20SDK&description=ImageGenerationServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `background` | [Optional[components.Background]](../components/background.md) | :heavy_minus_sign: | N/A | -| `input_fidelity` | [OptionalNullable[components.InputFidelity]](../components/inputfidelity.md) | :heavy_minus_sign: | N/A | -| `input_image_mask` | [Optional[components.InputImageMask]](../components/inputimagemask.md) | :heavy_minus_sign: | N/A | -| `model` | [Optional[components.ModelEnum]](../components/modelenum.md) | :heavy_minus_sign: | N/A | -| `moderation` | [Optional[components.Moderation]](../components/moderation.md) | :heavy_minus_sign: | N/A | -| `output_compression` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `output_format` | [Optional[components.OutputFormat]](../components/outputformat.md) | :heavy_minus_sign: | N/A | -| `partial_images` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `quality` | [Optional[components.Quality]](../components/quality.md) | :heavy_minus_sign: | N/A | -| `size` | [Optional[components.Size]](../components/size.md) | :heavy_minus_sign: | N/A | -| `type` | [components.ImageGenerationServerToolType](/client-sdks/python/api-reference/components/imagegenerationservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationservertoolconfig.mdx b/client-sdks/python/api-reference/components/imagegenerationservertoolconfig.mdx deleted file mode 100644 index 80a63c2d..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertoolconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ImageGenerationServerToolConfig - Python SDK -sidebarTitle: ImageGenerationServerToolConfig -description: ImageGenerationServerToolConfig method reference -seoTitle: ImageGenerationServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfig | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerToolConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfig%20-%20Python%20SDK&description=ImageGenerationServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `model` | *Optional[str]* | :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 | -| `__pydantic_extra__` | Dict[str, [components.ImageGenerationServerToolConfigUnion](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/imagegenerationservertoolconfigunion.mdx b/client-sdks/python/api-reference/components/imagegenerationservertoolconfigunion.mdx deleted file mode 100644 index 6189c7e5..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertoolconfigunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ImageGenerationServerToolConfigUnion - Python SDK -sidebarTitle: ImageGenerationServerToolConfigUnion -description: ImageGenerationServerToolConfigUnion method reference -seoTitle: ImageGenerationServerToolConfigUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertoolconfigunion -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfigUnion | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerToolConfigUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfigUnion%20-%20Python%20SDK&description=ImageGenerationServerToolConfigUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `List[Nullable[Any]]` - -```python lines -value: List[Nullable[Any]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationservertoolopenrouter.mdx b/client-sdks/python/api-reference/components/imagegenerationservertoolopenrouter.mdx deleted file mode 100644 index 5da9bce5..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouter - Python SDK -sidebarTitle: ImageGenerationServerToolOpenRouter -description: ImageGenerationServerToolOpenRouter method reference -seoTitle: ImageGenerationServerToolOpenRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouter | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerToolOpenRouter method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouter%20-%20Python%20SDK&description=ImageGenerationServerToolOpenRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: generates images from text prompts using an image generation model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.ImageGenerationServerToolConfig]](../components/imagegenerationservertoolconfig.md) | :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](/client-sdks/python/api-reference/components/imagegenerationservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationservertoolopenroutertype.mdx b/client-sdks/python/api-reference/components/imagegenerationservertoolopenroutertype.mdx deleted file mode 100644 index 7b574c3d..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertoolopenroutertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouterType - Python SDK -sidebarTitle: ImageGenerationServerToolOpenRouterType -description: ImageGenerationServerToolOpenRouterType method reference -seoTitle: ImageGenerationServerToolOpenRouterType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouterType | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerToolOpenRouterType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouterType%20-%20Python%20SDK&description=ImageGenerationServerToolOpenRouterType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `OPENROUTER_IMAGE_GENERATION` | openrouter:image_generation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationservertooltype.mdx b/client-sdks/python/api-reference/components/imagegenerationservertooltype.mdx deleted file mode 100644 index b5548f71..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ImageGenerationServerToolType - Python SDK -sidebarTitle: ImageGenerationServerToolType -description: ImageGenerationServerToolType method reference -seoTitle: ImageGenerationServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolType | OpenRouter Python SDK -'og:description': >- - ImageGenerationServerToolType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolType%20-%20Python%20SDK&description=ImageGenerationServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `IMAGE_GENERATION` | image_generation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/imagegenerationstatus.mdx b/client-sdks/python/api-reference/components/imagegenerationstatus.mdx deleted file mode 100644 index 7ec5cb39..00000000 --- a/client-sdks/python/api-reference/components/imagegenerationstatus.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ImageGenerationStatus - Python SDK -sidebarTitle: ImageGenerationStatus -description: ImageGenerationStatus method reference -seoTitle: ImageGenerationStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/imagegenerationstatus -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationStatus | OpenRouter Python SDK -'og:description': >- - ImageGenerationStatus method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationStatus%20-%20Python%20SDK&description=ImageGenerationStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `GENERATING` | generating | -| `FAILED` | failed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/incompletedetails.mdx b/client-sdks/python/api-reference/components/incompletedetails.mdx deleted file mode 100644 index 69b9cf39..00000000 --- a/client-sdks/python/api-reference/components/incompletedetails.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: IncompleteDetails - Python SDK -sidebarTitle: IncompleteDetails -description: IncompleteDetails method reference -seoTitle: IncompleteDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/incompletedetails -'og:site_name': OpenRouter Documentation -'og:title': IncompleteDetails | OpenRouter Python SDK -'og:description': >- - IncompleteDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IncompleteDetails%20-%20Python%20SDK&description=IncompleteDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `reason` | [Optional[components.Reason]](../components/reason.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/input1.mdx b/client-sdks/python/api-reference/components/input1.mdx deleted file mode 100644 index 8094b145..00000000 --- a/client-sdks/python/api-reference/components/input1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input1 - Python SDK -sidebarTitle: Input1 -description: Input1 method reference -seoTitle: Input1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/input1' -'og:site_name': OpenRouter Documentation -'og:title': Input1 | OpenRouter Python SDK -'og:description': >- - Input1 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input1%20-%20Python%20SDK&description=Input1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `prompt` | *str* | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/input2.mdx b/client-sdks/python/api-reference/components/input2.mdx deleted file mode 100644 index f4da0392..00000000 --- a/client-sdks/python/api-reference/components/input2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input2 - Python SDK -sidebarTitle: Input2 -description: Input2 method reference -seoTitle: Input2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/input2' -'og:site_name': OpenRouter Documentation -'og:title': Input2 | OpenRouter Python SDK -'og:description': >- - Input2 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input2%20-%20Python%20SDK&description=Input2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `messages` | List[*Nullable[Any]*] | :heavy_check_mark: | N/A | [
`{"content": "What is the meaning of life?","role": "user"}`
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputaudio.mdx b/client-sdks/python/api-reference/components/inputaudio.mdx deleted file mode 100644 index 92d73ae9..00000000 --- a/client-sdks/python/api-reference/components/inputaudio.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputAudio - Python SDK -sidebarTitle: InputAudio -description: InputAudio method reference -seoTitle: InputAudio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputaudio' -'og:site_name': OpenRouter Documentation -'og:title': InputAudio | OpenRouter Python SDK -'og:description': >- - InputAudio method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudio%20-%20Python%20SDK&description=InputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Audio input content item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `input_audio` | [components.InputAudioInputAudio](/client-sdks/python/api-reference/components/inputaudioinputaudio) | :heavy_check_mark: | N/A | -| `type` | [components.InputAudioType](/client-sdks/python/api-reference/components/inputaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputaudioinputaudio.mdx b/client-sdks/python/api-reference/components/inputaudioinputaudio.mdx deleted file mode 100644 index b99a3609..00000000 --- a/client-sdks/python/api-reference/components/inputaudioinputaudio.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: InputAudioInputAudio - Python SDK -sidebarTitle: InputAudioInputAudio -description: InputAudioInputAudio method reference -seoTitle: InputAudioInputAudio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': InputAudioInputAudio | OpenRouter Python SDK -'og:description': >- - InputAudioInputAudio method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudioInputAudio%20-%20Python%20SDK&description=InputAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | [components.FormatEnum](/client-sdks/python/api-reference/components/formatenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputaudiotype.mdx b/client-sdks/python/api-reference/components/inputaudiotype.mdx deleted file mode 100644 index caafc2d2..00000000 --- a/client-sdks/python/api-reference/components/inputaudiotype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputAudioType - Python SDK -sidebarTitle: InputAudioType -description: InputAudioType method reference -seoTitle: InputAudioType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputaudiotype' -'og:site_name': OpenRouter Documentation -'og:title': InputAudioType | OpenRouter Python SDK -'og:description': >- - InputAudioType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudioType%20-%20Python%20SDK&description=InputAudioType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_AUDIO` | input_audio | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputfidelity.mdx b/client-sdks/python/api-reference/components/inputfidelity.mdx deleted file mode 100644 index cbb74f3f..00000000 --- a/client-sdks/python/api-reference/components/inputfidelity.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputFidelity - Python SDK -sidebarTitle: InputFidelity -description: InputFidelity method reference -seoTitle: InputFidelity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputfidelity' -'og:site_name': OpenRouter Documentation -'og:title': InputFidelity | OpenRouter Python SDK -'og:description': >- - InputFidelity method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFidelity%20-%20Python%20SDK&description=InputFidelity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `HIGH` | high | -| `LOW` | low | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputfile.mdx b/client-sdks/python/api-reference/components/inputfile.mdx deleted file mode 100644 index a6c97ec1..00000000 --- a/client-sdks/python/api-reference/components/inputfile.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: InputFile - Python SDK -sidebarTitle: InputFile -description: InputFile method reference -seoTitle: InputFile | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputfile' -'og:site_name': OpenRouter Documentation -'og:title': InputFile | OpenRouter Python SDK -'og:description': >- - InputFile method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFile%20-%20Python%20SDK&description=InputFile%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -File input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `file_data` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `file_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputFileType](/client-sdks/python/api-reference/components/inputfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputfiletype.mdx b/client-sdks/python/api-reference/components/inputfiletype.mdx deleted file mode 100644 index 5eb470cc..00000000 --- a/client-sdks/python/api-reference/components/inputfiletype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputFileType - Python SDK -sidebarTitle: InputFileType -description: InputFileType method reference -seoTitle: InputFileType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputfiletype' -'og:site_name': OpenRouter Documentation -'og:title': InputFileType | OpenRouter Python SDK -'og:description': >- - InputFileType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFileType%20-%20Python%20SDK&description=InputFileType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INPUT_FILE` | input_file | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputimage.mdx b/client-sdks/python/api-reference/components/inputimage.mdx deleted file mode 100644 index 2508ae74..00000000 --- a/client-sdks/python/api-reference/components/inputimage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputImage - Python SDK -sidebarTitle: InputImage -description: InputImage method reference -seoTitle: InputImage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputimage' -'og:site_name': OpenRouter Documentation -'og:title': InputImage | OpenRouter Python SDK -'og:description': >- - InputImage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImage%20-%20Python%20SDK&description=InputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `detail` | [components.InputImageDetail](/client-sdks/python/api-reference/components/inputimagedetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputImageType](/client-sdks/python/api-reference/components/inputimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputimagedetail.mdx b/client-sdks/python/api-reference/components/inputimagedetail.mdx deleted file mode 100644 index f73a7fd3..00000000 --- a/client-sdks/python/api-reference/components/inputimagedetail.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputImageDetail - Python SDK -sidebarTitle: InputImageDetail -description: InputImageDetail method reference -seoTitle: InputImageDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputimagedetail -'og:site_name': OpenRouter Documentation -'og:title': InputImageDetail | OpenRouter Python SDK -'og:description': >- - InputImageDetail method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageDetail%20-%20Python%20SDK&description=InputImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | -| `ORIGINAL` | original | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputimagemask.mdx b/client-sdks/python/api-reference/components/inputimagemask.mdx deleted file mode 100644 index 3ff64748..00000000 --- a/client-sdks/python/api-reference/components/inputimagemask.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputImageMask - Python SDK -sidebarTitle: InputImageMask -description: InputImageMask method reference -seoTitle: InputImageMask | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputimagemask' -'og:site_name': OpenRouter Documentation -'og:title': InputImageMask | OpenRouter Python SDK -'og:description': >- - InputImageMask method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageMask%20-%20Python%20SDK&description=InputImageMask%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `file_id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputimagetype.mdx b/client-sdks/python/api-reference/components/inputimagetype.mdx deleted file mode 100644 index af4ce816..00000000 --- a/client-sdks/python/api-reference/components/inputimagetype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputImageType - Python SDK -sidebarTitle: InputImageType -description: InputImageType method reference -seoTitle: InputImageType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputimagetype' -'og:site_name': OpenRouter Documentation -'og:title': InputImageType | OpenRouter Python SDK -'og:description': >- - InputImageType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageType%20-%20Python%20SDK&description=InputImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitem.mdx b/client-sdks/python/api-reference/components/inputmessageitem.mdx deleted file mode 100644 index c24571dc..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputMessageItem - Python SDK -sidebarTitle: InputMessageItem -description: InputMessageItem method reference -seoTitle: InputMessageItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItem | OpenRouter Python SDK -'og:description': >- - InputMessageItem method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItem%20-%20Python%20SDK&description=InputMessageItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | List[[components.InputMessageItemContentUnion](/client-sdks/python/api-reference/components/inputmessageitemcontentunion)] | :heavy_minus_sign: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `role` | [components.InputMessageItemRoleUnion](/client-sdks/python/api-reference/components/inputmessageitemroleunion) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.InputMessageItemTypeMessage]](../components/inputmessageitemtypemessage.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemcontentinputimage.mdx b/client-sdks/python/api-reference/components/inputmessageitemcontentinputimage.mdx deleted file mode 100644 index 19a4da1a..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemcontentinputimage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InputMessageItemContentInputImage - Python SDK -sidebarTitle: InputMessageItemContentInputImage -description: InputMessageItemContentInputImage method reference -seoTitle: InputMessageItemContentInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemcontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentInputImage | OpenRouter Python SDK -'og:description': >- - InputMessageItemContentInputImage method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentInputImage%20-%20Python%20SDK&description=InputMessageItemContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `detail` | [components.InputMessageItemDetail](/client-sdks/python/api-reference/components/inputmessageitemdetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.InputMessageItemTypeInputImage](/client-sdks/python/api-reference/components/inputmessageitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemcontentunion.mdx b/client-sdks/python/api-reference/components/inputmessageitemcontentunion.mdx deleted file mode 100644 index 53782aa6..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemcontentunion.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: InputMessageItemContentUnion - Python SDK -sidebarTitle: InputMessageItemContentUnion -description: InputMessageItemContentUnion method reference -seoTitle: InputMessageItemContentUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemcontentunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentUnion | OpenRouter Python SDK -'og:description': >- - InputMessageItemContentUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentUnion%20-%20Python%20SDK&description=InputMessageItemContentUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` - -### `components.InputMessageItemContentInputImage` - -```python lines -value: components.InputMessageItemContentInputImage = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputAudio` - -```python lines -value: components.InputAudio = /* values here */ -``` - -### `components.InputVideo` - -```python lines -value: components.InputVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemdetail.mdx b/client-sdks/python/api-reference/components/inputmessageitemdetail.mdx deleted file mode 100644 index 2998dcf6..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemdetail.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputMessageItemDetail - Python SDK -sidebarTitle: InputMessageItemDetail -description: InputMessageItemDetail method reference -seoTitle: InputMessageItemDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemdetail -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemDetail | OpenRouter Python SDK -'og:description': >- - InputMessageItemDetail method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemDetail%20-%20Python%20SDK&description=InputMessageItemDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | -| `ORIGINAL` | original | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemroledeveloper.mdx b/client-sdks/python/api-reference/components/inputmessageitemroledeveloper.mdx deleted file mode 100644 index 5ac268f2..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputMessageItemRoleDeveloper - Python SDK -sidebarTitle: InputMessageItemRoleDeveloper -description: InputMessageItemRoleDeveloper method reference -seoTitle: InputMessageItemRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleDeveloper | OpenRouter Python SDK -'og:description': >- - InputMessageItemRoleDeveloper method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleDeveloper%20-%20Python%20SDK&description=InputMessageItemRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemrolesystem.mdx b/client-sdks/python/api-reference/components/inputmessageitemrolesystem.mdx deleted file mode 100644 index 93dad107..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemrolesystem.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputMessageItemRoleSystem - Python SDK -sidebarTitle: InputMessageItemRoleSystem -description: InputMessageItemRoleSystem method reference -seoTitle: InputMessageItemRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleSystem | OpenRouter Python SDK -'og:description': >- - InputMessageItemRoleSystem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleSystem%20-%20Python%20SDK&description=InputMessageItemRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemroleunion.mdx b/client-sdks/python/api-reference/components/inputmessageitemroleunion.mdx deleted file mode 100644 index d2c89e4e..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemroleunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputMessageItemRoleUnion - Python SDK -sidebarTitle: InputMessageItemRoleUnion -description: InputMessageItemRoleUnion method reference -seoTitle: InputMessageItemRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUnion | OpenRouter Python SDK -'og:description': >- - InputMessageItemRoleUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUnion%20-%20Python%20SDK&description=InputMessageItemRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputMessageItemRoleUser` - -```python lines -value: components.InputMessageItemRoleUser = /* values here */ -``` - -### `components.InputMessageItemRoleSystem` - -```python lines -value: components.InputMessageItemRoleSystem = /* values here */ -``` - -### `components.InputMessageItemRoleDeveloper` - -```python lines -value: components.InputMessageItemRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemroleuser.mdx b/client-sdks/python/api-reference/components/inputmessageitemroleuser.mdx deleted file mode 100644 index 77fc8fc6..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemroleuser.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputMessageItemRoleUser - Python SDK -sidebarTitle: InputMessageItemRoleUser -description: InputMessageItemRoleUser method reference -seoTitle: InputMessageItemRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUser | OpenRouter Python SDK -'og:description': >- - InputMessageItemRoleUser method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUser%20-%20Python%20SDK&description=InputMessageItemRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemtypeinputimage.mdx b/client-sdks/python/api-reference/components/inputmessageitemtypeinputimage.mdx deleted file mode 100644 index 7683b80f..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemtypeinputimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputMessageItemTypeInputImage - Python SDK -sidebarTitle: InputMessageItemTypeInputImage -description: InputMessageItemTypeInputImage method reference -seoTitle: InputMessageItemTypeInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemtypeinputimage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemTypeInputImage | OpenRouter Python SDK -'og:description': >- - InputMessageItemTypeInputImage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemTypeInputImage%20-%20Python%20SDK&description=InputMessageItemTypeInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmessageitemtypemessage.mdx b/client-sdks/python/api-reference/components/inputmessageitemtypemessage.mdx deleted file mode 100644 index 3ba036c0..00000000 --- a/client-sdks/python/api-reference/components/inputmessageitemtypemessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputMessageItemTypeMessage - Python SDK -sidebarTitle: InputMessageItemTypeMessage -description: InputMessageItemTypeMessage method reference -seoTitle: InputMessageItemTypeMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputmessageitemtypemessage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemTypeMessage | OpenRouter Python SDK -'og:description': >- - InputMessageItemTypeMessage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemTypeMessage%20-%20Python%20SDK&description=InputMessageItemTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputmodality.mdx b/client-sdks/python/api-reference/components/inputmodality.mdx deleted file mode 100644 index ba3d8aa9..00000000 --- a/client-sdks/python/api-reference/components/inputmodality.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InputModality - Python SDK -sidebarTitle: InputModality -description: InputModality method reference -seoTitle: InputModality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputmodality' -'og:site_name': OpenRouter Documentation -'og:title': InputModality | OpenRouter Python SDK -'og:description': >- - InputModality method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputModality%20-%20Python%20SDK&description=InputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | -| `FILE` | file | -| `AUDIO` | audio | -| `VIDEO` | video | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputschema.mdx b/client-sdks/python/api-reference/components/inputschema.mdx deleted file mode 100644 index 05f70eac..00000000 --- a/client-sdks/python/api-reference/components/inputschema.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputSchema - Python SDK -sidebarTitle: InputSchema -description: InputSchema method reference -seoTitle: InputSchema | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputschema' -'og:site_name': OpenRouter Documentation -'og:title': InputSchema | OpenRouter Python SDK -'og:description': >- - InputSchema method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputSchema%20-%20Python%20SDK&description=InputSchema%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `properties` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | -| `required` | List[*str*] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputscontent1.mdx b/client-sdks/python/api-reference/components/inputscontent1.mdx deleted file mode 100644 index 83203112..00000000 --- a/client-sdks/python/api-reference/components/inputscontent1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: InputsContent1 - Python SDK -sidebarTitle: InputsContent1 -description: InputsContent1 method reference -seoTitle: InputsContent1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputscontent1' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent1 | OpenRouter Python SDK -'og:description': >- - InputsContent1 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent1%20-%20Python%20SDK&description=InputsContent1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputscontent2.mdx b/client-sdks/python/api-reference/components/inputscontent2.mdx deleted file mode 100644 index b6c2e0ec..00000000 --- a/client-sdks/python/api-reference/components/inputscontent2.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputsContent2 - Python SDK -sidebarTitle: InputsContent2 -description: InputsContent2 method reference -seoTitle: InputsContent2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputscontent2' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent2 | OpenRouter Python SDK -'og:description': >- - InputsContent2 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent2%20-%20Python%20SDK&description=InputsContent2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.InputsContent1]` - -```python lines -value: List[components.InputsContent1] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsmessage.mdx b/client-sdks/python/api-reference/components/inputsmessage.mdx deleted file mode 100644 index 14da894d..00000000 --- a/client-sdks/python/api-reference/components/inputsmessage.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: InputsMessage - Python SDK -sidebarTitle: InputsMessage -description: InputsMessage method reference -seoTitle: InputsMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputsmessage' -'og:site_name': OpenRouter Documentation -'og:title': InputsMessage | OpenRouter Python SDK -'og:description': >- - InputsMessage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsMessage%20-%20Python%20SDK&description=InputsMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output message item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [Nullable[components.InputsContent2]](../components/inputscontent2.md) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.InputsPhaseUnion]](../components/inputsphaseunion.md) | :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](/client-sdks/python/api-reference/components/inputsrole) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.InputsStatusUnion1]](../components/inputsstatusunion1.md) | :heavy_minus_sign: | N/A | -| `type` | [components.InputsTypeMessage](/client-sdks/python/api-reference/components/inputstypemessage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsphasecommentary.mdx b/client-sdks/python/api-reference/components/inputsphasecommentary.mdx deleted file mode 100644 index 8f5f17b7..00000000 --- a/client-sdks/python/api-reference/components/inputsphasecommentary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsPhaseCommentary - Python SDK -sidebarTitle: InputsPhaseCommentary -description: InputsPhaseCommentary method reference -seoTitle: InputsPhaseCommentary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseCommentary | OpenRouter Python SDK -'og:description': >- - InputsPhaseCommentary method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseCommentary%20-%20Python%20SDK&description=InputsPhaseCommentary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMMENTARY` | commentary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsphasefinalanswer.mdx b/client-sdks/python/api-reference/components/inputsphasefinalanswer.mdx deleted file mode 100644 index 66ee7720..00000000 --- a/client-sdks/python/api-reference/components/inputsphasefinalanswer.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsPhaseFinalAnswer - Python SDK -sidebarTitle: InputsPhaseFinalAnswer -description: InputsPhaseFinalAnswer method reference -seoTitle: InputsPhaseFinalAnswer | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseFinalAnswer | OpenRouter Python SDK -'og:description': >- - InputsPhaseFinalAnswer method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseFinalAnswer%20-%20Python%20SDK&description=InputsPhaseFinalAnswer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FINAL_ANSWER` | final_answer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsphaseunion.mdx b/client-sdks/python/api-reference/components/inputsphaseunion.mdx deleted file mode 100644 index 4db4d833..00000000 --- a/client-sdks/python/api-reference/components/inputsphaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: InputsPhaseUnion - Python SDK -sidebarTitle: InputsPhaseUnion -description: InputsPhaseUnion method reference -seoTitle: InputsPhaseUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsphaseunion -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseUnion | OpenRouter Python SDK -'og:description': >- - InputsPhaseUnion method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseUnion%20-%20Python%20SDK&description=InputsPhaseUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `components.InputsPhaseCommentary` - -```python lines -value: components.InputsPhaseCommentary = /* values here */ -``` - -### `components.InputsPhaseFinalAnswer` - -```python lines -value: components.InputsPhaseFinalAnswer = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsreasoning.mdx b/client-sdks/python/api-reference/components/inputsreasoning.mdx deleted file mode 100644 index 23e3e260..00000000 --- a/client-sdks/python/api-reference/components/inputsreasoning.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsReasoning - Python SDK -sidebarTitle: InputsReasoning -description: InputsReasoning method reference -seoTitle: InputsReasoning | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsreasoning -'og:site_name': OpenRouter Documentation -'og:title': InputsReasoning | OpenRouter Python SDK -'og:description': >- - InputsReasoning method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsReasoning%20-%20Python%20SDK&description=InputsReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `content` | List[[components.ReasoningTextContent](/client-sdks/python/api-reference/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.InputsStatusUnion2]](../components/inputsstatusunion2.md) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext)] | :heavy_check_mark: | N/A | | -| `type` | [components.InputsTypeReasoning](/client-sdks/python/api-reference/components/inputstypereasoning) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsrole.mdx b/client-sdks/python/api-reference/components/inputsrole.mdx deleted file mode 100644 index f4eb17eb..00000000 --- a/client-sdks/python/api-reference/components/inputsrole.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputsRole - Python SDK -sidebarTitle: InputsRole -description: InputsRole method reference -seoTitle: InputsRole | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputsrole' -'og:site_name': OpenRouter Documentation -'og:title': InputsRole | OpenRouter Python SDK -'og:description': >- - InputsRole method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsRole%20-%20Python%20SDK&description=InputsRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatuscompleted1.mdx b/client-sdks/python/api-reference/components/inputsstatuscompleted1.mdx deleted file mode 100644 index 5187abf0..00000000 --- a/client-sdks/python/api-reference/components/inputsstatuscompleted1.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusCompleted1 - Python SDK -sidebarTitle: InputsStatusCompleted1 -description: InputsStatusCompleted1 method reference -seoTitle: InputsStatusCompleted1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatuscompleted1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted1 | OpenRouter Python SDK -'og:description': >- - InputsStatusCompleted1 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted1%20-%20Python%20SDK&description=InputsStatusCompleted1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatuscompleted2.mdx b/client-sdks/python/api-reference/components/inputsstatuscompleted2.mdx deleted file mode 100644 index 7b542d89..00000000 --- a/client-sdks/python/api-reference/components/inputsstatuscompleted2.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusCompleted2 - Python SDK -sidebarTitle: InputsStatusCompleted2 -description: InputsStatusCompleted2 method reference -seoTitle: InputsStatusCompleted2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatuscompleted2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted2 | OpenRouter Python SDK -'og:description': >- - InputsStatusCompleted2 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted2%20-%20Python%20SDK&description=InputsStatusCompleted2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusincomplete1.mdx b/client-sdks/python/api-reference/components/inputsstatusincomplete1.mdx deleted file mode 100644 index 0970c144..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusincomplete1.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusIncomplete1 - Python SDK -sidebarTitle: InputsStatusIncomplete1 -description: InputsStatusIncomplete1 method reference -seoTitle: InputsStatusIncomplete1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusincomplete1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete1 | OpenRouter Python SDK -'og:description': >- - InputsStatusIncomplete1 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete1%20-%20Python%20SDK&description=InputsStatusIncomplete1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusincomplete2.mdx b/client-sdks/python/api-reference/components/inputsstatusincomplete2.mdx deleted file mode 100644 index b897cccb..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusincomplete2.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusIncomplete2 - Python SDK -sidebarTitle: InputsStatusIncomplete2 -description: InputsStatusIncomplete2 method reference -seoTitle: InputsStatusIncomplete2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusincomplete2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete2 | OpenRouter Python SDK -'og:description': >- - InputsStatusIncomplete2 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete2%20-%20Python%20SDK&description=InputsStatusIncomplete2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusinprogress1.mdx b/client-sdks/python/api-reference/components/inputsstatusinprogress1.mdx deleted file mode 100644 index d59bbf19..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusinprogress1.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusInProgress1 - Python SDK -sidebarTitle: InputsStatusInProgress1 -description: InputsStatusInProgress1 method reference -seoTitle: InputsStatusInProgress1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusinprogress1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress1 | OpenRouter Python SDK -'og:description': >- - InputsStatusInProgress1 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress1%20-%20Python%20SDK&description=InputsStatusInProgress1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusinprogress2.mdx b/client-sdks/python/api-reference/components/inputsstatusinprogress2.mdx deleted file mode 100644 index a13e2a0d..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusinprogress2.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsStatusInProgress2 - Python SDK -sidebarTitle: InputsStatusInProgress2 -description: InputsStatusInProgress2 method reference -seoTitle: InputsStatusInProgress2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusinprogress2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress2 | OpenRouter Python SDK -'og:description': >- - InputsStatusInProgress2 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress2%20-%20Python%20SDK&description=InputsStatusInProgress2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusunion1.mdx b/client-sdks/python/api-reference/components/inputsstatusunion1.mdx deleted file mode 100644 index eae9bb58..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusunion1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputsStatusUnion1 - Python SDK -sidebarTitle: InputsStatusUnion1 -description: InputsStatusUnion1 method reference -seoTitle: InputsStatusUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusunion1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion1 | OpenRouter Python SDK -'og:description': >- - InputsStatusUnion1 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion1%20-%20Python%20SDK&description=InputsStatusUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputsStatusCompleted1` - -```python lines -value: components.InputsStatusCompleted1 = /* values here */ -``` - -### `components.InputsStatusIncomplete1` - -```python lines -value: components.InputsStatusIncomplete1 = /* values here */ -``` - -### `components.InputsStatusInProgress1` - -```python lines -value: components.InputsStatusInProgress1 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsstatusunion2.mdx b/client-sdks/python/api-reference/components/inputsstatusunion2.mdx deleted file mode 100644 index 31f8c112..00000000 --- a/client-sdks/python/api-reference/components/inputsstatusunion2.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputsStatusUnion2 - Python SDK -sidebarTitle: InputsStatusUnion2 -description: InputsStatusUnion2 method reference -seoTitle: InputsStatusUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputsstatusunion2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion2 | OpenRouter Python SDK -'og:description': >- - InputsStatusUnion2 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion2%20-%20Python%20SDK&description=InputsStatusUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputsStatusCompleted2` - -```python lines -value: components.InputsStatusCompleted2 = /* values here */ -``` - -### `components.InputsStatusIncomplete2` - -```python lines -value: components.InputsStatusIncomplete2 = /* values here */ -``` - -### `components.InputsStatusInProgress2` - -```python lines -value: components.InputsStatusInProgress2 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputstypemessage.mdx b/client-sdks/python/api-reference/components/inputstypemessage.mdx deleted file mode 100644 index 787656ed..00000000 --- a/client-sdks/python/api-reference/components/inputstypemessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsTypeMessage - Python SDK -sidebarTitle: InputsTypeMessage -description: InputsTypeMessage method reference -seoTitle: InputsTypeMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputstypemessage -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeMessage | OpenRouter Python SDK -'og:description': >- - InputsTypeMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeMessage%20-%20Python%20SDK&description=InputsTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputstypereasoning.mdx b/client-sdks/python/api-reference/components/inputstypereasoning.mdx deleted file mode 100644 index 0d262695..00000000 --- a/client-sdks/python/api-reference/components/inputstypereasoning.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputsTypeReasoning - Python SDK -sidebarTitle: InputsTypeReasoning -description: InputsTypeReasoning method reference -seoTitle: InputsTypeReasoning | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputstypereasoning -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeReasoning | OpenRouter Python SDK -'og:description': >- - InputsTypeReasoning method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeReasoning%20-%20Python%20SDK&description=InputsTypeReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `REASONING` | reasoning | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsunion.mdx b/client-sdks/python/api-reference/components/inputsunion.mdx deleted file mode 100644 index d8b5cd3f..00000000 --- a/client-sdks/python/api-reference/components/inputsunion.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputsUnion - Python SDK -sidebarTitle: InputsUnion -description: InputsUnion method reference -seoTitle: InputsUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputsunion' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion | OpenRouter Python SDK -'og:description': >- - InputsUnion method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion%20-%20Python%20SDK&description=InputsUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Input for a response request - can be a string or array of items - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.InputsUnion1]` - -```python lines -value: List[components.InputsUnion1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputsunion1.mdx b/client-sdks/python/api-reference/components/inputsunion1.mdx deleted file mode 100644 index 4cf83159..00000000 --- a/client-sdks/python/api-reference/components/inputsunion1.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -title: InputsUnion1 - Python SDK -sidebarTitle: InputsUnion1 -description: InputsUnion1 method reference -seoTitle: InputsUnion1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputsunion1' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion1 | OpenRouter Python SDK -'og:description': >- - InputsUnion1 method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion1%20-%20Python%20SDK&description=InputsUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ReasoningItem` - -```python lines -value: components.ReasoningItem = /* values here */ -``` - -### `components.EasyInputMessage` - -```python lines -value: components.EasyInputMessage = /* values here */ -``` - -### `components.InputMessageItem` - -```python lines -value: components.InputMessageItem = /* values here */ -``` - -### `components.FunctionCallItem` - -```python lines -value: components.FunctionCallItem = /* values here */ -``` - -### `components.FunctionCallOutputItem` - -```python lines -value: components.FunctionCallOutputItem = /* values here */ -``` - -### `components.ApplyPatchCallItem` - -```python lines -value: components.ApplyPatchCallItem = /* values here */ -``` - -### `components.ApplyPatchCallOutputItem` - -```python lines -value: components.ApplyPatchCallOutputItem = /* values here */ -``` - -### `components.InputsMessage` - -```python lines -value: components.InputsMessage = /* values here */ -``` - -### `components.InputsReasoning` - -```python lines -value: components.InputsReasoning = /* values here */ -``` - -### `components.OutputFunctionCallItem` - -```python lines -value: components.OutputFunctionCallItem = /* values here */ -``` - -### `components.OutputCustomToolCallItem` - -```python lines -value: components.OutputCustomToolCallItem = /* values here */ -``` - -### `components.OutputWebSearchCallItem` - -```python lines -value: components.OutputWebSearchCallItem = /* values here */ -``` - -### `components.OutputFileSearchCallItem` - -```python lines -value: components.OutputFileSearchCallItem = /* values here */ -``` - -### `components.OutputImageGenerationCallItem` - -```python lines -value: components.OutputImageGenerationCallItem = /* values here */ -``` - -### `components.OutputCodeInterpreterCallItem` - -```python lines -value: components.OutputCodeInterpreterCallItem = /* values here */ -``` - -### `components.OutputComputerCallItem` - -```python lines -value: components.OutputComputerCallItem = /* values here */ -``` - -### `components.OutputDatetimeItem` - -```python lines -value: components.OutputDatetimeItem = /* values here */ -``` - -### `components.OutputWebSearchServerToolItem` - -```python lines -value: components.OutputWebSearchServerToolItem = /* values here */ -``` - -### `components.OutputCodeInterpreterServerToolItem` - -```python lines -value: components.OutputCodeInterpreterServerToolItem = /* values here */ -``` - -### `components.OutputFileSearchServerToolItem` - -```python lines -value: components.OutputFileSearchServerToolItem = /* values here */ -``` - -### `components.OutputImageGenerationServerToolItem` - -```python lines -value: components.OutputImageGenerationServerToolItem = /* values here */ -``` - -### `components.OutputBrowserUseServerToolItem` - -```python lines -value: components.OutputBrowserUseServerToolItem = /* values here */ -``` - -### `components.OutputBashServerToolItem` - -```python lines -value: components.OutputBashServerToolItem = /* values here */ -``` - -### `components.OutputTextEditorServerToolItem` - -```python lines -value: components.OutputTextEditorServerToolItem = /* values here */ -``` - -### `components.OutputApplyPatchServerToolItem` - -```python lines -value: components.OutputApplyPatchServerToolItem = /* values here */ -``` - -### `components.OutputWebFetchServerToolItem` - -```python lines -value: components.OutputWebFetchServerToolItem = /* values here */ -``` - -### `components.OutputToolSearchServerToolItem` - -```python lines -value: components.OutputToolSearchServerToolItem = /* values here */ -``` - -### `components.OutputMemoryServerToolItem` - -```python lines -value: components.OutputMemoryServerToolItem = /* values here */ -``` - -### `components.OutputMcpServerToolItem` - -```python lines -value: components.OutputMcpServerToolItem = /* values here */ -``` - -### `components.OutputSearchModelsServerToolItem` - -```python lines -value: components.OutputSearchModelsServerToolItem = /* values here */ -``` - -### `components.LocalShellCallItem` - -```python lines -value: components.LocalShellCallItem = /* values here */ -``` - -### `components.LocalShellCallOutputItem` - -```python lines -value: components.LocalShellCallOutputItem = /* values here */ -``` - -### `components.ShellCallItem` - -```python lines -value: components.ShellCallItem = /* values here */ -``` - -### `components.ShellCallOutputItem` - -```python lines -value: components.ShellCallOutputItem = /* values here */ -``` - -### `components.McpListToolsItem` - -```python lines -value: components.McpListToolsItem = /* values here */ -``` - -### `components.McpApprovalRequestItem` - -```python lines -value: components.McpApprovalRequestItem = /* values here */ -``` - -### `components.McpApprovalResponseItem` - -```python lines -value: components.McpApprovalResponseItem = /* values here */ -``` - -### `components.McpCallItem` - -```python lines -value: components.McpCallItem = /* values here */ -``` - -### `components.CustomToolCallItem` - -```python lines -value: components.CustomToolCallItem = /* values here */ -``` - -### `components.CustomToolCallOutputItem` - -```python lines -value: components.CustomToolCallOutputItem = /* values here */ -``` - -### `components.CompactionItem` - -```python lines -value: components.CompactionItem = /* values here */ -``` - -### `components.ItemReferenceItem` - -```python lines -value: components.ItemReferenceItem = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputtext.mdx b/client-sdks/python/api-reference/components/inputtext.mdx deleted file mode 100644 index c8b22646..00000000 --- a/client-sdks/python/api-reference/components/inputtext.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputText - Python SDK -sidebarTitle: InputText -description: InputText method reference -seoTitle: InputText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputtext' -'og:site_name': OpenRouter Documentation -'og:title': InputText | OpenRouter Python SDK -'og:description': >- - InputText method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputText%20-%20Python%20SDK&description=InputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.InputTextType](/client-sdks/python/api-reference/components/inputtexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputtexttype.mdx b/client-sdks/python/api-reference/components/inputtexttype.mdx deleted file mode 100644 index 86728d54..00000000 --- a/client-sdks/python/api-reference/components/inputtexttype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputTextType - Python SDK -sidebarTitle: InputTextType -description: InputTextType method reference -seoTitle: InputTextType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputtexttype' -'og:site_name': OpenRouter Documentation -'og:title': InputTextType | OpenRouter Python SDK -'og:description': >- - InputTextType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTextType%20-%20Python%20SDK&description=InputTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INPUT_TEXT` | input_text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputtokensdetails.mdx b/client-sdks/python/api-reference/components/inputtokensdetails.mdx deleted file mode 100644 index d10f8b93..00000000 --- a/client-sdks/python/api-reference/components/inputtokensdetails.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: InputTokensDetails - Python SDK -sidebarTitle: InputTokensDetails -description: InputTokensDetails method reference -seoTitle: InputTokensDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/inputtokensdetails -'og:site_name': OpenRouter Documentation -'og:title': InputTokensDetails | OpenRouter Python SDK -'og:description': >- - InputTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTokensDetails%20-%20Python%20SDK&description=InputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `cached_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputunion.mdx b/client-sdks/python/api-reference/components/inputunion.mdx deleted file mode 100644 index 4f58a4f8..00000000 --- a/client-sdks/python/api-reference/components/inputunion.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputUnion - Python SDK -sidebarTitle: InputUnion -description: InputUnion method reference -seoTitle: InputUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion | OpenRouter Python SDK -'og:description': >- - InputUnion method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20Python%20SDK&description=InputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The input to the generation — either a prompt string or an array of messages - -## Supported Types - -### `components.Input1` - -```python lines -value: components.Input1 = /* values here */ -``` - -### `components.Input2` - -```python lines -value: components.Input2 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/inputvideo.mdx b/client-sdks/python/api-reference/components/inputvideo.mdx deleted file mode 100644 index ac5ff445..00000000 --- a/client-sdks/python/api-reference/components/inputvideo.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputVideo - Python SDK -sidebarTitle: InputVideo -description: InputVideo method reference -seoTitle: InputVideo | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputvideo' -'og:site_name': OpenRouter Documentation -'og:title': InputVideo | OpenRouter Python SDK -'og:description': >- - InputVideo method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputVideo%20-%20Python%20SDK&description=InputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Video input content item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `type` | [components.InputVideoType](/client-sdks/python/api-reference/components/inputvideotype) | :heavy_check_mark: | N/A | -| `video_url` | *str* | :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/client-sdks/python/api-reference/components/inputvideotype.mdx b/client-sdks/python/api-reference/components/inputvideotype.mdx deleted file mode 100644 index 92945c53..00000000 --- a/client-sdks/python/api-reference/components/inputvideotype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: InputVideoType - Python SDK -sidebarTitle: InputVideoType -description: InputVideoType method reference -seoTitle: InputVideoType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/inputvideotype' -'og:site_name': OpenRouter Documentation -'og:title': InputVideoType | OpenRouter Python SDK -'og:description': >- - InputVideoType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputVideoType%20-%20Python%20SDK&description=InputVideoType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_VIDEO` | input_video | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/instructtype.mdx b/client-sdks/python/api-reference/components/instructtype.mdx deleted file mode 100644 index 59ad2c6d..00000000 --- a/client-sdks/python/api-reference/components/instructtype.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: InstructType - Python SDK -sidebarTitle: InstructType -description: InstructType method reference -seoTitle: InstructType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/instructtype' -'og:site_name': OpenRouter Documentation -'og:title': InstructType | OpenRouter Python SDK -'og:description': >- - InstructType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InstructType%20-%20Python%20SDK&description=InstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Values - -| Name | Value | -| --------------- | --------------- | -| `NONE` | none | -| `AIROBOROS` | airoboros | -| `ALPACA` | alpaca | -| `ALPACA_MODIF` | alpaca-modif | -| `CHATML` | chatml | -| `CLAUDE` | claude | -| `CODE_LLAMA` | code-llama | -| `GEMMA` | gemma | -| `LLAMA2` | llama2 | -| `LLAMA3` | llama3 | -| `MISTRAL` | mistral | -| `NEMOTRON` | nemotron | -| `NEURAL` | neural | -| `OPENCHAT` | openchat | -| `PHI3` | phi3 | -| `RWKV` | rwkv | -| `VICUNA` | vicuna | -| `ZEPHYR` | zephyr | -| `DEEPSEEK_R1` | deepseek-r1 | -| `DEEPSEEK_V3_1` | deepseek-v3.1 | -| `QWQ` | qwq | -| `QWEN3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/internalserverresponseerrordata.mdx b/client-sdks/python/api-reference/components/internalserverresponseerrordata.mdx deleted file mode 100644 index 29873a3d..00000000 --- a/client-sdks/python/api-reference/components/internalserverresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InternalServerResponseErrorData - Python SDK -sidebarTitle: InternalServerResponseErrorData -description: InternalServerResponseErrorData method reference -seoTitle: InternalServerResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/internalserverresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseErrorData | OpenRouter Python SDK -'og:description': >- - InternalServerResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseErrorData%20-%20Python%20SDK&description=InternalServerResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for InternalServerResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/itemreferenceitem.mdx b/client-sdks/python/api-reference/components/itemreferenceitem.mdx deleted file mode 100644 index b427eedd..00000000 --- a/client-sdks/python/api-reference/components/itemreferenceitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ItemReferenceItem - Python SDK -sidebarTitle: ItemReferenceItem -description: ItemReferenceItem method reference -seoTitle: ItemReferenceItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/itemreferenceitem -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItem | OpenRouter Python SDK -'og:description': >- - ItemReferenceItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItem%20-%20Python%20SDK&description=ItemReferenceItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A reference to a previous response item by ID - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ItemReferenceItemType](/client-sdks/python/api-reference/components/itemreferenceitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/itemreferenceitemtype.mdx b/client-sdks/python/api-reference/components/itemreferenceitemtype.mdx deleted file mode 100644 index 923f0f16..00000000 --- a/client-sdks/python/api-reference/components/itemreferenceitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ItemReferenceItemType - Python SDK -sidebarTitle: ItemReferenceItemType -description: ItemReferenceItemType method reference -seoTitle: ItemReferenceItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/itemreferenceitemtype -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItemType | OpenRouter Python SDK -'og:description': >- - ItemReferenceItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItemType%20-%20Python%20SDK&description=ItemReferenceItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `ITEM_REFERENCE` | item_reference | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/keep.mdx b/client-sdks/python/api-reference/components/keep.mdx deleted file mode 100644 index d4680165..00000000 --- a/client-sdks/python/api-reference/components/keep.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Keep - Python SDK -sidebarTitle: Keep -description: Keep method reference -seoTitle: Keep | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/keep' -'og:site_name': OpenRouter Documentation -'og:title': Keep | OpenRouter Python SDK -'og:description': >- - Keep method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Keep%20-%20Python%20SDK&description=Keep%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicThinkingTurns` - -```python lines -value: components.AnthropicThinkingTurns = /* values here */ -``` - -### `components.KeepAll` - -```python lines -value: components.KeepAll = /* values here */ -``` - -### `components.KeepEnum` - -```python lines -value: components.KeepEnum = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/keepall.mdx b/client-sdks/python/api-reference/components/keepall.mdx deleted file mode 100644 index 57b372b2..00000000 --- a/client-sdks/python/api-reference/components/keepall.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: KeepAll - Python SDK -sidebarTitle: KeepAll -description: KeepAll method reference -seoTitle: KeepAll | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/keepall' -'og:site_name': OpenRouter Documentation -'og:title': KeepAll | OpenRouter Python SDK -'og:description': >- - KeepAll method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepAll%20-%20Python%20SDK&description=KeepAll%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.KeepType](/client-sdks/python/api-reference/components/keeptype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/keepenum.mdx b/client-sdks/python/api-reference/components/keepenum.mdx deleted file mode 100644 index 168a641b..00000000 --- a/client-sdks/python/api-reference/components/keepenum.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: KeepEnum - Python SDK -sidebarTitle: KeepEnum -description: KeepEnum method reference -seoTitle: KeepEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/keepenum' -'og:site_name': OpenRouter Documentation -'og:title': KeepEnum | OpenRouter Python SDK -'og:description': >- - KeepEnum method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepEnum%20-%20Python%20SDK&description=KeepEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `ALL` | all | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/keeptype.mdx b/client-sdks/python/api-reference/components/keeptype.mdx deleted file mode 100644 index 5e32f8c9..00000000 --- a/client-sdks/python/api-reference/components/keeptype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: KeepType - Python SDK -sidebarTitle: KeepType -description: KeepType method reference -seoTitle: KeepType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/keeptype' -'og:site_name': OpenRouter Documentation -'og:title': KeepType | OpenRouter Python SDK -'og:description': >- - KeepType method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepType%20-%20Python%20SDK&description=KeepType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `ALL` | all | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/keyassignment.mdx b/client-sdks/python/api-reference/components/keyassignment.mdx deleted file mode 100644 index 88670dad..00000000 --- a/client-sdks/python/api-reference/components/keyassignment.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: KeyAssignment - Python SDK -sidebarTitle: KeyAssignment -description: KeyAssignment method reference -seoTitle: KeyAssignment | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/keyassignment' -'og:site_name': OpenRouter Documentation -'og:title': KeyAssignment | OpenRouter Python SDK -'og:description': >- - KeyAssignment method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeyAssignment%20-%20Python%20SDK&description=KeyAssignment%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hash` | *str* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `key_label` | *str* | :heavy_check_mark: | Label of the API key | prod-key | -| `key_name` | *str* | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/legacychatcontentvideo.mdx b/client-sdks/python/api-reference/components/legacychatcontentvideo.mdx deleted file mode 100644 index 695847e0..00000000 --- a/client-sdks/python/api-reference/components/legacychatcontentvideo.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ~~LegacyChatContentVideo~~ - Python SDK -sidebarTitle: ~~LegacyChatContentVideo~~ -description: ~~LegacyChatContentVideo~~ method reference -seoTitle: ~~LegacyChatContentVideo~~ | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/legacychatcontentvideo -'og:site_name': OpenRouter Documentation -'og:title': ~~LegacyChatContentVideo~~ | OpenRouter Python SDK -'og:description': >- - ~~LegacyChatContentVideo~~ method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~LegacyChatContentVideo~~%20-%20Python%20SDK&description=~~LegacyChatContentVideo~~%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Video input content part (legacy format - deprecated) - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.LegacyChatContentVideoType](/client-sdks/python/api-reference/components/legacychatcontentvideotype) | :heavy_check_mark: | N/A | | -| `video_url` | [components.ChatContentVideoInput](/client-sdks/python/api-reference/components/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/legacychatcontentvideotype.mdx b/client-sdks/python/api-reference/components/legacychatcontentvideotype.mdx deleted file mode 100644 index bcaa7646..00000000 --- a/client-sdks/python/api-reference/components/legacychatcontentvideotype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: LegacyChatContentVideoType - Python SDK -sidebarTitle: LegacyChatContentVideoType -description: LegacyChatContentVideoType method reference -seoTitle: LegacyChatContentVideoType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/legacychatcontentvideotype -'og:site_name': OpenRouter Documentation -'og:title': LegacyChatContentVideoType | OpenRouter Python SDK -'og:description': >- - LegacyChatContentVideoType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyChatContentVideoType%20-%20Python%20SDK&description=LegacyChatContentVideoType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_VIDEO` | input_video | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/legacywebsearchservertool.mdx b/client-sdks/python/api-reference/components/legacywebsearchservertool.mdx deleted file mode 100644 index 4b672aa1..00000000 --- a/client-sdks/python/api-reference/components/legacywebsearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: LegacyWebSearchServerTool - Python SDK -sidebarTitle: LegacyWebSearchServerTool -description: LegacyWebSearchServerTool method reference -seoTitle: LegacyWebSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/legacywebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': LegacyWebSearchServerTool | OpenRouter Python SDK -'og:description': >- - LegacyWebSearchServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyWebSearchServerTool%20-%20Python%20SDK&description=LegacyWebSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `filters` | [OptionalNullable[components.WebSearchDomainFilter]](../components/websearchdomainfilter.md) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.LegacyWebSearchServerToolType](/client-sdks/python/api-reference/components/legacywebsearchservertooltype) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.md) | :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/client-sdks/python/api-reference/components/legacywebsearchservertooltype.mdx b/client-sdks/python/api-reference/components/legacywebsearchservertooltype.mdx deleted file mode 100644 index 89cf31e6..00000000 --- a/client-sdks/python/api-reference/components/legacywebsearchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: LegacyWebSearchServerToolType - Python SDK -sidebarTitle: LegacyWebSearchServerToolType -description: LegacyWebSearchServerToolType method reference -seoTitle: LegacyWebSearchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/legacywebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': LegacyWebSearchServerToolType | OpenRouter Python SDK -'og:description': >- - LegacyWebSearchServerToolType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyWebSearchServerToolType%20-%20Python%20SDK&description=LegacyWebSearchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `WEB_SEARCH` | web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listbyokkeysresponse.mdx b/client-sdks/python/api-reference/components/listbyokkeysresponse.mdx deleted file mode 100644 index 07abb22f..00000000 --- a/client-sdks/python/api-reference/components/listbyokkeysresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListBYOKKeysResponse - Python SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse method reference -seoTitle: ListBYOKKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listbyokkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse | OpenRouter Python SDK -'og:description': >- - ListBYOKKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20Python%20SDK&description=ListBYOKKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[components.BYOKKey](/client-sdks/python/api-reference/components/byokkey)] | :heavy_check_mark: | List of BYOK credentials. | | -| `total_count` | *int* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listendpointsresponse.mdx b/client-sdks/python/api-reference/components/listendpointsresponse.mdx deleted file mode 100644 index 5bea1b65..00000000 --- a/client-sdks/python/api-reference/components/listendpointsresponse.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ListEndpointsResponse - Python SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listendpointsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Python%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of available endpoints for a model - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.Architecture](/client-sdks/python/api-reference/components/architecture) | :heavy_check_mark: | N/A | `{"input_modalities": ["text"],"instruct_type": "chatml","modality": "text-\u003etext","output_modalities": ["text"],"tokenizer": "GPT"}` | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | List[[components.PublicEndpoint](/client-sdks/python/api-reference/components/publicendpoint)] | :heavy_check_mark: | List of available endpoints for this model | | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listguardrailsresponse.mdx b/client-sdks/python/api-reference/components/listguardrailsresponse.mdx deleted file mode 100644 index 81a3cac4..00000000 --- a/client-sdks/python/api-reference/components/listguardrailsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListGuardrailsResponse - Python SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse method reference -seoTitle: ListGuardrailsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listguardrailsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20Python%20SDK&description=ListGuardrailsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Guardrail](/client-sdks/python/api-reference/components/guardrail)] | :heavy_check_mark: | List of guardrails | | -| `total_count` | *int* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listkeyassignmentsresponse.mdx b/client-sdks/python/api-reference/components/listkeyassignmentsresponse.mdx deleted file mode 100644 index 60dbfcf2..00000000 --- a/client-sdks/python/api-reference/components/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - Python SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse method reference -seoTitle: ListKeyAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20Python%20SDK&description=ListKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `data` | List[[components.KeyAssignment](/client-sdks/python/api-reference/components/keyassignment)] | :heavy_check_mark: | List of key assignments | | -| `total_count` | *int* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listmemberassignmentsresponse.mdx b/client-sdks/python/api-reference/components/listmemberassignmentsresponse.mdx deleted file mode 100644 index d54651ff..00000000 --- a/client-sdks/python/api-reference/components/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - Python SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse method reference -seoTitle: ListMemberAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20Python%20SDK&description=ListMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | List[[components.MemberAssignment](/client-sdks/python/api-reference/components/memberassignment)] | :heavy_check_mark: | List of member assignments | | -| `total_count` | *int* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listobservabilitydestinationsresponse.mdx b/client-sdks/python/api-reference/components/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index fb93991f..00000000 --- a/client-sdks/python/api-reference/components/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - Python SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse method reference -seoTitle: ListObservabilityDestinationsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse | OpenRouter Python SDK -'og:description': >- - ListObservabilityDestinationsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20Python%20SDK&description=ListObservabilityDestinationsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | List[[components.ObservabilityDestination](/client-sdks/python/api-reference/components/observabilitydestination)] | :heavy_check_mark: | List of observability destinations. | | -| `total_count` | *int* | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/listworkspacesresponse.mdx b/client-sdks/python/api-reference/components/listworkspacesresponse.mdx deleted file mode 100644 index 4bf25dfd..00000000 --- a/client-sdks/python/api-reference/components/listworkspacesresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListWorkspacesResponse - Python SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse method reference -seoTitle: ListWorkspacesResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/listworkspacesresponse -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse | OpenRouter Python SDK -'og:description': >- - ListWorkspacesResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20Python%20SDK&description=ListWorkspacesResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | List[[components.Workspace](/client-sdks/python/api-reference/components/workspace)] | :heavy_check_mark: | List of workspaces | | -| `total_count` | *int* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/localshellcallitem.mdx b/client-sdks/python/api-reference/components/localshellcallitem.mdx deleted file mode 100644 index 8b4914be..00000000 --- a/client-sdks/python/api-reference/components/localshellcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: LocalShellCallItem - Python SDK -sidebarTitle: LocalShellCallItem -description: LocalShellCallItem method reference -seoTitle: LocalShellCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/localshellcallitem -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItem | OpenRouter Python SDK -'og:description': >- - LocalShellCallItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItem%20-%20Python%20SDK&description=LocalShellCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A local shell command execution call - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `action` | [components.LocalShellCallItemAction](/client-sdks/python/api-reference/components/localshellcallitemaction) | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.TypeLocalShellCall](/client-sdks/python/api-reference/components/typelocalshellcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/localshellcallitemaction.mdx b/client-sdks/python/api-reference/components/localshellcallitemaction.mdx deleted file mode 100644 index 8e2cff1e..00000000 --- a/client-sdks/python/api-reference/components/localshellcallitemaction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: LocalShellCallItemAction - Python SDK -sidebarTitle: LocalShellCallItemAction -description: LocalShellCallItemAction method reference -seoTitle: LocalShellCallItemAction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/localshellcallitemaction -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItemAction | OpenRouter Python SDK -'og:description': >- - LocalShellCallItemAction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItemAction%20-%20Python%20SDK&description=LocalShellCallItemAction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `command` | List[*str*] | :heavy_check_mark: | N/A | -| `env` | Dict[str, *str*] | :heavy_check_mark: | N/A | -| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `type` | [components.TypeExec](/client-sdks/python/api-reference/components/typeexec) | :heavy_check_mark: | N/A | -| `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `working_directory` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/localshellcalloutputitem.mdx b/client-sdks/python/api-reference/components/localshellcalloutputitem.mdx deleted file mode 100644 index 37ae9003..00000000 --- a/client-sdks/python/api-reference/components/localshellcalloutputitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: LocalShellCallOutputItem - Python SDK -sidebarTitle: LocalShellCallOutputItem -description: LocalShellCallOutputItem method reference -seoTitle: LocalShellCallOutputItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/localshellcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItem | OpenRouter Python SDK -'og:description': >- - LocalShellCallOutputItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItem%20-%20Python%20SDK&description=LocalShellCallOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Output from a local shell command execution - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `output` | *str* | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.LocalShellCallOutputItemStatus]](../components/localshellcalloutputitemstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.LocalShellCallOutputItemType](/client-sdks/python/api-reference/components/localshellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/localshellcalloutputitemstatus.mdx b/client-sdks/python/api-reference/components/localshellcalloutputitemstatus.mdx deleted file mode 100644 index b25fe279..00000000 --- a/client-sdks/python/api-reference/components/localshellcalloutputitemstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: LocalShellCallOutputItemStatus - Python SDK -sidebarTitle: LocalShellCallOutputItemStatus -description: LocalShellCallOutputItemStatus method reference -seoTitle: LocalShellCallOutputItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/localshellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemStatus | OpenRouter Python SDK -'og:description': >- - LocalShellCallOutputItemStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemStatus%20-%20Python%20SDK&description=LocalShellCallOutputItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/localshellcalloutputitemtype.mdx b/client-sdks/python/api-reference/components/localshellcalloutputitemtype.mdx deleted file mode 100644 index 6313ed8a..00000000 --- a/client-sdks/python/api-reference/components/localshellcalloutputitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: LocalShellCallOutputItemType - Python SDK -sidebarTitle: LocalShellCallOutputItemType -description: LocalShellCallOutputItemType method reference -seoTitle: LocalShellCallOutputItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/localshellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemType | OpenRouter Python SDK -'og:description': >- - LocalShellCallOutputItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemType%20-%20Python%20SDK&description=LocalShellCallOutputItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `LOCAL_SHELL_CALL_OUTPUT` | local_shell_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/logic.mdx b/client-sdks/python/api-reference/components/logic.mdx deleted file mode 100644 index 9eb3dcc5..00000000 --- a/client-sdks/python/api-reference/components/logic.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Logic - Python SDK -sidebarTitle: Logic -description: Logic method reference -seoTitle: Logic | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/logic' -'og:site_name': OpenRouter Documentation -'og:title': Logic | OpenRouter Python SDK -'og:description': >- - Logic method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logic%20-%20Python%20SDK&description=Logic%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `AND` | and | -| `OR` | or | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/logprob.mdx b/client-sdks/python/api-reference/components/logprob.mdx deleted file mode 100644 index 664b9ad0..00000000 --- a/client-sdks/python/api-reference/components/logprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Logprob - Python SDK -sidebarTitle: Logprob -description: Logprob method reference -seoTitle: Logprob | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/logprob' -'og:site_name': OpenRouter Documentation -'og:title': Logprob | OpenRouter Python SDK -'og:description': >- - Logprob method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logprob%20-%20Python%20SDK&description=Logprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](/client-sdks/python/api-reference/components/responseoutputtexttoplogprob)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/maxprice.mdx b/client-sdks/python/api-reference/components/maxprice.mdx deleted file mode 100644 index ed9355ca..00000000 --- a/client-sdks/python/api-reference/components/maxprice.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: MaxPrice - Python SDK -sidebarTitle: MaxPrice -description: MaxPrice method reference -seoTitle: MaxPrice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/maxprice' -'og:site_name': OpenRouter Documentation -'og:title': MaxPrice | OpenRouter Python SDK -'og:description': >- - MaxPrice method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MaxPrice%20-%20Python%20SDK&description=MaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | Price per million prompt tokens | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpapprovalrequestitem.mdx b/client-sdks/python/api-reference/components/mcpapprovalrequestitem.mdx deleted file mode 100644 index 9fa97dc6..00000000 --- a/client-sdks/python/api-reference/components/mcpapprovalrequestitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: McpApprovalRequestItem - Python SDK -sidebarTitle: McpApprovalRequestItem -description: McpApprovalRequestItem method reference -seoTitle: McpApprovalRequestItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpapprovalrequestitem -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItem | OpenRouter Python SDK -'og:description': >- - McpApprovalRequestItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItem%20-%20Python%20SDK&description=McpApprovalRequestItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request for approval to execute an MCP tool - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.McpApprovalRequestItemType](/client-sdks/python/api-reference/components/mcpapprovalrequestitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpapprovalrequestitemtype.mdx b/client-sdks/python/api-reference/components/mcpapprovalrequestitemtype.mdx deleted file mode 100644 index 2d018ddb..00000000 --- a/client-sdks/python/api-reference/components/mcpapprovalrequestitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: McpApprovalRequestItemType - Python SDK -sidebarTitle: McpApprovalRequestItemType -description: McpApprovalRequestItemType method reference -seoTitle: McpApprovalRequestItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpapprovalrequestitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItemType | OpenRouter Python SDK -'og:description': >- - McpApprovalRequestItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItemType%20-%20Python%20SDK&description=McpApprovalRequestItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `MCP_APPROVAL_REQUEST` | mcp_approval_request | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpapprovalresponseitem.mdx b/client-sdks/python/api-reference/components/mcpapprovalresponseitem.mdx deleted file mode 100644 index eabd2695..00000000 --- a/client-sdks/python/api-reference/components/mcpapprovalresponseitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: McpApprovalResponseItem - Python SDK -sidebarTitle: McpApprovalResponseItem -description: McpApprovalResponseItem method reference -seoTitle: McpApprovalResponseItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpapprovalresponseitem -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItem | OpenRouter Python SDK -'og:description': >- - McpApprovalResponseItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItem%20-%20Python%20SDK&description=McpApprovalResponseItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -User response to an MCP tool approval request - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `approval_request_id` | *str* | :heavy_check_mark: | N/A | -| `approve` | *bool* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reason` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.McpApprovalResponseItemType](/client-sdks/python/api-reference/components/mcpapprovalresponseitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpapprovalresponseitemtype.mdx b/client-sdks/python/api-reference/components/mcpapprovalresponseitemtype.mdx deleted file mode 100644 index d2092acd..00000000 --- a/client-sdks/python/api-reference/components/mcpapprovalresponseitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: McpApprovalResponseItemType - Python SDK -sidebarTitle: McpApprovalResponseItemType -description: McpApprovalResponseItemType method reference -seoTitle: McpApprovalResponseItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpapprovalresponseitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItemType | OpenRouter Python SDK -'og:description': >- - McpApprovalResponseItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItemType%20-%20Python%20SDK&description=McpApprovalResponseItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `MCP_APPROVAL_RESPONSE` | mcp_approval_response | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpcallitem.mdx b/client-sdks/python/api-reference/components/mcpcallitem.mdx deleted file mode 100644 index cbf2bca0..00000000 --- a/client-sdks/python/api-reference/components/mcpcallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: McpCallItem - Python SDK -sidebarTitle: McpCallItem -description: McpCallItem method reference -seoTitle: McpCallItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/mcpcallitem' -'og:site_name': OpenRouter Documentation -'og:title': McpCallItem | OpenRouter Python SDK -'og:description': >- - McpCallItem method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItem%20-%20Python%20SDK&description=McpCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An MCP tool call with its output or error - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `error` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `output` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.McpCallItemType](/client-sdks/python/api-reference/components/mcpcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpcallitemtype.mdx b/client-sdks/python/api-reference/components/mcpcallitemtype.mdx deleted file mode 100644 index 7219d2b0..00000000 --- a/client-sdks/python/api-reference/components/mcpcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: McpCallItemType - Python SDK -sidebarTitle: McpCallItemType -description: McpCallItemType method reference -seoTitle: McpCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpCallItemType | OpenRouter Python SDK -'og:description': >- - McpCallItemType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItemType%20-%20Python%20SDK&description=McpCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `MCP_CALL` | mcp_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcplisttoolsitem.mdx b/client-sdks/python/api-reference/components/mcplisttoolsitem.mdx deleted file mode 100644 index 28ebe388..00000000 --- a/client-sdks/python/api-reference/components/mcplisttoolsitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: McpListToolsItem - Python SDK -sidebarTitle: McpListToolsItem -description: McpListToolsItem method reference -seoTitle: McpListToolsItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcplisttoolsitem -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItem | OpenRouter Python SDK -'og:description': >- - McpListToolsItem method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItem%20-%20Python%20SDK&description=McpListToolsItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of available MCP tools from a server - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `error` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `tools` | List[[components.McpListToolsItemTool](/client-sdks/python/api-reference/components/mcplisttoolsitemtool)] | :heavy_check_mark: | N/A | -| `type` | [components.McpListToolsItemType](/client-sdks/python/api-reference/components/mcplisttoolsitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcplisttoolsitemtool.mdx b/client-sdks/python/api-reference/components/mcplisttoolsitemtool.mdx deleted file mode 100644 index 58dd78d7..00000000 --- a/client-sdks/python/api-reference/components/mcplisttoolsitemtool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: McpListToolsItemTool - Python SDK -sidebarTitle: McpListToolsItemTool -description: McpListToolsItemTool method reference -seoTitle: McpListToolsItemTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcplisttoolsitemtool -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemTool | OpenRouter Python SDK -'og:description': >- - McpListToolsItemTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemTool%20-%20Python%20SDK&description=McpListToolsItemTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `annotations` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `input_schema` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcplisttoolsitemtype.mdx b/client-sdks/python/api-reference/components/mcplisttoolsitemtype.mdx deleted file mode 100644 index 839f8344..00000000 --- a/client-sdks/python/api-reference/components/mcplisttoolsitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: McpListToolsItemType - Python SDK -sidebarTitle: McpListToolsItemType -description: McpListToolsItemType method reference -seoTitle: McpListToolsItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcplisttoolsitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemType | OpenRouter Python SDK -'og:description': >- - McpListToolsItemType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemType%20-%20Python%20SDK&description=McpListToolsItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `MCP_LIST_TOOLS` | mcp_list_tools | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpservertool.mdx b/client-sdks/python/api-reference/components/mcpservertool.mdx deleted file mode 100644 index 9b956ef0..00000000 --- a/client-sdks/python/api-reference/components/mcpservertool.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: McpServerTool - Python SDK -sidebarTitle: McpServerTool -description: McpServerTool method reference -seoTitle: McpServerTool | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/mcpservertool' -'og:site_name': OpenRouter Documentation -'og:title': McpServerTool | OpenRouter Python SDK -'og:description': >- - McpServerTool method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpServerTool%20-%20Python%20SDK&description=McpServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -MCP (Model Context Protocol) tool configuration - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_tools` | [OptionalNullable[components.AllowedToolsUnion]](../components/allowedtoolsunion.md) | :heavy_minus_sign: | N/A | -| `authorization` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `connector_id` | [Optional[components.ConnectorID]](../components/connectorid.md) | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `require_approval` | [OptionalNullable[components.RequireApprovalUnion]](../components/requireapprovalunion.md) | :heavy_minus_sign: | N/A | -| `server_description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `server_label` | *str* | :heavy_check_mark: | N/A | -| `server_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.McpServerToolType](/client-sdks/python/api-reference/components/mcpservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mcpservertooltype.mdx b/client-sdks/python/api-reference/components/mcpservertooltype.mdx deleted file mode 100644 index 5b424d15..00000000 --- a/client-sdks/python/api-reference/components/mcpservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: McpServerToolType - Python SDK -sidebarTitle: McpServerToolType -description: McpServerToolType method reference -seoTitle: McpServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/mcpservertooltype -'og:site_name': OpenRouter Documentation -'og:title': McpServerToolType | OpenRouter Python SDK -'og:description': >- - McpServerToolType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpServerToolType%20-%20Python%20SDK&description=McpServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `MCP` | mcp | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/memberassignment.mdx b/client-sdks/python/api-reference/components/memberassignment.mdx deleted file mode 100644 index 97680baa..00000000 --- a/client-sdks/python/api-reference/components/memberassignment.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: MemberAssignment - Python SDK -sidebarTitle: MemberAssignment -description: MemberAssignment method reference -seoTitle: MemberAssignment | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/memberassignment -'og:site_name': OpenRouter Documentation -'og:title': MemberAssignment | OpenRouter Python SDK -'og:description': >- - MemberAssignment method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemberAssignment%20-%20Python%20SDK&description=MemberAssignment%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `organization_id` | *str* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/memorylimit.mdx b/client-sdks/python/api-reference/components/memorylimit.mdx deleted file mode 100644 index 11fcb0ea..00000000 --- a/client-sdks/python/api-reference/components/memorylimit.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: MemoryLimit - Python SDK -sidebarTitle: MemoryLimit -description: MemoryLimit method reference -seoTitle: MemoryLimit | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/memorylimit' -'og:site_name': OpenRouter Documentation -'og:title': MemoryLimit | OpenRouter Python SDK -'og:description': >- - MemoryLimit method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemoryLimit%20-%20Python%20SDK&description=MemoryLimit%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `ONEG` | 1g | -| `FOURG` | 4g | -| `SIXTEENG` | 16g | -| `SIXTY_FOURG` | 64g | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesadvisortoolresultblock.mdx b/client-sdks/python/api-reference/components/messagesadvisortoolresultblock.mdx deleted file mode 100644 index a5de96a2..00000000 --- a/client-sdks/python/api-reference/components/messagesadvisortoolresultblock.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: MessagesAdvisorToolResultBlock - Python SDK -sidebarTitle: MessagesAdvisorToolResultBlock -description: MessagesAdvisorToolResultBlock method reference -seoTitle: MessagesAdvisorToolResultBlock | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesadvisortoolresultblock -'og:site_name': OpenRouter Documentation -'og:title': MessagesAdvisorToolResultBlock | OpenRouter Python SDK -'og:description': >- - MessagesAdvisorToolResultBlock method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesAdvisorToolResultBlock%20-%20Python%20SDK&description=MessagesAdvisorToolResultBlock%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Advisor tool result from a prior assistant turn, replayed back to the model on the next turn. Mirrors the block Anthropic returns in assistant content when the `advisor_20260301` tool runs. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `content` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `tool_use_id` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.MessagesAdvisorToolResultBlockType](/client-sdks/python/api-reference/components/messagesadvisortoolresultblocktype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesadvisortoolresultblocktype.mdx b/client-sdks/python/api-reference/components/messagesadvisortoolresultblocktype.mdx deleted file mode 100644 index e8313518..00000000 --- a/client-sdks/python/api-reference/components/messagesadvisortoolresultblocktype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MessagesAdvisorToolResultBlockType - Python SDK -sidebarTitle: MessagesAdvisorToolResultBlockType -description: MessagesAdvisorToolResultBlockType method reference -seoTitle: MessagesAdvisorToolResultBlockType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesadvisortoolresultblocktype -'og:site_name': OpenRouter Documentation -'og:title': MessagesAdvisorToolResultBlockType | OpenRouter Python SDK -'og:description': >- - MessagesAdvisorToolResultBlockType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesAdvisorToolResultBlockType%20-%20Python%20SDK&description=MessagesAdvisorToolResultBlockType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `ADVISOR_TOOL_RESULT` | advisor_tool_result | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparam.mdx b/client-sdks/python/api-reference/components/messagesmessageparam.mdx deleted file mode 100644 index 0235e7c0..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparam.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MessagesMessageParam - Python SDK -sidebarTitle: MessagesMessageParam -description: MessagesMessageParam method reference -seoTitle: MessagesMessageParam | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparam -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParam | OpenRouter Python SDK -'og:description': >- - MessagesMessageParam method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParam%20-%20Python%20SDK&description=MessagesMessageParam%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Anthropic message with OpenRouter extensions - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `content` | [components.MessagesMessageParamContentUnion5](/client-sdks/python/api-reference/components/messagesmessageparamcontentunion5) | :heavy_check_mark: | N/A | -| `role` | [components.MessagesMessageParamRole](/client-sdks/python/api-reference/components/messagesmessageparamrole) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion1.mdx b/client-sdks/python/api-reference/components/messagesmessageparamcontentunion1.mdx deleted file mode 100644 index b1f65d55..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion1.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: MessagesMessageParamContentUnion1 - Python SDK -sidebarTitle: MessagesMessageParamContentUnion1 -description: MessagesMessageParamContentUnion1 method reference -seoTitle: MessagesMessageParamContentUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamcontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion1 | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamContentUnion1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion1%20-%20Python%20SDK&description=MessagesMessageParamContentUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicTextBlockParam` - -```python lines -value: components.AnthropicTextBlockParam = /* values here */ -``` - -### `components.AnthropicImageBlockParam` - -```python lines -value: components.AnthropicImageBlockParam = /* values here */ -``` - -### `components.ContentToolReference` - -```python lines -value: components.ContentToolReference = /* values here */ -``` - -### `components.AnthropicSearchResultBlockParam` - -```python lines -value: components.AnthropicSearchResultBlockParam = /* values here */ -``` - -### `components.AnthropicDocumentBlockParam` - -```python lines -value: components.AnthropicDocumentBlockParam = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion2.mdx b/client-sdks/python/api-reference/components/messagesmessageparamcontentunion2.mdx deleted file mode 100644 index 203aee2a..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: MessagesMessageParamContentUnion2 - Python SDK -sidebarTitle: MessagesMessageParamContentUnion2 -description: MessagesMessageParamContentUnion2 method reference -seoTitle: MessagesMessageParamContentUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamcontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion2 | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamContentUnion2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion2%20-%20Python%20SDK&description=MessagesMessageParamContentUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.MessagesMessageParamContentUnion1]` - -```python lines -value: List[components.MessagesMessageParamContentUnion1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion3.mdx b/client-sdks/python/api-reference/components/messagesmessageparamcontentunion3.mdx deleted file mode 100644 index 09ffdcbd..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion3.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: MessagesMessageParamContentUnion3 - Python SDK -sidebarTitle: MessagesMessageParamContentUnion3 -description: MessagesMessageParamContentUnion3 method reference -seoTitle: MessagesMessageParamContentUnion3 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamcontentunion3 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion3 | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamContentUnion3 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion3%20-%20Python%20SDK&description=MessagesMessageParamContentUnion3%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.AnthropicWebSearchResultBlockParam]` - -```python lines -value: List[components.AnthropicWebSearchResultBlockParam] = /* values here */ -``` - -### `components.ContentWebSearchToolResultError` - -```python lines -value: components.ContentWebSearchToolResultError = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion4.mdx b/client-sdks/python/api-reference/components/messagesmessageparamcontentunion4.mdx deleted file mode 100644 index 28996ed6..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion4.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: MessagesMessageParamContentUnion4 - Python SDK -sidebarTitle: MessagesMessageParamContentUnion4 -description: MessagesMessageParamContentUnion4 method reference -seoTitle: MessagesMessageParamContentUnion4 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamcontentunion4 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion4 | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamContentUnion4 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion4%20-%20Python%20SDK&description=MessagesMessageParamContentUnion4%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicTextBlockParam` - -```python lines -value: components.AnthropicTextBlockParam = /* values here */ -``` - -### `components.AnthropicImageBlockParam` - -```python lines -value: components.AnthropicImageBlockParam = /* values here */ -``` - -### `components.AnthropicDocumentBlockParam` - -```python lines -value: components.AnthropicDocumentBlockParam = /* values here */ -``` - -### `components.ContentToolUse` - -```python lines -value: components.ContentToolUse = /* values here */ -``` - -### `components.ContentToolResult` - -```python lines -value: components.ContentToolResult = /* values here */ -``` - -### `components.ContentThinking` - -```python lines -value: components.ContentThinking = /* values here */ -``` - -### `components.ContentRedactedThinking` - -```python lines -value: components.ContentRedactedThinking = /* values here */ -``` - -### `components.ContentServerToolUse` - -```python lines -value: components.ContentServerToolUse = /* values here */ -``` - -### `components.ContentWebSearchToolResult` - -```python lines -value: components.ContentWebSearchToolResult = /* values here */ -``` - -### `components.AnthropicSearchResultBlockParam` - -```python lines -value: components.AnthropicSearchResultBlockParam = /* values here */ -``` - -### `components.ContentCompaction` - -```python lines -value: components.ContentCompaction = /* values here */ -``` - -### `components.MessagesAdvisorToolResultBlock` - -```python lines -value: components.MessagesAdvisorToolResultBlock = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion5.mdx b/client-sdks/python/api-reference/components/messagesmessageparamcontentunion5.mdx deleted file mode 100644 index 1eac76b4..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamcontentunion5.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: MessagesMessageParamContentUnion5 - Python SDK -sidebarTitle: MessagesMessageParamContentUnion5 -description: MessagesMessageParamContentUnion5 method reference -seoTitle: MessagesMessageParamContentUnion5 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamcontentunion5 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion5 | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamContentUnion5 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion5%20-%20Python%20SDK&description=MessagesMessageParamContentUnion5%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.MessagesMessageParamContentUnion4]` - -```python lines -value: List[components.MessagesMessageParamContentUnion4] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamrole.mdx b/client-sdks/python/api-reference/components/messagesmessageparamrole.mdx deleted file mode 100644 index c6c1c92c..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamrole.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: MessagesMessageParamRole - Python SDK -sidebarTitle: MessagesMessageParamRole -description: MessagesMessageParamRole method reference -seoTitle: MessagesMessageParamRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamrole -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamRole | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamRole%20-%20Python%20SDK&description=MessagesMessageParamRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `USER` | user | -| `ASSISTANT` | assistant | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesmessageparamtypecompaction.mdx b/client-sdks/python/api-reference/components/messagesmessageparamtypecompaction.mdx deleted file mode 100644 index 9efaf4cd..00000000 --- a/client-sdks/python/api-reference/components/messagesmessageparamtypecompaction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MessagesMessageParamTypeCompaction - Python SDK -sidebarTitle: MessagesMessageParamTypeCompaction -description: MessagesMessageParamTypeCompaction method reference -seoTitle: MessagesMessageParamTypeCompaction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesmessageparamtypecompaction -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamTypeCompaction | OpenRouter Python SDK -'og:description': >- - MessagesMessageParamTypeCompaction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamTypeCompaction%20-%20Python%20SDK&description=MessagesMessageParamTypeCompaction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMPACTION` | compaction | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesoutputconfig.mdx b/client-sdks/python/api-reference/components/messagesoutputconfig.mdx deleted file mode 100644 index ffb8693a..00000000 --- a/client-sdks/python/api-reference/components/messagesoutputconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: MessagesOutputConfig - Python SDK -sidebarTitle: MessagesOutputConfig -description: MessagesOutputConfig method reference -seoTitle: MessagesOutputConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesoutputconfig -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfig | OpenRouter Python SDK -'og:description': >- - MessagesOutputConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfig%20-%20Python%20SDK&description=MessagesOutputConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for controlling output behavior. Supports the effort parameter and structured output format. - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.MessagesOutputConfigEffort]](../components/messagesoutputconfigeffort.md) | :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[components.MessagesOutputConfigFormat]](../components/messagesoutputconfigformat.md) | :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). | | -| `task_budget` | [OptionalNullable[components.TaskBudget]](../components/taskbudget.md) | :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/client-sdks/python/api-reference/components/messagesoutputconfigeffort.mdx b/client-sdks/python/api-reference/components/messagesoutputconfigeffort.mdx deleted file mode 100644 index 4f80e719..00000000 --- a/client-sdks/python/api-reference/components/messagesoutputconfigeffort.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: MessagesOutputConfigEffort - Python SDK -sidebarTitle: MessagesOutputConfigEffort -description: MessagesOutputConfigEffort method reference -seoTitle: MessagesOutputConfigEffort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesoutputconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigEffort | OpenRouter Python SDK -'og:description': >- - MessagesOutputConfigEffort method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigEffort%20-%20Python%20SDK&description=MessagesOutputConfigEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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`. - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | -| `XHIGH` | xhigh | -| `MAX` | max | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesoutputconfigformat.mdx b/client-sdks/python/api-reference/components/messagesoutputconfigformat.mdx deleted file mode 100644 index 8ea2b546..00000000 --- a/client-sdks/python/api-reference/components/messagesoutputconfigformat.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MessagesOutputConfigFormat - Python SDK -sidebarTitle: MessagesOutputConfigFormat -description: MessagesOutputConfigFormat method reference -seoTitle: MessagesOutputConfigFormat | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesoutputconfigformat -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigFormat | OpenRouter Python SDK -'og:description': >- - MessagesOutputConfigFormat method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigFormat%20-%20Python%20SDK&description=MessagesOutputConfigFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `schema_` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `type` | [components.MessagesOutputConfigTypeJSONSchema](/client-sdks/python/api-reference/components/messagesoutputconfigtypejsonschema) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesoutputconfigtypejsonschema.mdx b/client-sdks/python/api-reference/components/messagesoutputconfigtypejsonschema.mdx deleted file mode 100644 index f931115b..00000000 --- a/client-sdks/python/api-reference/components/messagesoutputconfigtypejsonschema.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MessagesOutputConfigTypeJSONSchema - Python SDK -sidebarTitle: MessagesOutputConfigTypeJSONSchema -description: MessagesOutputConfigTypeJSONSchema method reference -seoTitle: MessagesOutputConfigTypeJSONSchema | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesoutputconfigtypejsonschema -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigTypeJSONSchema | OpenRouter Python SDK -'og:description': >- - MessagesOutputConfigTypeJSONSchema method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigTypeJSONSchema%20-%20Python%20SDK&description=MessagesOutputConfigTypeJSONSchema%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_SCHEMA` | json_schema | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesrequest.mdx b/client-sdks/python/api-reference/components/messagesrequest.mdx deleted file mode 100644 index f01e5c7b..00000000 --- a/client-sdks/python/api-reference/components/messagesrequest.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: MessagesRequest - Python SDK -sidebarTitle: MessagesRequest -description: MessagesRequest method reference -seoTitle: MessagesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesrequest -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequest | OpenRouter Python SDK -'og:description': >- - MessagesRequest method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequest%20-%20Python%20SDK&description=MessagesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request schema for Anthropic Messages API endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `context_management` | [OptionalNullable[components.ContextManagement]](../components/contextmanagement.md) | :heavy_minus_sign: | N/A | | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `messages` | List[[components.MessagesMessageParam](/client-sdks/python/api-reference/components/messagesmessageparam)] | :heavy_check_mark: | N/A | | -| `metadata` | [Optional[components.Metadata]](../components/metadata.md) | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](../components/messagesoutputconfig.md) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | `{"effort": "medium"}` | -| `plugins` | List[[components.MessagesRequestPlugin](/client-sdks/python/api-reference/components/messagesrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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[components.Speed]](../components/speed.md) | :heavy_minus_sign: | N/A | standard | -| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `system` | [Optional[components.System]](../components/system.md) | :heavy_minus_sign: | N/A | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `thinking` | [Optional[components.Thinking]](../components/thinking.md) | :heavy_minus_sign: | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](../components/toolchoice.md) | :heavy_minus_sign: | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](/client-sdks/python/api-reference/components/messagesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../components/traceconfig.md) | :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` | *Optional[str]* | :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/client-sdks/python/api-reference/components/messagesrequestplugin.mdx b/client-sdks/python/api-reference/components/messagesrequestplugin.mdx deleted file mode 100644 index 93b85f6f..00000000 --- a/client-sdks/python/api-reference/components/messagesrequestplugin.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: MessagesRequestPlugin - Python SDK -sidebarTitle: MessagesRequestPlugin -description: MessagesRequestPlugin method reference -seoTitle: MessagesRequestPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestPlugin | OpenRouter Python SDK -'og:description': >- - MessagesRequestPlugin method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestPlugin%20-%20Python%20SDK&description=MessagesRequestPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AutoRouterPlugin` - -```python lines -value: components.AutoRouterPlugin = /* values here */ -``` - -### `components.ContextCompressionPlugin` - -```python lines -value: components.ContextCompressionPlugin = /* values here */ -``` - -### `components.FileParserPlugin` - -```python lines -value: components.FileParserPlugin = /* values here */ -``` - -### `components.FusionPlugin` - -```python lines -value: components.FusionPlugin = /* values here */ -``` - -### `components.ModerationPlugin` - -```python lines -value: components.ModerationPlugin = /* values here */ -``` - -### `components.ParetoRouterPlugin` - -```python lines -value: components.ParetoRouterPlugin = /* values here */ -``` - -### `components.ResponseHealingPlugin` - -```python lines -value: components.ResponseHealingPlugin = /* values here */ -``` - -### `components.WebSearchPlugin` - -```python lines -value: components.WebSearchPlugin = /* values here */ -``` - -### `components.WebFetchPlugin` - -```python lines -value: components.WebFetchPlugin = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesrequesttool.mdx b/client-sdks/python/api-reference/components/messagesrequesttool.mdx deleted file mode 100644 index 7d50e182..00000000 --- a/client-sdks/python/api-reference/components/messagesrequesttool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: MessagesRequestTool - Python SDK -sidebarTitle: MessagesRequestTool -description: MessagesRequestTool method reference -seoTitle: MessagesRequestTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesrequesttool -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestTool | OpenRouter Python SDK -'og:description': >- - MessagesRequestTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestTool%20-%20Python%20SDK&description=MessagesRequestTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/messagesrequesttoolunion.mdx b/client-sdks/python/api-reference/components/messagesrequesttoolunion.mdx deleted file mode 100644 index 35e0eecd..00000000 --- a/client-sdks/python/api-reference/components/messagesrequesttoolunion.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: MessagesRequestToolUnion - Python SDK -sidebarTitle: MessagesRequestToolUnion -description: MessagesRequestToolUnion method reference -seoTitle: MessagesRequestToolUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/messagesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestToolUnion | OpenRouter Python SDK -'og:description': >- - MessagesRequestToolUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestToolUnion%20-%20Python%20SDK&description=MessagesRequestToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ToolCustom` - -```python lines -value: components.ToolCustom = /* values here */ -``` - -### `components.ToolBash20250124` - -```python lines -value: components.ToolBash20250124 = /* values here */ -``` - -### `components.ToolTextEditor20250124` - -```python lines -value: components.ToolTextEditor20250124 = /* values here */ -``` - -### `components.ToolWebSearch20250305` - -```python lines -value: components.ToolWebSearch20250305 = /* values here */ -``` - -### `components.ToolWebSearch20260209` - -```python lines -value: components.ToolWebSearch20260209 = /* values here */ -``` - -### `components.ToolAdvisor20260301` - -```python lines -value: components.ToolAdvisor20260301 = /* values here */ -``` - -### `components.DatetimeServerTool` - -```python lines -value: components.DatetimeServerTool = /* values here */ -``` - -### `components.ImageGenerationServerToolOpenRouter` - -```python lines -value: components.ImageGenerationServerToolOpenRouter = /* values here */ -``` - -### `components.ChatSearchModelsServerTool` - -```python lines -value: components.ChatSearchModelsServerTool = /* values here */ -``` - -### `components.WebFetchServerTool` - -```python lines -value: components.WebFetchServerTool = /* values here */ -``` - -### `components.OpenRouterWebSearchServerTool` - -```python lines -value: components.OpenRouterWebSearchServerTool = /* values here */ -``` - -### `components.MessagesRequestTool` - -```python lines -value: components.MessagesRequestTool = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/metadata.mdx b/client-sdks/python/api-reference/components/metadata.mdx deleted file mode 100644 index 346a0e5f..00000000 --- a/client-sdks/python/api-reference/components/metadata.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Metadata - Python SDK -sidebarTitle: Metadata -description: Metadata method reference -seoTitle: Metadata | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/metadata' -'og:site_name': OpenRouter Documentation -'og:title': Metadata | OpenRouter Python SDK -'og:description': >- - Metadata method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Metadata%20-%20Python%20SDK&description=Metadata%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/metadatalevel.mdx b/client-sdks/python/api-reference/components/metadatalevel.mdx deleted file mode 100644 index 677c72c9..00000000 --- a/client-sdks/python/api-reference/components/metadatalevel.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: MetadataLevel - Python SDK -sidebarTitle: MetadataLevel -description: MetadataLevel method reference -seoTitle: MetadataLevel | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/metadatalevel' -'og:site_name': OpenRouter Documentation -'og:title': MetadataLevel | OpenRouter Python SDK -'og:description': >- - MetadataLevel method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MetadataLevel%20-%20Python%20SDK&description=MetadataLevel%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Opt-in level for surfacing routing metadata on the response under `openrouter_metadata`. - -## Values - -| Name | Value | -| ---------- | ---------- | -| `DISABLED` | disabled | -| `ENABLED` | enabled | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/method.mdx b/client-sdks/python/api-reference/components/method.mdx deleted file mode 100644 index 7ff88b64..00000000 --- a/client-sdks/python/api-reference/components/method.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Method - Python SDK -sidebarTitle: Method -description: Method method reference -seoTitle: Method | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/method' -'og:site_name': OpenRouter Documentation -'og:title': Method | OpenRouter Python SDK -'og:description': >- - Method method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Method%20-%20Python%20SDK&description=Method%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `POST` | POST | -| `PUT` | PUT | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modality.mdx b/client-sdks/python/api-reference/components/modality.mdx deleted file mode 100644 index 30775676..00000000 --- a/client-sdks/python/api-reference/components/modality.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Modality - Python SDK -sidebarTitle: Modality -description: Modality method reference -seoTitle: Modality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/modality' -'og:site_name': OpenRouter Documentation -'og:title': Modality | OpenRouter Python SDK -'og:description': >- - Modality method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Modality%20-%20Python%20SDK&description=Modality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | -| `AUDIO` | audio | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/mode.mdx b/client-sdks/python/api-reference/components/mode.mdx deleted file mode 100644 index 6d1cd5bf..00000000 --- a/client-sdks/python/api-reference/components/mode.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Mode - Python SDK -sidebarTitle: Mode -description: Mode method reference -seoTitle: Mode | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/mode' -'og:site_name': OpenRouter Documentation -'og:title': Mode | OpenRouter Python SDK -'og:description': >- - Mode method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Mode%20-%20Python%20SDK&description=Mode%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ModeAuto` - -```python lines -value: components.ModeAuto = /* values here */ -``` - -### `components.ModeRequired` - -```python lines -value: components.ModeRequired = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modeauto.mdx b/client-sdks/python/api-reference/components/modeauto.mdx deleted file mode 100644 index cf4b60cd..00000000 --- a/client-sdks/python/api-reference/components/modeauto.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ModeAuto - Python SDK -sidebarTitle: ModeAuto -description: ModeAuto method reference -seoTitle: ModeAuto | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/modeauto' -'og:site_name': OpenRouter Documentation -'og:title': ModeAuto | OpenRouter Python SDK -'og:description': >- - ModeAuto method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeAuto%20-%20Python%20SDK&description=ModeAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/model.mdx b/client-sdks/python/api-reference/components/model.mdx deleted file mode 100644 index 7fd1157d..00000000 --- a/client-sdks/python/api-reference/components/model.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Model - Python SDK -sidebarTitle: Model -description: Model method reference -seoTitle: Model | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/model' -'og:site_name': OpenRouter Documentation -'og:title': Model | OpenRouter Python SDK -'og:description': >- - Model method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Model%20-%20Python%20SDK&description=Model%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about an AI model available on OpenRouter - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [components.ModelArchitecture](/client-sdks/python/api-reference/components/modelarchitecture) | :heavy_check_mark: | Model architecture information | `{"input_modalities": ["text"],"instruct_type": "chatml","modality": "text-\u003etext","output_modalities": ["text"],"tokenizer": "GPT"}` | -| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `context_length` | *Nullable[int]* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :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` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `expiration_date` | *OptionalNullable[str]* | :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 | -| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `knowledge_cutoff` | *OptionalNullable[str]* | :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](/client-sdks/python/api-reference/components/modellinks) | :heavy_check_mark: | Related API endpoints and resources for this model. | `{"details": "/api/v1/models/openai/gpt-5.4/endpoints"}` | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | `{"completion_tokens": 1000,"prompt_tokens": 1000}` | -| `pricing` | [components.PublicPricing](/client-sdks/python/api-reference/components/publicpricing) | :heavy_check_mark: | Pricing information for the model | `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}` | -| `supported_parameters` | List[[components.Parameter](/client-sdks/python/api-reference/components/parameter)] | :heavy_check_mark: | List of supported parameters for this model | | -| `supported_voices` | List[*str*] | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | `` | -| `top_provider` | [components.TopProviderInfo](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/modelarchitecture.mdx b/client-sdks/python/api-reference/components/modelarchitecture.mdx deleted file mode 100644 index 51a9ad2a..00000000 --- a/client-sdks/python/api-reference/components/modelarchitecture.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ModelArchitecture - Python SDK -sidebarTitle: ModelArchitecture -description: ModelArchitecture method reference -seoTitle: ModelArchitecture | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/modelarchitecture -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitecture | OpenRouter Python SDK -'og:description': >- - ModelArchitecture method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitecture%20-%20Python%20SDK&description=ModelArchitecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `input_modalities` | List[[components.InputModality](/client-sdks/python/api-reference/components/inputmodality)] | :heavy_check_mark: | Supported input modalities | | -| `instruct_type` | [OptionalNullable[components.ModelArchitectureInstructType]](../components/modelarchitectureinstructtype.md) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text | -| `output_modalities` | List[[components.OutputModality](/client-sdks/python/api-reference/components/outputmodality)] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.md) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelarchitectureinstructtype.mdx b/client-sdks/python/api-reference/components/modelarchitectureinstructtype.mdx deleted file mode 100644 index acd19519..00000000 --- a/client-sdks/python/api-reference/components/modelarchitectureinstructtype.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ModelArchitectureInstructType - Python SDK -sidebarTitle: ModelArchitectureInstructType -description: ModelArchitectureInstructType method reference -seoTitle: ModelArchitectureInstructType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/modelarchitectureinstructtype -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitectureInstructType | OpenRouter Python SDK -'og:description': >- - ModelArchitectureInstructType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitectureInstructType%20-%20Python%20SDK&description=ModelArchitectureInstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Values - -| Name | Value | -| --------------- | --------------- | -| `NONE` | none | -| `AIROBOROS` | airoboros | -| `ALPACA` | alpaca | -| `ALPACA_MODIF` | alpaca-modif | -| `CHATML` | chatml | -| `CLAUDE` | claude | -| `CODE_LLAMA` | code-llama | -| `GEMMA` | gemma | -| `LLAMA2` | llama2 | -| `LLAMA3` | llama3 | -| `MISTRAL` | mistral | -| `NEMOTRON` | nemotron | -| `NEURAL` | neural | -| `OPENCHAT` | openchat | -| `PHI3` | phi3 | -| `RWKV` | rwkv | -| `VICUNA` | vicuna | -| `ZEPHYR` | zephyr | -| `DEEPSEEK_R1` | deepseek-r1 | -| `DEEPSEEK_V3_1` | deepseek-v3.1 | -| `QWQ` | qwq | -| `QWEN3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelenum.mdx b/client-sdks/python/api-reference/components/modelenum.mdx deleted file mode 100644 index 9b273dfb..00000000 --- a/client-sdks/python/api-reference/components/modelenum.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModelEnum - Python SDK -sidebarTitle: ModelEnum -description: ModelEnum method reference -seoTitle: ModelEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/modelenum' -'og:site_name': OpenRouter Documentation -'og:title': ModelEnum | OpenRouter Python SDK -'og:description': >- - ModelEnum method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelEnum%20-%20Python%20SDK&description=ModelEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `GPT_IMAGE_1` | gpt-image-1 | -| `GPT_IMAGE_1_MINI` | gpt-image-1-mini | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelgroup.mdx b/client-sdks/python/api-reference/components/modelgroup.mdx deleted file mode 100644 index c86f3901..00000000 --- a/client-sdks/python/api-reference/components/modelgroup.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ModelGroup - Python SDK -sidebarTitle: ModelGroup -description: ModelGroup method reference -seoTitle: ModelGroup | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/modelgroup' -'og:site_name': OpenRouter Documentation -'og:title': ModelGroup | OpenRouter Python SDK -'og:description': >- - ModelGroup method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelGroup%20-%20Python%20SDK&description=ModelGroup%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ROUTER` | Router | -| `MEDIA` | Media | -| `OTHER` | Other | -| `GPT` | GPT | -| `CLAUDE` | Claude | -| `GEMINI` | Gemini | -| `GEMMA` | Gemma | -| `GROK` | Grok | -| `COHERE` | Cohere | -| `NOVA` | Nova | -| `QWEN` | Qwen | -| `YI` | Yi | -| `DEEP_SEEK` | DeepSeek | -| `MISTRAL` | Mistral | -| `LLAMA2` | Llama2 | -| `LLAMA3` | Llama3 | -| `LLAMA4` | Llama4 | -| `PA_LM` | PaLM | -| `RWKV` | RWKV | -| `QWEN3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modellinks.mdx b/client-sdks/python/api-reference/components/modellinks.mdx deleted file mode 100644 index 6675ad63..00000000 --- a/client-sdks/python/api-reference/components/modellinks.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ModelLinks - Python SDK -sidebarTitle: ModelLinks -description: ModelLinks method reference -seoTitle: ModelLinks | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/modellinks' -'og:site_name': OpenRouter Documentation -'og:title': ModelLinks | OpenRouter Python SDK -'og:description': >- - ModelLinks method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelLinks%20-%20Python%20SDK&description=ModelLinks%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Related API endpoints and resources for this model. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `details` | *str* | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelscountresponse.mdx b/client-sdks/python/api-reference/components/modelscountresponse.mdx deleted file mode 100644 index 3099e229..00000000 --- a/client-sdks/python/api-reference/components/modelscountresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ModelsCountResponse - Python SDK -sidebarTitle: ModelsCountResponse -description: ModelsCountResponse method reference -seoTitle: ModelsCountResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/modelscountresponse -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponse | OpenRouter Python SDK -'og:description': >- - ModelsCountResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponse%20-%20Python%20SDK&description=ModelsCountResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [components.ModelsCountResponseData](/client-sdks/python/api-reference/components/modelscountresponsedata) | :heavy_check_mark: | Model count data | `{"count": 150}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelscountresponsedata.mdx b/client-sdks/python/api-reference/components/modelscountresponsedata.mdx deleted file mode 100644 index d50e6a40..00000000 --- a/client-sdks/python/api-reference/components/modelscountresponsedata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ModelsCountResponseData - Python SDK -sidebarTitle: ModelsCountResponseData -description: ModelsCountResponseData method reference -seoTitle: ModelsCountResponseData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/modelscountresponsedata -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponseData | OpenRouter Python SDK -'og:description': >- - ModelsCountResponseData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponseData%20-%20Python%20SDK&description=ModelsCountResponseData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *int* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/modelslistresponse.mdx b/client-sdks/python/api-reference/components/modelslistresponse.mdx deleted file mode 100644 index 2f15f8f5..00000000 --- a/client-sdks/python/api-reference/components/modelslistresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ModelsListResponse - Python SDK -sidebarTitle: ModelsListResponse -description: ModelsListResponse method reference -seoTitle: ModelsListResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/modelslistresponse -'og:site_name': OpenRouter Documentation -'og:title': ModelsListResponse | OpenRouter Python SDK -'og:description': >- - ModelsListResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsListResponse%20-%20Python%20SDK&description=ModelsListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of available models - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | List[[components.Model](/client-sdks/python/api-reference/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-5.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}`
\}
] | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/moderation.mdx b/client-sdks/python/api-reference/components/moderation.mdx deleted file mode 100644 index be6f92e1..00000000 --- a/client-sdks/python/api-reference/components/moderation.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Moderation - Python SDK -sidebarTitle: Moderation -description: Moderation method reference -seoTitle: Moderation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/moderation' -'og:site_name': OpenRouter Documentation -'og:title': Moderation | OpenRouter Python SDK -'og:description': >- - Moderation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Moderation%20-%20Python%20SDK&description=Moderation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `LOW` | low | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/moderationplugin.mdx b/client-sdks/python/api-reference/components/moderationplugin.mdx deleted file mode 100644 index 2c0637e2..00000000 --- a/client-sdks/python/api-reference/components/moderationplugin.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModerationPlugin - Python SDK -sidebarTitle: ModerationPlugin -description: ModerationPlugin method reference -seoTitle: ModerationPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/moderationplugin -'og:site_name': OpenRouter Documentation -'og:title': ModerationPlugin | OpenRouter Python SDK -'og:description': >- - ModerationPlugin method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModerationPlugin%20-%20Python%20SDK&description=ModerationPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `id` | [components.ModerationPluginID](/client-sdks/python/api-reference/components/moderationpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/moderationpluginid.mdx b/client-sdks/python/api-reference/components/moderationpluginid.mdx deleted file mode 100644 index a28ec69f..00000000 --- a/client-sdks/python/api-reference/components/moderationpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModerationPluginID - Python SDK -sidebarTitle: ModerationPluginID -description: ModerationPluginID method reference -seoTitle: ModerationPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/moderationpluginid -'og:site_name': OpenRouter Documentation -'og:title': ModerationPluginID | OpenRouter Python SDK -'og:description': >- - ModerationPluginID method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModerationPluginID%20-%20Python%20SDK&description=ModerationPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `MODERATION` | moderation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/moderequired.mdx b/client-sdks/python/api-reference/components/moderequired.mdx deleted file mode 100644 index 104731d9..00000000 --- a/client-sdks/python/api-reference/components/moderequired.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ModeRequired - Python SDK -sidebarTitle: ModeRequired -description: ModeRequired method reference -seoTitle: ModeRequired | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/moderequired' -'og:site_name': OpenRouter Documentation -'og:title': ModeRequired | OpenRouter Python SDK -'og:description': >- - ModeRequired method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeRequired%20-%20Python%20SDK&description=ModeRequired%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `REQUIRED` | required | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/multimodalmedia.mdx b/client-sdks/python/api-reference/components/multimodalmedia.mdx deleted file mode 100644 index 6cdad263..00000000 --- a/client-sdks/python/api-reference/components/multimodalmedia.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: MultimodalMedia - Python SDK -sidebarTitle: MultimodalMedia -description: MultimodalMedia method reference -seoTitle: MultimodalMedia | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/multimodalmedia -'og:site_name': OpenRouter Documentation -'og:title': MultimodalMedia | OpenRouter Python SDK -'og:description': >- - MultimodalMedia method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MultimodalMedia%20-%20Python%20SDK&description=MultimodalMedia%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/nameadvisor.mdx b/client-sdks/python/api-reference/components/nameadvisor.mdx deleted file mode 100644 index ca94f6ec..00000000 --- a/client-sdks/python/api-reference/components/nameadvisor.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: NameAdvisor - Python SDK -sidebarTitle: NameAdvisor -description: NameAdvisor method reference -seoTitle: NameAdvisor | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/nameadvisor' -'og:site_name': OpenRouter Documentation -'og:title': NameAdvisor | OpenRouter Python SDK -'og:description': >- - NameAdvisor method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameAdvisor%20-%20Python%20SDK&description=NameAdvisor%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `ADVISOR` | advisor | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/namebash.mdx b/client-sdks/python/api-reference/components/namebash.mdx deleted file mode 100644 index 0671a989..00000000 --- a/client-sdks/python/api-reference/components/namebash.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: NameBash - Python SDK -sidebarTitle: NameBash -description: NameBash method reference -seoTitle: NameBash | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/namebash' -'og:site_name': OpenRouter Documentation -'og:title': NameBash | OpenRouter Python SDK -'og:description': >- - NameBash method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameBash%20-%20Python%20SDK&description=NameBash%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `BASH` | bash | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/namestrreplaceeditor.mdx b/client-sdks/python/api-reference/components/namestrreplaceeditor.mdx deleted file mode 100644 index 3fe364f6..00000000 --- a/client-sdks/python/api-reference/components/namestrreplaceeditor.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: NameStrReplaceEditor - Python SDK -sidebarTitle: NameStrReplaceEditor -description: NameStrReplaceEditor method reference -seoTitle: NameStrReplaceEditor | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/namestrreplaceeditor -'og:site_name': OpenRouter Documentation -'og:title': NameStrReplaceEditor | OpenRouter Python SDK -'og:description': >- - NameStrReplaceEditor method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameStrReplaceEditor%20-%20Python%20SDK&description=NameStrReplaceEditor%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `STR_REPLACE_EDITOR` | str_replace_editor | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/namewebsearch1.mdx b/client-sdks/python/api-reference/components/namewebsearch1.mdx deleted file mode 100644 index 3079ea86..00000000 --- a/client-sdks/python/api-reference/components/namewebsearch1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: NameWebSearch1 - Python SDK -sidebarTitle: NameWebSearch1 -description: NameWebSearch1 method reference -seoTitle: NameWebSearch1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/namewebsearch1' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch1 | OpenRouter Python SDK -'og:description': >- - NameWebSearch1 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch1%20-%20Python%20SDK&description=NameWebSearch1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `WEB_SEARCH` | web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/namewebsearch2.mdx b/client-sdks/python/api-reference/components/namewebsearch2.mdx deleted file mode 100644 index e80a2515..00000000 --- a/client-sdks/python/api-reference/components/namewebsearch2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: NameWebSearch2 - Python SDK -sidebarTitle: NameWebSearch2 -description: NameWebSearch2 method reference -seoTitle: NameWebSearch2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/namewebsearch2' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch2 | OpenRouter Python SDK -'og:description': >- - NameWebSearch2 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch2%20-%20Python%20SDK&description=NameWebSearch2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `WEB_SEARCH` | web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/never.mdx b/client-sdks/python/api-reference/components/never.mdx deleted file mode 100644 index 1e36d38a..00000000 --- a/client-sdks/python/api-reference/components/never.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Never - Python SDK -sidebarTitle: Never -description: Never method reference -seoTitle: Never | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/never' -'og:site_name': OpenRouter Documentation -'og:title': Never | OpenRouter Python SDK -'og:description': >- - Never method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Never%20-%20Python%20SDK&description=Never%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `tool_names` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/notfoundresponseerrordata.mdx b/client-sdks/python/api-reference/components/notfoundresponseerrordata.mdx deleted file mode 100644 index 8935d64a..00000000 --- a/client-sdks/python/api-reference/components/notfoundresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: NotFoundResponseErrorData - Python SDK -sidebarTitle: NotFoundResponseErrorData -description: NotFoundResponseErrorData method reference -seoTitle: NotFoundResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/notfoundresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseErrorData | OpenRouter Python SDK -'og:description': >- - NotFoundResponseErrorData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseErrorData%20-%20Python%20SDK&description=NotFoundResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for NotFoundResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityarizedestination.mdx b/client-sdks/python/api-reference/components/observabilityarizedestination.mdx deleted file mode 100644 index 6bd0460a..00000000 --- a/client-sdks/python/api-reference/components/observabilityarizedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityArizeDestination - Python SDK -sidebarTitle: ObservabilityArizeDestination -description: ObservabilityArizeDestination method reference -seoTitle: ObservabilityArizeDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityarizedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityArizeDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestination%20-%20Python%20SDK&description=ObservabilityArizeDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityArizeDestinationConfig](/client-sdks/python/api-reference/components/observabilityarizedestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityArizeDestinationType](/client-sdks/python/api-reference/components/observabilityarizedestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityarizedestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityarizedestinationconfig.mdx deleted file mode 100644 index 09ace48c..00000000 --- a/client-sdks/python/api-reference/components/observabilityarizedestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityArizeDestinationConfig - Python SDK -sidebarTitle: ObservabilityArizeDestinationConfig -description: ObservabilityArizeDestinationConfig method reference -seoTitle: ObservabilityArizeDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityarizedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityArizeDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestinationConfig%20-%20Python%20SDK&description=ObservabilityArizeDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `model_id` | *str* | :heavy_check_mark: | N/A | -| `space_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityarizedestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityarizedestinationtype.mdx deleted file mode 100644 index ff101ce1..00000000 --- a/client-sdks/python/api-reference/components/observabilityarizedestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityArizeDestinationType - Python SDK -sidebarTitle: ObservabilityArizeDestinationType -description: ObservabilityArizeDestinationType method reference -seoTitle: ObservabilityArizeDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityarizedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityArizeDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestinationType%20-%20Python%20SDK&description=ObservabilityArizeDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `ARIZE` | arize | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitybraintrustdestination.mdx b/client-sdks/python/api-reference/components/observabilitybraintrustdestination.mdx deleted file mode 100644 index be7c07f3..00000000 --- a/client-sdks/python/api-reference/components/observabilitybraintrustdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityBraintrustDestination - Python SDK -sidebarTitle: ObservabilityBraintrustDestination -description: ObservabilityBraintrustDestination method reference -seoTitle: ObservabilityBraintrustDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitybraintrustdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityBraintrustDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestination%20-%20Python%20SDK&description=ObservabilityBraintrustDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityBraintrustDestinationConfig](/client-sdks/python/api-reference/components/observabilitybraintrustdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityBraintrustDestinationType](/client-sdks/python/api-reference/components/observabilitybraintrustdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitybraintrustdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitybraintrustdestinationconfig.mdx deleted file mode 100644 index 7c403bca..00000000 --- a/client-sdks/python/api-reference/components/observabilitybraintrustdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityBraintrustDestinationConfig - Python SDK -sidebarTitle: ObservabilityBraintrustDestinationConfig -description: ObservabilityBraintrustDestinationConfig method reference -seoTitle: ObservabilityBraintrustDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitybraintrustdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityBraintrustDestinationConfig method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestinationConfig%20-%20Python%20SDK&description=ObservabilityBraintrustDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitybraintrustdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitybraintrustdestinationtype.mdx deleted file mode 100644 index 391748d2..00000000 --- a/client-sdks/python/api-reference/components/observabilitybraintrustdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityBraintrustDestinationType - Python SDK -sidebarTitle: ObservabilityBraintrustDestinationType -description: ObservabilityBraintrustDestinationType method reference -seoTitle: ObservabilityBraintrustDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitybraintrustdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityBraintrustDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestinationType%20-%20Python%20SDK&description=ObservabilityBraintrustDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `BRAINTRUST` | braintrust | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityclickhousedestination.mdx b/client-sdks/python/api-reference/components/observabilityclickhousedestination.mdx deleted file mode 100644 index e6df43a9..00000000 --- a/client-sdks/python/api-reference/components/observabilityclickhousedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityClickhouseDestination - Python SDK -sidebarTitle: ObservabilityClickhouseDestination -description: ObservabilityClickhouseDestination method reference -seoTitle: ObservabilityClickhouseDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityclickhousedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityClickhouseDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestination%20-%20Python%20SDK&description=ObservabilityClickhouseDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityClickhouseDestinationConfig](/client-sdks/python/api-reference/components/observabilityclickhousedestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityClickhouseDestinationType](/client-sdks/python/api-reference/components/observabilityclickhousedestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityclickhousedestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityclickhousedestinationconfig.mdx deleted file mode 100644 index 060c016d..00000000 --- a/client-sdks/python/api-reference/components/observabilityclickhousedestinationconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ObservabilityClickhouseDestinationConfig - Python SDK -sidebarTitle: ObservabilityClickhouseDestinationConfig -description: ObservabilityClickhouseDestinationConfig method reference -seoTitle: ObservabilityClickhouseDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityclickhousedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityClickhouseDestinationConfig method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestinationConfig%20-%20Python%20SDK&description=ObservabilityClickhouseDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `database` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `host` | *str* | :heavy_check_mark: | N/A | -| `password` | *str* | :heavy_check_mark: | N/A | -| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `username` | *str* | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityclickhousedestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityclickhousedestinationtype.mdx deleted file mode 100644 index 23b10aa8..00000000 --- a/client-sdks/python/api-reference/components/observabilityclickhousedestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityClickhouseDestinationType - Python SDK -sidebarTitle: ObservabilityClickhouseDestinationType -description: ObservabilityClickhouseDestinationType method reference -seoTitle: ObservabilityClickhouseDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityclickhousedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityClickhouseDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestinationType%20-%20Python%20SDK&description=ObservabilityClickhouseDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `CLICKHOUSE` | clickhouse | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitydatadogdestination.mdx b/client-sdks/python/api-reference/components/observabilitydatadogdestination.mdx deleted file mode 100644 index 441e677d..00000000 --- a/client-sdks/python/api-reference/components/observabilitydatadogdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityDatadogDestination - Python SDK -sidebarTitle: ObservabilityDatadogDestination -description: ObservabilityDatadogDestination method reference -seoTitle: ObservabilityDatadogDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitydatadogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityDatadogDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestination%20-%20Python%20SDK&description=ObservabilityDatadogDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityDatadogDestinationConfig](/client-sdks/python/api-reference/components/observabilitydatadogdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityDatadogDestinationType](/client-sdks/python/api-reference/components/observabilitydatadogdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitydatadogdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitydatadogdestinationconfig.mdx deleted file mode 100644 index a9a2460b..00000000 --- a/client-sdks/python/api-reference/components/observabilitydatadogdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityDatadogDestinationConfig - Python SDK -sidebarTitle: ObservabilityDatadogDestinationConfig -description: ObservabilityDatadogDestinationConfig method reference -seoTitle: ObservabilityDatadogDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitydatadogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityDatadogDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestinationConfig%20-%20Python%20SDK&description=ObservabilityDatadogDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `ml_app` | *str* | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `url` | *Optional[str]* | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitydatadogdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitydatadogdestinationtype.mdx deleted file mode 100644 index 80139421..00000000 --- a/client-sdks/python/api-reference/components/observabilitydatadogdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityDatadogDestinationType - Python SDK -sidebarTitle: ObservabilityDatadogDestinationType -description: ObservabilityDatadogDestinationType method reference -seoTitle: ObservabilityDatadogDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitydatadogdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityDatadogDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestinationType%20-%20Python%20SDK&description=ObservabilityDatadogDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `DATADOG` | datadog | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitydestination.mdx b/client-sdks/python/api-reference/components/observabilitydestination.mdx deleted file mode 100644 index 06cdf83d..00000000 --- a/client-sdks/python/api-reference/components/observabilitydestination.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: ObservabilityDestination - Python SDK -sidebarTitle: ObservabilityDestination -description: ObservabilityDestination method reference -seoTitle: ObservabilityDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityDestination method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDestination%20-%20Python%20SDK&description=ObservabilityDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ObservabilityArizeDestination` - -```python lines -value: components.ObservabilityArizeDestination = /* values here */ -``` - -### `components.ObservabilityBraintrustDestination` - -```python lines -value: components.ObservabilityBraintrustDestination = /* values here */ -``` - -### `components.ObservabilityClickhouseDestination` - -```python lines -value: components.ObservabilityClickhouseDestination = /* values here */ -``` - -### `components.ObservabilityDatadogDestination` - -```python lines -value: components.ObservabilityDatadogDestination = /* values here */ -``` - -### `components.ObservabilityGrafanaDestination` - -```python lines -value: components.ObservabilityGrafanaDestination = /* values here */ -``` - -### `components.ObservabilityLangfuseDestination` - -```python lines -value: components.ObservabilityLangfuseDestination = /* values here */ -``` - -### `components.ObservabilityLangsmithDestination` - -```python lines -value: components.ObservabilityLangsmithDestination = /* values here */ -``` - -### `components.ObservabilityNewrelicDestination` - -```python lines -value: components.ObservabilityNewrelicDestination = /* values here */ -``` - -### `components.ObservabilityOpikDestination` - -```python lines -value: components.ObservabilityOpikDestination = /* values here */ -``` - -### `components.ObservabilityOtelCollectorDestination` - -```python lines -value: components.ObservabilityOtelCollectorDestination = /* values here */ -``` - -### `components.ObservabilityPosthogDestination` - -```python lines -value: components.ObservabilityPosthogDestination = /* values here */ -``` - -### `components.ObservabilityRampDestination` - -```python lines -value: components.ObservabilityRampDestination = /* values here */ -``` - -### `components.ObservabilityS3Destination` - -```python lines -value: components.ObservabilityS3Destination = /* values here */ -``` - -### `components.ObservabilitySentryDestination` - -```python lines -value: components.ObservabilitySentryDestination = /* values here */ -``` - -### `components.ObservabilitySnowflakeDestination` - -```python lines -value: components.ObservabilitySnowflakeDestination = /* values here */ -``` - -### `components.ObservabilityWeaveDestination` - -```python lines -value: components.ObservabilityWeaveDestination = /* values here */ -``` - -### `components.ObservabilityWebhookDestination` - -```python lines -value: components.ObservabilityWebhookDestination = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityfilterrulesconfig.mdx b/client-sdks/python/api-reference/components/observabilityfilterrulesconfig.mdx deleted file mode 100644 index b4c08209..00000000 --- a/client-sdks/python/api-reference/components/observabilityfilterrulesconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityFilterRulesConfig - Python SDK -sidebarTitle: ObservabilityFilterRulesConfig -description: ObservabilityFilterRulesConfig method reference -seoTitle: ObservabilityFilterRulesConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityfilterrulesconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityFilterRulesConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfig%20-%20Python%20SDK&description=ObservabilityFilterRulesConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Optional structured filter rules controlling which events are forwarded. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `groups` | List[[components.Group](/client-sdks/python/api-reference/components/group)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityfilterrulesconfigvalue.mdx b/client-sdks/python/api-reference/components/observabilityfilterrulesconfigvalue.mdx deleted file mode 100644 index 9df8ec58..00000000 --- a/client-sdks/python/api-reference/components/observabilityfilterrulesconfigvalue.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObservabilityFilterRulesConfigValue - Python SDK -sidebarTitle: ObservabilityFilterRulesConfigValue -description: ObservabilityFilterRulesConfigValue method reference -seoTitle: ObservabilityFilterRulesConfigValue | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityfilterrulesconfigvalue -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfigValue | OpenRouter Python SDK -'og:description': >- - ObservabilityFilterRulesConfigValue method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfigValue%20-%20Python%20SDK&description=ObservabilityFilterRulesConfigValue%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitygrafanadestination.mdx b/client-sdks/python/api-reference/components/observabilitygrafanadestination.mdx deleted file mode 100644 index 981e60a8..00000000 --- a/client-sdks/python/api-reference/components/observabilitygrafanadestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityGrafanaDestination - Python SDK -sidebarTitle: ObservabilityGrafanaDestination -description: ObservabilityGrafanaDestination method reference -seoTitle: ObservabilityGrafanaDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitygrafanadestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityGrafanaDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestination%20-%20Python%20SDK&description=ObservabilityGrafanaDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityGrafanaDestinationConfig](/client-sdks/python/api-reference/components/observabilitygrafanadestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityGrafanaDestinationType](/client-sdks/python/api-reference/components/observabilitygrafanadestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitygrafanadestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitygrafanadestinationconfig.mdx deleted file mode 100644 index b64efc43..00000000 --- a/client-sdks/python/api-reference/components/observabilitygrafanadestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityGrafanaDestinationConfig - Python SDK -sidebarTitle: ObservabilityGrafanaDestinationConfig -description: ObservabilityGrafanaDestinationConfig method reference -seoTitle: ObservabilityGrafanaDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitygrafanadestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityGrafanaDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestinationConfig%20-%20Python%20SDK&description=ObservabilityGrafanaDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `instance_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitygrafanadestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitygrafanadestinationtype.mdx deleted file mode 100644 index 6ee0c866..00000000 --- a/client-sdks/python/api-reference/components/observabilitygrafanadestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityGrafanaDestinationType - Python SDK -sidebarTitle: ObservabilityGrafanaDestinationType -description: ObservabilityGrafanaDestinationType method reference -seoTitle: ObservabilityGrafanaDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitygrafanadestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityGrafanaDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestinationType%20-%20Python%20SDK&description=ObservabilityGrafanaDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `GRAFANA` | grafana | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitylangfusedestination.mdx b/client-sdks/python/api-reference/components/observabilitylangfusedestination.mdx deleted file mode 100644 index 8b8424f8..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangfusedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityLangfuseDestination - Python SDK -sidebarTitle: ObservabilityLangfuseDestination -description: ObservabilityLangfuseDestination method reference -seoTitle: ObservabilityLangfuseDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangfusedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityLangfuseDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestination%20-%20Python%20SDK&description=ObservabilityLangfuseDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityLangfuseDestinationConfig](/client-sdks/python/api-reference/components/observabilitylangfusedestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangfuseDestinationType](/client-sdks/python/api-reference/components/observabilitylangfusedestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitylangfusedestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitylangfusedestinationconfig.mdx deleted file mode 100644 index 8e128b6f..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangfusedestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityLangfuseDestinationConfig - Python SDK -sidebarTitle: ObservabilityLangfuseDestinationConfig -description: ObservabilityLangfuseDestinationConfig method reference -seoTitle: ObservabilityLangfuseDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangfusedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityLangfuseDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestinationConfig%20-%20Python%20SDK&description=ObservabilityLangfuseDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `public_key` | *str* | :heavy_check_mark: | N/A | -| `secret_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitylangfusedestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitylangfusedestinationtype.mdx deleted file mode 100644 index 7fc49faa..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangfusedestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityLangfuseDestinationType - Python SDK -sidebarTitle: ObservabilityLangfuseDestinationType -description: ObservabilityLangfuseDestinationType method reference -seoTitle: ObservabilityLangfuseDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangfusedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityLangfuseDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestinationType%20-%20Python%20SDK&description=ObservabilityLangfuseDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `LANGFUSE` | langfuse | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitylangsmithdestination.mdx b/client-sdks/python/api-reference/components/observabilitylangsmithdestination.mdx deleted file mode 100644 index 536f2dcf..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangsmithdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityLangsmithDestination - Python SDK -sidebarTitle: ObservabilityLangsmithDestination -description: ObservabilityLangsmithDestination method reference -seoTitle: ObservabilityLangsmithDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangsmithdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityLangsmithDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestination%20-%20Python%20SDK&description=ObservabilityLangsmithDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityLangsmithDestinationConfig](/client-sdks/python/api-reference/components/observabilitylangsmithdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityLangsmithDestinationType](/client-sdks/python/api-reference/components/observabilitylangsmithdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitylangsmithdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitylangsmithdestinationconfig.mdx deleted file mode 100644 index 4523d333..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangsmithdestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityLangsmithDestinationConfig - Python SDK -sidebarTitle: ObservabilityLangsmithDestinationConfig -description: ObservabilityLangsmithDestinationConfig method reference -seoTitle: ObservabilityLangsmithDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangsmithdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityLangsmithDestinationConfig method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestinationConfig%20-%20Python%20SDK&description=ObservabilityLangsmithDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *Optional[str]* | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitylangsmithdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitylangsmithdestinationtype.mdx deleted file mode 100644 index d7c09dc7..00000000 --- a/client-sdks/python/api-reference/components/observabilitylangsmithdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityLangsmithDestinationType - Python SDK -sidebarTitle: ObservabilityLangsmithDestinationType -description: ObservabilityLangsmithDestinationType method reference -seoTitle: ObservabilityLangsmithDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitylangsmithdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityLangsmithDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestinationType%20-%20Python%20SDK&description=ObservabilityLangsmithDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `LANGSMITH` | langsmith | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitynewrelicdestination.mdx b/client-sdks/python/api-reference/components/observabilitynewrelicdestination.mdx deleted file mode 100644 index d43b88c4..00000000 --- a/client-sdks/python/api-reference/components/observabilitynewrelicdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityNewrelicDestination - Python SDK -sidebarTitle: ObservabilityNewrelicDestination -description: ObservabilityNewrelicDestination method reference -seoTitle: ObservabilityNewrelicDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitynewrelicdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityNewrelicDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestination%20-%20Python%20SDK&description=ObservabilityNewrelicDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityNewrelicDestinationConfig](/client-sdks/python/api-reference/components/observabilitynewrelicdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityNewrelicDestinationType](/client-sdks/python/api-reference/components/observabilitynewrelicdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitynewrelicdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitynewrelicdestinationconfig.mdx deleted file mode 100644 index f362e97f..00000000 --- a/client-sdks/python/api-reference/components/observabilitynewrelicdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityNewrelicDestinationConfig - Python SDK -sidebarTitle: ObservabilityNewrelicDestinationConfig -description: ObservabilityNewrelicDestinationConfig method reference -seoTitle: ObservabilityNewrelicDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitynewrelicdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityNewrelicDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestinationConfig%20-%20Python%20SDK&description=ObservabilityNewrelicDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `license_key` | *str* | :heavy_check_mark: | N/A | -| `region` | [Optional[components.Region]](../components/region.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitynewrelicdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitynewrelicdestinationtype.mdx deleted file mode 100644 index cc42135c..00000000 --- a/client-sdks/python/api-reference/components/observabilitynewrelicdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityNewrelicDestinationType - Python SDK -sidebarTitle: ObservabilityNewrelicDestinationType -description: ObservabilityNewrelicDestinationType method reference -seoTitle: ObservabilityNewrelicDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitynewrelicdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityNewrelicDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestinationType%20-%20Python%20SDK&description=ObservabilityNewrelicDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `NEWRELIC` | newrelic | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityopikdestination.mdx b/client-sdks/python/api-reference/components/observabilityopikdestination.mdx deleted file mode 100644 index be082546..00000000 --- a/client-sdks/python/api-reference/components/observabilityopikdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityOpikDestination - Python SDK -sidebarTitle: ObservabilityOpikDestination -description: ObservabilityOpikDestination method reference -seoTitle: ObservabilityOpikDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityopikdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityOpikDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestination%20-%20Python%20SDK&description=ObservabilityOpikDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityOpikDestinationConfig](/client-sdks/python/api-reference/components/observabilityopikdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOpikDestinationType](/client-sdks/python/api-reference/components/observabilityopikdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityopikdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityopikdestinationconfig.mdx deleted file mode 100644 index b4af71bc..00000000 --- a/client-sdks/python/api-reference/components/observabilityopikdestinationconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ObservabilityOpikDestinationConfig - Python SDK -sidebarTitle: ObservabilityOpikDestinationConfig -description: ObservabilityOpikDestinationConfig method reference -seoTitle: ObservabilityOpikDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityopikdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityOpikDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestinationConfig%20-%20Python%20SDK&description=ObservabilityOpikDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project_name` | *str* | :heavy_check_mark: | N/A | -| `workspace` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityopikdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityopikdestinationtype.mdx deleted file mode 100644 index 6ca2692d..00000000 --- a/client-sdks/python/api-reference/components/observabilityopikdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityOpikDestinationType - Python SDK -sidebarTitle: ObservabilityOpikDestinationType -description: ObservabilityOpikDestinationType method reference -seoTitle: ObservabilityOpikDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityopikdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityOpikDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestinationType%20-%20Python%20SDK&description=ObservabilityOpikDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `OPIK` | opik | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityotelcollectordestination.mdx b/client-sdks/python/api-reference/components/observabilityotelcollectordestination.mdx deleted file mode 100644 index 498dc8ad..00000000 --- a/client-sdks/python/api-reference/components/observabilityotelcollectordestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestination - Python SDK -sidebarTitle: ObservabilityOtelCollectorDestination -description: ObservabilityOtelCollectorDestination method reference -seoTitle: ObservabilityOtelCollectorDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityotelcollectordestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityOtelCollectorDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestination%20-%20Python%20SDK&description=ObservabilityOtelCollectorDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityOtelCollectorDestinationConfig](/client-sdks/python/api-reference/components/observabilityotelcollectordestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityOtelCollectorDestinationType](/client-sdks/python/api-reference/components/observabilityotelcollectordestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityotelcollectordestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityotelcollectordestinationconfig.mdx deleted file mode 100644 index 2f533675..00000000 --- a/client-sdks/python/api-reference/components/observabilityotelcollectordestinationconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestinationConfig - Python SDK -sidebarTitle: ObservabilityOtelCollectorDestinationConfig -description: ObservabilityOtelCollectorDestinationConfig method reference -seoTitle: ObservabilityOtelCollectorDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityotelcollectordestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityOtelCollectorDestinationConfig method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestinationConfig%20-%20Python%20SDK&description=ObservabilityOtelCollectorDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use `{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityotelcollectordestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityotelcollectordestinationtype.mdx deleted file mode 100644 index dc6985a9..00000000 --- a/client-sdks/python/api-reference/components/observabilityotelcollectordestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestinationType - Python SDK -sidebarTitle: ObservabilityOtelCollectorDestinationType -description: ObservabilityOtelCollectorDestinationType method reference -seoTitle: ObservabilityOtelCollectorDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityotelcollectordestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityOtelCollectorDestinationType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestinationType%20-%20Python%20SDK&description=ObservabilityOtelCollectorDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `OTEL_COLLECTOR` | otel-collector | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityposthogdestination.mdx b/client-sdks/python/api-reference/components/observabilityposthogdestination.mdx deleted file mode 100644 index d0aae5e6..00000000 --- a/client-sdks/python/api-reference/components/observabilityposthogdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityPosthogDestination - Python SDK -sidebarTitle: ObservabilityPosthogDestination -description: ObservabilityPosthogDestination method reference -seoTitle: ObservabilityPosthogDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityposthogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityPosthogDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestination%20-%20Python%20SDK&description=ObservabilityPosthogDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityPosthogDestinationConfig](/client-sdks/python/api-reference/components/observabilityposthogdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityPosthogDestinationType](/client-sdks/python/api-reference/components/observabilityposthogdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityposthogdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityposthogdestinationconfig.mdx deleted file mode 100644 index 2a71fda5..00000000 --- a/client-sdks/python/api-reference/components/observabilityposthogdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityPosthogDestinationConfig - Python SDK -sidebarTitle: ObservabilityPosthogDestinationConfig -description: ObservabilityPosthogDestinationConfig method reference -seoTitle: ObservabilityPosthogDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityposthogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityPosthogDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestinationConfig%20-%20Python%20SDK&description=ObservabilityPosthogDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityposthogdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityposthogdestinationtype.mdx deleted file mode 100644 index 6b2d3827..00000000 --- a/client-sdks/python/api-reference/components/observabilityposthogdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityPosthogDestinationType - Python SDK -sidebarTitle: ObservabilityPosthogDestinationType -description: ObservabilityPosthogDestinationType method reference -seoTitle: ObservabilityPosthogDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityposthogdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityPosthogDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestinationType%20-%20Python%20SDK&description=ObservabilityPosthogDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `POSTHOG` | posthog | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityrampdestination.mdx b/client-sdks/python/api-reference/components/observabilityrampdestination.mdx deleted file mode 100644 index c40118ce..00000000 --- a/client-sdks/python/api-reference/components/observabilityrampdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityRampDestination - Python SDK -sidebarTitle: ObservabilityRampDestination -description: ObservabilityRampDestination method reference -seoTitle: ObservabilityRampDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityrampdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityRampDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestination%20-%20Python%20SDK&description=ObservabilityRampDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityRampDestinationConfig](/client-sdks/python/api-reference/components/observabilityrampdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityRampDestinationType](/client-sdks/python/api-reference/components/observabilityrampdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityrampdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityrampdestinationconfig.mdx deleted file mode 100644 index 67ee1b88..00000000 --- a/client-sdks/python/api-reference/components/observabilityrampdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityRampDestinationConfig - Python SDK -sidebarTitle: ObservabilityRampDestinationConfig -description: ObservabilityRampDestinationConfig method reference -seoTitle: ObservabilityRampDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityrampdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityRampDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestinationConfig%20-%20Python%20SDK&description=ObservabilityRampDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityrampdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityrampdestinationtype.mdx deleted file mode 100644 index 23d32a7e..00000000 --- a/client-sdks/python/api-reference/components/observabilityrampdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityRampDestinationType - Python SDK -sidebarTitle: ObservabilityRampDestinationType -description: ObservabilityRampDestinationType method reference -seoTitle: ObservabilityRampDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityrampdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityRampDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestinationType%20-%20Python%20SDK&description=ObservabilityRampDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `RAMP` | ramp | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitys3destination.mdx b/client-sdks/python/api-reference/components/observabilitys3destination.mdx deleted file mode 100644 index 0e26a41e..00000000 --- a/client-sdks/python/api-reference/components/observabilitys3destination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityS3Destination - Python SDK -sidebarTitle: ObservabilityS3Destination -description: ObservabilityS3Destination method reference -seoTitle: ObservabilityS3Destination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitys3destination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3Destination | OpenRouter Python SDK -'og:description': >- - ObservabilityS3Destination method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3Destination%20-%20Python%20SDK&description=ObservabilityS3Destination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityS3DestinationConfig](/client-sdks/python/api-reference/components/observabilitys3destinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityS3DestinationType](/client-sdks/python/api-reference/components/observabilitys3destinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitys3destinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitys3destinationconfig.mdx deleted file mode 100644 index 69677901..00000000 --- a/client-sdks/python/api-reference/components/observabilitys3destinationconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObservabilityS3DestinationConfig - Python SDK -sidebarTitle: ObservabilityS3DestinationConfig -description: ObservabilityS3DestinationConfig method reference -seoTitle: ObservabilityS3DestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitys3destinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3DestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityS3DestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3DestinationConfig%20-%20Python%20SDK&description=ObservabilityS3DestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_key_id` | *str* | :heavy_check_mark: | N/A | -| `bucket_name` | *str* | :heavy_check_mark: | N/A | -| `endpoint` | *Optional[str]* | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `path_template` | *Optional[str]* | :heavy_minus_sign: | Template for S3 object path. The filename (`{traceId}`-`{timestamp}`.json) is automatically appended. Available variables: `{prefix}`, `{date}`, `{year}`, `{month}`, `{day}`, `{apiKeyName}` | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `region` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `secret_access_key` | *str* | :heavy_check_mark: | N/A | -| `session_token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitys3destinationtype.mdx b/client-sdks/python/api-reference/components/observabilitys3destinationtype.mdx deleted file mode 100644 index ae301dbc..00000000 --- a/client-sdks/python/api-reference/components/observabilitys3destinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityS3DestinationType - Python SDK -sidebarTitle: ObservabilityS3DestinationType -description: ObservabilityS3DestinationType method reference -seoTitle: ObservabilityS3DestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitys3destinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3DestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityS3DestinationType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3DestinationType%20-%20Python%20SDK&description=ObservabilityS3DestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `S3` | s3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitysentrydestination.mdx b/client-sdks/python/api-reference/components/observabilitysentrydestination.mdx deleted file mode 100644 index 4641765e..00000000 --- a/client-sdks/python/api-reference/components/observabilitysentrydestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilitySentryDestination - Python SDK -sidebarTitle: ObservabilitySentryDestination -description: ObservabilitySentryDestination method reference -seoTitle: ObservabilitySentryDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysentrydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestination | OpenRouter Python SDK -'og:description': >- - ObservabilitySentryDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestination%20-%20Python%20SDK&description=ObservabilitySentryDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilitySentryDestinationConfig](/client-sdks/python/api-reference/components/observabilitysentrydestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySentryDestinationType](/client-sdks/python/api-reference/components/observabilitysentrydestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitysentrydestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitysentrydestinationconfig.mdx deleted file mode 100644 index 376fa450..00000000 --- a/client-sdks/python/api-reference/components/observabilitysentrydestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilitySentryDestinationConfig - Python SDK -sidebarTitle: ObservabilitySentryDestinationConfig -description: ObservabilitySentryDestinationConfig method reference -seoTitle: ObservabilitySentryDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysentrydestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilitySentryDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestinationConfig%20-%20Python%20SDK&description=ObservabilitySentryDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dsn` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `otlp_endpoint` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitysentrydestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitysentrydestinationtype.mdx deleted file mode 100644 index d7e7e829..00000000 --- a/client-sdks/python/api-reference/components/observabilitysentrydestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilitySentryDestinationType - Python SDK -sidebarTitle: ObservabilitySentryDestinationType -description: ObservabilitySentryDestinationType method reference -seoTitle: ObservabilitySentryDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysentrydestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilitySentryDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestinationType%20-%20Python%20SDK&description=ObservabilitySentryDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SENTRY` | sentry | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitysnowflakedestination.mdx b/client-sdks/python/api-reference/components/observabilitysnowflakedestination.mdx deleted file mode 100644 index 7d51f7f7..00000000 --- a/client-sdks/python/api-reference/components/observabilitysnowflakedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilitySnowflakeDestination - Python SDK -sidebarTitle: ObservabilitySnowflakeDestination -description: ObservabilitySnowflakeDestination method reference -seoTitle: ObservabilitySnowflakeDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysnowflakedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestination | OpenRouter Python SDK -'og:description': >- - ObservabilitySnowflakeDestination method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestination%20-%20Python%20SDK&description=ObservabilitySnowflakeDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilitySnowflakeDestinationConfig](/client-sdks/python/api-reference/components/observabilitysnowflakedestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilitySnowflakeDestinationType](/client-sdks/python/api-reference/components/observabilitysnowflakedestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitysnowflakedestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitysnowflakedestinationconfig.mdx deleted file mode 100644 index 64b4fb41..00000000 --- a/client-sdks/python/api-reference/components/observabilitysnowflakedestinationconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObservabilitySnowflakeDestinationConfig - Python SDK -sidebarTitle: ObservabilitySnowflakeDestinationConfig -description: ObservabilitySnowflakeDestinationConfig method reference -seoTitle: ObservabilitySnowflakeDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysnowflakedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilitySnowflakeDestinationConfig method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestinationConfig%20-%20Python%20SDK&description=ObservabilitySnowflakeDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `account` | *str* | :heavy_check_mark: | N/A | -| `database` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `table` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `warehouse` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitysnowflakedestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitysnowflakedestinationtype.mdx deleted file mode 100644 index e2f659e0..00000000 --- a/client-sdks/python/api-reference/components/observabilitysnowflakedestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilitySnowflakeDestinationType - Python SDK -sidebarTitle: ObservabilitySnowflakeDestinationType -description: ObservabilitySnowflakeDestinationType method reference -seoTitle: ObservabilitySnowflakeDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitysnowflakedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilitySnowflakeDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestinationType%20-%20Python%20SDK&description=ObservabilitySnowflakeDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `SNOWFLAKE` | snowflake | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityweavedestination.mdx b/client-sdks/python/api-reference/components/observabilityweavedestination.mdx deleted file mode 100644 index f06dc9e0..00000000 --- a/client-sdks/python/api-reference/components/observabilityweavedestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityWeaveDestination - Python SDK -sidebarTitle: ObservabilityWeaveDestination -description: ObservabilityWeaveDestination method reference -seoTitle: ObservabilityWeaveDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityweavedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityWeaveDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestination%20-%20Python%20SDK&description=ObservabilityWeaveDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityWeaveDestinationConfig](/client-sdks/python/api-reference/components/observabilityweavedestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWeaveDestinationType](/client-sdks/python/api-reference/components/observabilityweavedestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilityweavedestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilityweavedestinationconfig.mdx deleted file mode 100644 index 68a52756..00000000 --- a/client-sdks/python/api-reference/components/observabilityweavedestinationconfig.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ObservabilityWeaveDestinationConfig - Python SDK -sidebarTitle: ObservabilityWeaveDestinationConfig -description: ObservabilityWeaveDestinationConfig method reference -seoTitle: ObservabilityWeaveDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityweavedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityWeaveDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestinationConfig%20-%20Python%20SDK&description=ObservabilityWeaveDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `api_key` | *str* | :heavy_check_mark: | N/A | -| `base_url` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `entity` | *str* | :heavy_check_mark: | N/A | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilityweavedestinationtype.mdx b/client-sdks/python/api-reference/components/observabilityweavedestinationtype.mdx deleted file mode 100644 index 05f45d2a..00000000 --- a/client-sdks/python/api-reference/components/observabilityweavedestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityWeaveDestinationType - Python SDK -sidebarTitle: ObservabilityWeaveDestinationType -description: ObservabilityWeaveDestinationType method reference -seoTitle: ObservabilityWeaveDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilityweavedestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityWeaveDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestinationType%20-%20Python%20SDK&description=ObservabilityWeaveDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `WEAVE` | weave | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitywebhookdestination.mdx b/client-sdks/python/api-reference/components/observabilitywebhookdestination.mdx deleted file mode 100644 index cb059728..00000000 --- a/client-sdks/python/api-reference/components/observabilitywebhookdestination.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityWebhookDestination - Python SDK -sidebarTitle: ObservabilityWebhookDestination -description: ObservabilityWebhookDestination method reference -seoTitle: ObservabilityWebhookDestination | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitywebhookdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestination | OpenRouter Python SDK -'og:description': >- - ObservabilityWebhookDestination method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestination%20-%20Python%20SDK&description=ObservabilityWebhookDestination%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | `` | -| `config` | [components.ObservabilityWebhookDestinationConfig](/client-sdks/python/api-reference/components/observabilitywebhookdestinationconfig) | :heavy_check_mark: | N/A | | -| `created_at` | *str* | :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 | -| `filter_rules` | [Nullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *str* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *Nullable[str]* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *bool* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [components.ObservabilityWebhookDestinationType](/client-sdks/python/api-reference/components/observabilitywebhookdestinationtype) | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspace_id` | *str* | :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/client-sdks/python/api-reference/components/observabilitywebhookdestinationconfig.mdx b/client-sdks/python/api-reference/components/observabilitywebhookdestinationconfig.mdx deleted file mode 100644 index b3669587..00000000 --- a/client-sdks/python/api-reference/components/observabilitywebhookdestinationconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ObservabilityWebhookDestinationConfig - Python SDK -sidebarTitle: ObservabilityWebhookDestinationConfig -description: ObservabilityWebhookDestinationConfig method reference -seoTitle: ObservabilityWebhookDestinationConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitywebhookdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestinationConfig | OpenRouter Python SDK -'og:description': >- - ObservabilityWebhookDestinationConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestinationConfig%20-%20Python%20SDK&description=ObservabilityWebhookDestinationConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `headers` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `method` | [Optional[components.Method]](../components/method.md) | :heavy_minus_sign: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/observabilitywebhookdestinationtype.mdx b/client-sdks/python/api-reference/components/observabilitywebhookdestinationtype.mdx deleted file mode 100644 index deb43813..00000000 --- a/client-sdks/python/api-reference/components/observabilitywebhookdestinationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObservabilityWebhookDestinationType - Python SDK -sidebarTitle: ObservabilityWebhookDestinationType -description: ObservabilityWebhookDestinationType method reference -seoTitle: ObservabilityWebhookDestinationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/observabilitywebhookdestinationtype -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestinationType | OpenRouter Python SDK -'og:description': >- - ObservabilityWebhookDestinationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestinationType%20-%20Python%20SDK&description=ObservabilityWebhookDestinationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `WEBHOOK` | webhook | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/only.mdx b/client-sdks/python/api-reference/components/only.mdx deleted file mode 100644 index e6366a81..00000000 --- a/client-sdks/python/api-reference/components/only.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Only - Python SDK -sidebarTitle: Only -description: Only method reference -seoTitle: Only | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/only' -'og:site_name': OpenRouter Documentation -'og:title': Only | OpenRouter Python SDK -'og:description': >- - Only method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Only%20-%20Python%20SDK&description=Only%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcall.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcall.mdx deleted file mode 100644 index 4ed1a6ff..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcall.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenAIResponseCustomToolCall - Python SDK -sidebarTitle: OpenAIResponseCustomToolCall -description: OpenAIResponseCustomToolCall method reference -seoTitle: OpenAIResponseCustomToolCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCall | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCall%20-%20Python%20SDK&description=OpenAIResponseCustomToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `input` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [components.OpenAIResponseCustomToolCallType](/client-sdks/python/api-reference/components/openairesponsecustomtoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutput.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutput.mdx deleted file mode 100644 index e48e5100..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutput - Python SDK -sidebarTitle: OpenAIResponseCustomToolCallOutput -description: OpenAIResponseCustomToolCallOutput method reference -seoTitle: OpenAIResponseCustomToolCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutput | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCallOutput method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutput%20-%20Python%20SDK&description=OpenAIResponseCustomToolCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `output` | [components.OpenAIResponseCustomToolCallOutputOutput2](/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput2) | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponseCustomToolCallOutputType](/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput1.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput1.mdx deleted file mode 100644 index 2450b1ac..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput1 - Python SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput1 -description: OpenAIResponseCustomToolCallOutputOutput1 method reference -seoTitle: OpenAIResponseCustomToolCallOutputOutput1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput1 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput1%20-%20Python%20SDK&description=OpenAIResponseCustomToolCallOutputOutput1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputImage` - -```python lines -value: components.InputImage = /* values here */ -``` - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput2.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput2.mdx deleted file mode 100644 index ee7bd3c7..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput2 - Python SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput2 -description: OpenAIResponseCustomToolCallOutputOutput2 method reference -seoTitle: OpenAIResponseCustomToolCallOutputOutput2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput2 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput2%20-%20Python%20SDK&description=OpenAIResponseCustomToolCallOutputOutput2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.OpenAIResponseCustomToolCallOutputOutput1]` - -```python lines -value: List[components.OpenAIResponseCustomToolCallOutputOutput1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputtype.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputtype.mdx deleted file mode 100644 index 49f244af..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalloutputtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputType - Python SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputType -description: OpenAIResponseCustomToolCallOutputType method reference -seoTitle: OpenAIResponseCustomToolCallOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputType | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputType%20-%20Python%20SDK&description=OpenAIResponseCustomToolCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `CUSTOM_TOOL_CALL_OUTPUT` | custom_tool_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalltype.mdx b/client-sdks/python/api-reference/components/openairesponsecustomtoolcalltype.mdx deleted file mode 100644 index 3a97b173..00000000 --- a/client-sdks/python/api-reference/components/openairesponsecustomtoolcalltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallType - Python SDK -sidebarTitle: OpenAIResponseCustomToolCallType -description: OpenAIResponseCustomToolCallType method reference -seoTitle: OpenAIResponseCustomToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsecustomtoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallType | OpenRouter Python SDK -'og:description': >- - OpenAIResponseCustomToolCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallType%20-%20Python%20SDK&description=OpenAIResponseCustomToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `CUSTOM_TOOL_CALL` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcall.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcall.mdx deleted file mode 100644 index e71bcf21..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcall.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCall - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCall -description: OpenAIResponseFunctionToolCall method reference -seoTitle: OpenAIResponseFunctionToolCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCall | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCall%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [Optional[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.OpenAIResponseFunctionToolCallType](/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutput.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutput.mdx deleted file mode 100644 index c6aeda3c..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutput.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutput - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutput -description: OpenAIResponseFunctionToolCallOutput method reference -seoTitle: OpenAIResponseFunctionToolCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutput | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutput method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutput%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput2) | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.OpenAIResponseFunctionToolCallOutputStatus]](../components/openairesponsefunctiontoolcalloutputstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.OpenAIResponseFunctionToolCallOutputType](/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput1.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput1.mdx deleted file mode 100644 index a4c25145..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput1 - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput1 -description: OpenAIResponseFunctionToolCallOutputOutput1 method reference -seoTitle: OpenAIResponseFunctionToolCallOutputOutput1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput1 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput1%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputImage` - -```python lines -value: components.InputImage = /* values here */ -``` - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput2.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput2.mdx deleted file mode 100644 index 41957013..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput2 - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput2 -description: OpenAIResponseFunctionToolCallOutputOutput2 method reference -seoTitle: OpenAIResponseFunctionToolCallOutputOutput2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput2 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput2%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.OpenAIResponseFunctionToolCallOutputOutput1]` - -```python lines -value: List[components.OpenAIResponseFunctionToolCallOutputOutput1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputstatus.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputstatus.mdx deleted file mode 100644 index 3322addf..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputStatus - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputStatus -description: OpenAIResponseFunctionToolCallOutputStatus method reference -seoTitle: OpenAIResponseFunctionToolCallOutputStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputstatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputStatus | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputStatus method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputStatus%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallOutputStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputtype.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputtype.mdx deleted file mode 100644 index adfd6bf3..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputType - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputType -description: OpenAIResponseFunctionToolCallOutputType method reference -seoTitle: OpenAIResponseFunctionToolCallOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputType | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputType%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FUNCTION_CALL_OUTPUT` | function_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalltype.mdx b/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalltype.mdx deleted file mode 100644 index 77731c9b..00000000 --- a/client-sdks/python/api-reference/components/openairesponsefunctiontoolcalltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallType - Python SDK -sidebarTitle: OpenAIResponseFunctionToolCallType -description: OpenAIResponseFunctionToolCallType method reference -seoTitle: OpenAIResponseFunctionToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsefunctiontoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallType | OpenRouter Python SDK -'og:description': >- - OpenAIResponseFunctionToolCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallType%20-%20Python%20SDK&description=OpenAIResponseFunctionToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitem.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitem.mdx deleted file mode 100644 index 3aec5906..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenAIResponseInputMessageItem - Python SDK -sidebarTitle: OpenAIResponseInputMessageItem -description: OpenAIResponseInputMessageItem method reference -seoTitle: OpenAIResponseInputMessageItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItem | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItem%20-%20Python%20SDK&description=OpenAIResponseInputMessageItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OpenAIResponseInputMessageItemContent](/client-sdks/python/api-reference/components/openairesponseinputmessageitemcontent)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.OpenAIResponseInputMessageItemRoleUnion](/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleunion) | :heavy_check_mark: | N/A | -| `type` | [Optional[components.OpenAIResponseInputMessageItemType]](../components/openairesponseinputmessageitemtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemcontent.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemcontent.mdx deleted file mode 100644 index 6723d4f3..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemcontent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemContent - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemContent -description: OpenAIResponseInputMessageItemContent method reference -seoTitle: OpenAIResponseInputMessageItemContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemContent | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemContent method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemContent%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.InputAudio` - -```python lines -value: components.InputAudio = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` - -### `components.InputImage` - -```python lines -value: components.InputImage = /* values here */ -``` - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroledeveloper.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemroledeveloper.mdx deleted file mode 100644 index 27074b53..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleDeveloper - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleDeveloper -description: OpenAIResponseInputMessageItemRoleDeveloper method reference -seoTitle: OpenAIResponseInputMessageItemRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleDeveloper | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleDeveloper method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleDeveloper%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemrolesystem.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemrolesystem.mdx deleted file mode 100644 index 3e7ce870..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemrolesystem.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleSystem - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleSystem -description: OpenAIResponseInputMessageItemRoleSystem method reference -seoTitle: OpenAIResponseInputMessageItemRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleSystem | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleSystem method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleSystem%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleunion.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleunion.mdx deleted file mode 100644 index 8a4fd3b2..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUnion - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUnion -description: OpenAIResponseInputMessageItemRoleUnion method reference -seoTitle: OpenAIResponseInputMessageItemRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUnion | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUnion%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponseInputMessageItemRoleUser` - -```python lines -value: components.OpenAIResponseInputMessageItemRoleUser = /* values here */ -``` - -### `components.OpenAIResponseInputMessageItemRoleSystem` - -```python lines -value: components.OpenAIResponseInputMessageItemRoleSystem = /* values here */ -``` - -### `components.OpenAIResponseInputMessageItemRoleDeveloper` - -```python lines -value: components.OpenAIResponseInputMessageItemRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleuser.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleuser.mdx deleted file mode 100644 index f657d131..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemroleuser.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUser - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUser -description: OpenAIResponseInputMessageItemRoleUser method reference -seoTitle: OpenAIResponseInputMessageItemRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUser | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUser method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUser%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponseinputmessageitemtype.mdx b/client-sdks/python/api-reference/components/openairesponseinputmessageitemtype.mdx deleted file mode 100644 index a61e19ba..00000000 --- a/client-sdks/python/api-reference/components/openairesponseinputmessageitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemType - Python SDK -sidebarTitle: OpenAIResponseInputMessageItemType -description: OpenAIResponseInputMessageItemType method reference -seoTitle: OpenAIResponseInputMessageItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponseinputmessageitemtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemType | OpenRouter Python SDK -'og:description': >- - OpenAIResponseInputMessageItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemType%20-%20Python%20SDK&description=OpenAIResponseInputMessageItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsesannotation.mdx b/client-sdks/python/api-reference/components/openairesponsesannotation.mdx deleted file mode 100644 index cea0f6d7..00000000 --- a/client-sdks/python/api-reference/components/openairesponsesannotation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponsesAnnotation - Python SDK -sidebarTitle: OpenAIResponsesAnnotation -description: OpenAIResponsesAnnotation method reference -seoTitle: OpenAIResponsesAnnotation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsesannotation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesAnnotation | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesAnnotation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesAnnotation%20-%20Python%20SDK&description=OpenAIResponsesAnnotation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.FileCitation` - -```python lines -value: components.FileCitation = /* values here */ -``` - -### `components.URLCitation` - -```python lines -value: components.URLCitation = /* values here */ -``` - -### `components.FilePath` - -```python lines -value: components.FilePath = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsesrefusalcontent.mdx b/client-sdks/python/api-reference/components/openairesponsesrefusalcontent.mdx deleted file mode 100644 index d05b2c62..00000000 --- a/client-sdks/python/api-reference/components/openairesponsesrefusalcontent.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesRefusalContent - Python SDK -sidebarTitle: OpenAIResponsesRefusalContent -description: OpenAIResponsesRefusalContent method reference -seoTitle: OpenAIResponsesRefusalContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsesrefusalcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContent | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesRefusalContent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContent%20-%20Python%20SDK&description=OpenAIResponsesRefusalContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `refusal` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponsesRefusalContentType](/client-sdks/python/api-reference/components/openairesponsesrefusalcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsesrefusalcontenttype.mdx b/client-sdks/python/api-reference/components/openairesponsesrefusalcontenttype.mdx deleted file mode 100644 index c9b20473..00000000 --- a/client-sdks/python/api-reference/components/openairesponsesrefusalcontenttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesRefusalContentType - Python SDK -sidebarTitle: OpenAIResponsesRefusalContentType -description: OpenAIResponsesRefusalContentType method reference -seoTitle: OpenAIResponsesRefusalContentType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsesrefusalcontenttype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContentType | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesRefusalContentType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContentType%20-%20Python%20SDK&description=OpenAIResponsesRefusalContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `REFUSAL` | refusal | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsesresponsestatus.mdx b/client-sdks/python/api-reference/components/openairesponsesresponsestatus.mdx deleted file mode 100644 index 1d242187..00000000 --- a/client-sdks/python/api-reference/components/openairesponsesresponsestatus.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenAIResponsesResponseStatus - Python SDK -sidebarTitle: OpenAIResponsesResponseStatus -description: OpenAIResponsesResponseStatus method reference -seoTitle: OpenAIResponsesResponseStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsesresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesResponseStatus | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesResponseStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesResponseStatus%20-%20Python%20SDK&description=OpenAIResponsesResponseStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | -| `IN_PROGRESS` | in_progress | -| `FAILED` | failed | -| `CANCELLED` | cancelled | -| `QUEUED` | queued | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoice.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoice.mdx deleted file mode 100644 index 600acac7..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoice.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoice - Python SDK -sidebarTitle: OpenAIResponsesToolChoice -description: OpenAIResponsesToolChoice method reference -seoTitle: OpenAIResponsesToolChoice | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoice -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoice | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoice method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoice%20-%20Python%20SDK&description=OpenAIResponsesToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [components.Type](/client-sdks/python/api-reference/components/type) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoiceapplypatch.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoiceapplypatch.mdx deleted file mode 100644 index ff2e463f..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoiceapplypatch.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceApplyPatch - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceApplyPatch -description: OpenAIResponsesToolChoiceApplyPatch method reference -seoTitle: OpenAIResponsesToolChoiceApplyPatch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoiceapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceApplyPatch | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceApplyPatch method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceApplyPatch%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceApplyPatch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeapplypatch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoiceauto.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoiceauto.mdx deleted file mode 100644 index c644e20b..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoiceauto.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceAuto - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceAuto -description: OpenAIResponsesToolChoiceAuto method reference -seoTitle: OpenAIResponsesToolChoiceAuto | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceAuto | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceAuto method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceAuto%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicefunction.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicefunction.mdx deleted file mode 100644 index 4da721c8..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicefunction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceFunction - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceFunction -description: OpenAIResponsesToolChoiceFunction method reference -seoTitle: OpenAIResponsesToolChoiceFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceFunction | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceFunction%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](/client-sdks/python/api-reference/components/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicenone.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicenone.mdx deleted file mode 100644 index b64e8c1b..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicenone.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceNone - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceNone -description: OpenAIResponsesToolChoiceNone method reference -seoTitle: OpenAIResponsesToolChoiceNone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceNone | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceNone method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceNone%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicerequired.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicerequired.mdx deleted file mode 100644 index 8d0e2d97..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicerequired.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceRequired - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceRequired -description: OpenAIResponsesToolChoiceRequired method reference -seoTitle: OpenAIResponsesToolChoiceRequired | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceRequired | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceRequired method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceRequired%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceRequired%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `REQUIRED` | required | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoiceshell.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoiceshell.mdx deleted file mode 100644 index 92663b50..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoiceshell.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceShell - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceShell -description: OpenAIResponsesToolChoiceShell method reference -seoTitle: OpenAIResponsesToolChoiceShell | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoiceshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceShell | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceShell method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceShell%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceShell%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeShell](/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeshell) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeapplypatch.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeapplypatch.mdx deleted file mode 100644 index a8f8dd58..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeapplypatch.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeApplyPatch - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeApplyPatch -description: OpenAIResponsesToolChoiceTypeApplyPatch method reference -seoTitle: OpenAIResponsesToolChoiceTypeApplyPatch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicetypeapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeApplyPatch | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeApplyPatch method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeApplyPatch%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeApplyPatch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPLY_PATCH` | apply_patch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypefunction.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicetypefunction.mdx deleted file mode 100644 index 93b99f84..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypefunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeFunction - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeFunction -description: OpenAIResponsesToolChoiceTypeFunction method reference -seoTitle: OpenAIResponsesToolChoiceTypeFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicetypefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeFunction | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeFunction%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeshell.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeshell.mdx deleted file mode 100644 index 897dac95..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypeshell.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeShell - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeShell -description: OpenAIResponsesToolChoiceTypeShell method reference -seoTitle: OpenAIResponsesToolChoiceTypeShell | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicetypeshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeShell | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeShell method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeShell%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeShell%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `SHELL` | shell | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview.mdx deleted file mode 100644 index 598a4ba8..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview -description: OpenAIResponsesToolChoiceTypeWebSearchPreview method reference -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `WEB_SEARCH_PREVIEW` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx deleted file mode 100644 index cb3db0d9..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 -description: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method reference -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoicetypewebsearchpreview20250311 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method documentation for - the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `WEB_SEARCH_PREVIEW_2025_03_11` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion.mdx b/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion.mdx deleted file mode 100644 index cd3cdaf6..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceUnion - Python SDK -sidebarTitle: OpenAIResponsesToolChoiceUnion -description: OpenAIResponsesToolChoiceUnion method reference -seoTitle: OpenAIResponsesToolChoiceUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestoolchoiceunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceUnion | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceUnion%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesToolChoiceAuto` - -```python lines -value: components.OpenAIResponsesToolChoiceAuto = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceNone` - -```python lines -value: components.OpenAIResponsesToolChoiceNone = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceRequired` - -```python lines -value: components.OpenAIResponsesToolChoiceRequired = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceFunction` - -```python lines -value: components.OpenAIResponsesToolChoiceFunction = /* values here */ -``` - -### `components.OpenAIResponsesToolChoice` - -```python lines -value: components.OpenAIResponsesToolChoice = /* values here */ -``` - -### `components.ToolChoiceAllowed` - -```python lines -value: components.ToolChoiceAllowed = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceApplyPatch` - -```python lines -value: components.OpenAIResponsesToolChoiceApplyPatch = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceShell` - -```python lines -value: components.OpenAIResponsesToolChoiceShell = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openairesponsestruncation.mdx b/client-sdks/python/api-reference/components/openairesponsestruncation.mdx deleted file mode 100644 index a56d4a14..00000000 --- a/client-sdks/python/api-reference/components/openairesponsestruncation.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesTruncation - Python SDK -sidebarTitle: OpenAIResponsesTruncation -description: OpenAIResponsesTruncation method reference -seoTitle: OpenAIResponsesTruncation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openairesponsestruncation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesTruncation | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesTruncation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesTruncation%20-%20Python%20SDK&description=OpenAIResponsesTruncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsescreatedevent.mdx b/client-sdks/python/api-reference/components/openresponsescreatedevent.mdx deleted file mode 100644 index 4abc6c26..00000000 --- a/client-sdks/python/api-reference/components/openresponsescreatedevent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesCreatedEvent - Python SDK -sidebarTitle: OpenResponsesCreatedEvent -description: OpenResponsesCreatedEvent method reference -seoTitle: OpenResponsesCreatedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsescreatedevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesCreatedEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesCreatedEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesCreatedEvent%20-%20Python%20SDK&description=OpenResponsesCreatedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is created - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](/client-sdks/python/api-reference/components/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"completed_at": 1704067210,"created_at": 1704067200,"error": 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,"status": "completed","temperature": null,"tool_choice": "auto","tools": [],"top_p": null}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.OpenResponsesCreatedEventType](/client-sdks/python/api-reference/components/openresponsescreatedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsescreatedeventtype.mdx b/client-sdks/python/api-reference/components/openresponsescreatedeventtype.mdx deleted file mode 100644 index 312e362a..00000000 --- a/client-sdks/python/api-reference/components/openresponsescreatedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenResponsesCreatedEventType - Python SDK -sidebarTitle: OpenResponsesCreatedEventType -description: OpenResponsesCreatedEventType method reference -seoTitle: OpenResponsesCreatedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsescreatedeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesCreatedEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesCreatedEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesCreatedEventType%20-%20Python%20SDK&description=OpenResponsesCreatedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `RESPONSE_CREATED` | response.created | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesinprogressevent.mdx b/client-sdks/python/api-reference/components/openresponsesinprogressevent.mdx deleted file mode 100644 index d17f80cf..00000000 --- a/client-sdks/python/api-reference/components/openresponsesinprogressevent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesInProgressEvent - Python SDK -sidebarTitle: OpenResponsesInProgressEvent -description: OpenResponsesInProgressEvent method reference -seoTitle: OpenResponsesInProgressEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInProgressEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesInProgressEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInProgressEvent%20-%20Python%20SDK&description=OpenResponsesInProgressEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is in progress - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](/client-sdks/python/api-reference/components/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"completed_at": 1704067210,"created_at": 1704067200,"error": 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,"status": "completed","temperature": null,"tool_choice": "auto","tools": [],"top_p": null}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.OpenResponsesInProgressEventType](/client-sdks/python/api-reference/components/openresponsesinprogresseventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesinprogresseventtype.mdx b/client-sdks/python/api-reference/components/openresponsesinprogresseventtype.mdx deleted file mode 100644 index 3f2e984f..00000000 --- a/client-sdks/python/api-reference/components/openresponsesinprogresseventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenResponsesInProgressEventType - Python SDK -sidebarTitle: OpenResponsesInProgressEventType -description: OpenResponsesInProgressEventType method reference -seoTitle: OpenResponsesInProgressEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInProgressEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesInProgressEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInProgressEventType%20-%20Python%20SDK&description=OpenResponsesInProgressEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `RESPONSE_IN_PROGRESS` | response.in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesresult.mdx b/client-sdks/python/api-reference/components/openresponsesresult.mdx deleted file mode 100644 index acab4806..00000000 --- a/client-sdks/python/api-reference/components/openresponsesresult.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: OpenResponsesResult - Python SDK -sidebarTitle: OpenResponsesResult -description: OpenResponsesResult method reference -seoTitle: OpenResponsesResult | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesresult -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResult | OpenRouter Python SDK -'og:description': >- - OpenResponsesResult method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResult%20-%20Python%20SDK&description=OpenResponsesResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Complete non-streaming response from the Responses API - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `completed_at` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `created_at` | *int* | :heavy_check_mark: | N/A | | -| `error` | [Nullable[components.ResponsesErrorField]](../components/responseserrorfield.md) | :heavy_check_mark: | Error information returned from the API | `{"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."}` | -| `frequency_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `incomplete_details` | [Nullable[components.IncompleteDetails]](../components/incompletedetails.md) | :heavy_check_mark: | N/A | `{"reason": "max_output_tokens"}` | -| `instructions` | [Nullable[components.BaseInputsUnion]](../components/baseinputsunion.md) | :heavy_check_mark: | N/A | [
`{"content": "What is the weather today?","role": "user"}`
] | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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` | *str* | :heavy_check_mark: | N/A | | -| `object` | [components.OpenResponsesResultObject](/client-sdks/python/api-reference/components/openresponsesresultobject) | :heavy_check_mark: | N/A | | -| `output` | List[[components.OutputItems](/client-sdks/python/api-reference/components/outputitems)] | :heavy_check_mark: | N/A | | -| `output_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *bool* | :heavy_check_mark: | N/A | | -| `presence_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.md) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `reasoning` | [OptionalNullable[components.BaseReasoningConfig]](../components/basereasoningconfig.md) | :heavy_minus_sign: | N/A | `{"effort": "medium","summary": "auto"}` | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.OpenAIResponsesResponseStatus](/client-sdks/python/api-reference/components/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | completed | -| `store` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.md) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
\} | -| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion) | :heavy_check_mark: | N/A | auto | -| `tools` | List[[components.OpenResponsesResultToolUnion](/client-sdks/python/api-reference/components/openresponsesresulttoolunion)] | :heavy_check_mark: | N/A | | -| `top_logprobs` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.md) | :heavy_minus_sign: | N/A | auto | -| `usage` | [OptionalNullable[components.Usage]](../components/usage.md) | :heavy_minus_sign: | Token usage information for the response | `{"input_tokens": 100,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 50,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `150
`\} | -| `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `openrouter_metadata` | [Optional[components.OpenRouterMetadata]](../components/openroutermetadata.md) | :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/client-sdks/python/api-reference/components/openresponsesresultobject.mdx b/client-sdks/python/api-reference/components/openresponsesresultobject.mdx deleted file mode 100644 index 76d4e17c..00000000 --- a/client-sdks/python/api-reference/components/openresponsesresultobject.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenResponsesResultObject - Python SDK -sidebarTitle: OpenResponsesResultObject -description: OpenResponsesResultObject method reference -seoTitle: OpenResponsesResultObject | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesresultobject -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultObject | OpenRouter Python SDK -'og:description': >- - OpenResponsesResultObject method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultObject%20-%20Python%20SDK&description=OpenResponsesResultObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `RESPONSE` | response | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesresulttoolfunction.mdx b/client-sdks/python/api-reference/components/openresponsesresulttoolfunction.mdx deleted file mode 100644 index a5279f1c..00000000 --- a/client-sdks/python/api-reference/components/openresponsesresulttoolfunction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesResultToolFunction - Python SDK -sidebarTitle: OpenResponsesResultToolFunction -description: OpenResponsesResultToolFunction method reference -seoTitle: OpenResponsesResultToolFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesresulttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolFunction | OpenRouter Python SDK -'og:description': >- - OpenResponsesResultToolFunction method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolFunction%20-%20Python%20SDK&description=OpenResponsesResultToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.OpenResponsesResultType](/client-sdks/python/api-reference/components/openresponsesresulttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesresulttoolunion.mdx b/client-sdks/python/api-reference/components/openresponsesresulttoolunion.mdx deleted file mode 100644 index 9da45b46..00000000 --- a/client-sdks/python/api-reference/components/openresponsesresulttoolunion.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: OpenResponsesResultToolUnion - Python SDK -sidebarTitle: OpenResponsesResultToolUnion -description: OpenResponsesResultToolUnion method reference -seoTitle: OpenResponsesResultToolUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesresulttoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesResultToolUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolUnion%20-%20Python%20SDK&description=OpenResponsesResultToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesResultToolFunction` - -```python lines -value: components.OpenResponsesResultToolFunction = /* values here */ -``` - -### `components.PreviewWebSearchServerTool` - -```python lines -value: components.PreviewWebSearchServerTool = /* values here */ -``` - -### `components.Preview20250311WebSearchServerTool` - -```python lines -value: components.Preview20250311WebSearchServerTool = /* values here */ -``` - -### `components.LegacyWebSearchServerTool` - -```python lines -value: components.LegacyWebSearchServerTool = /* values here */ -``` - -### `components.WebSearchServerTool` - -```python lines -value: components.WebSearchServerTool = /* values here */ -``` - -### `components.FileSearchServerTool` - -```python lines -value: components.FileSearchServerTool = /* values here */ -``` - -### `components.ComputerUseServerTool` - -```python lines -value: components.ComputerUseServerTool = /* values here */ -``` - -### `components.CodeInterpreterServerTool` - -```python lines -value: components.CodeInterpreterServerTool = /* values here */ -``` - -### `components.McpServerTool` - -```python lines -value: components.McpServerTool = /* values here */ -``` - -### `components.ImageGenerationServerTool` - -```python lines -value: components.ImageGenerationServerTool = /* values here */ -``` - -### `components.CodexLocalShellTool` - -```python lines -value: components.CodexLocalShellTool = /* values here */ -``` - -### `components.ShellServerTool` - -```python lines -value: components.ShellServerTool = /* values here */ -``` - -### `components.ApplyPatchServerTool` - -```python lines -value: components.ApplyPatchServerTool = /* values here */ -``` - -### `components.CustomTool` - -```python lines -value: components.CustomTool = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openresponsesresulttype.mdx b/client-sdks/python/api-reference/components/openresponsesresulttype.mdx deleted file mode 100644 index 9615a739..00000000 --- a/client-sdks/python/api-reference/components/openresponsesresulttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenResponsesResultType - Python SDK -sidebarTitle: OpenResponsesResultType -description: OpenResponsesResultType method reference -seoTitle: OpenResponsesResultType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openresponsesresulttype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultType | OpenRouter Python SDK -'og:description': >- - OpenResponsesResultType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultType%20-%20Python%20SDK&description=OpenResponsesResultType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openroutermetadata.mdx b/client-sdks/python/api-reference/components/openroutermetadata.mdx deleted file mode 100644 index 5fdd88b4..00000000 --- a/client-sdks/python/api-reference/components/openroutermetadata.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenRouterMetadata - Python SDK -sidebarTitle: OpenRouterMetadata -description: OpenRouterMetadata method reference -seoTitle: OpenRouterMetadata | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openroutermetadata -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterMetadata | OpenRouter Python SDK -'og:description': >- - OpenRouterMetadata method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterMetadata%20-%20Python%20SDK&description=OpenRouterMetadata%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `attempt` | *int* | :heavy_check_mark: | N/A | | -| `attempts` | List[[components.RouterAttempt](/client-sdks/python/api-reference/components/routerattempt)] | :heavy_minus_sign: | N/A | | -| `endpoints` | [components.EndpointsMetadata](/client-sdks/python/api-reference/components/endpointsmetadata) | :heavy_check_mark: | N/A | `{"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}`
],
"total": `3
`\} | -| `is_byok` | *bool* | :heavy_check_mark: | N/A | | -| `params` | [Optional[components.RouterParams]](../components/routerparams.md) | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | -| `pipeline` | List[[components.PipelineStage](/client-sdks/python/api-reference/components/pipelinestage)] | :heavy_minus_sign: | N/A | | -| `region` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `requested` | *str* | :heavy_check_mark: | N/A | | -| `strategy` | [components.RoutingStrategy](/client-sdks/python/api-reference/components/routingstrategy) | :heavy_check_mark: | N/A | direct | -| `summary` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openrouterwebsearchservertool.mdx b/client-sdks/python/api-reference/components/openrouterwebsearchservertool.mdx deleted file mode 100644 index 0798ae11..00000000 --- a/client-sdks/python/api-reference/components/openrouterwebsearchservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenRouterWebSearchServerTool - Python SDK -sidebarTitle: OpenRouterWebSearchServerTool -description: OpenRouterWebSearchServerTool method reference -seoTitle: OpenRouterWebSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openrouterwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerTool | OpenRouter Python SDK -'og:description': >- - OpenRouterWebSearchServerTool method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerTool%20-%20Python%20SDK&description=OpenRouterWebSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchConfig]](../components/websearchconfig.md) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `type` | [components.OpenRouterWebSearchServerToolType](/client-sdks/python/api-reference/components/openrouterwebsearchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/openrouterwebsearchservertooltype.mdx b/client-sdks/python/api-reference/components/openrouterwebsearchservertooltype.mdx deleted file mode 100644 index bbe8b6d2..00000000 --- a/client-sdks/python/api-reference/components/openrouterwebsearchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenRouterWebSearchServerToolType - Python SDK -sidebarTitle: OpenRouterWebSearchServerToolType -description: OpenRouterWebSearchServerToolType method reference -seoTitle: OpenRouterWebSearchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/openrouterwebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerToolType | OpenRouter Python SDK -'og:description': >- - OpenRouterWebSearchServerToolType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerToolType%20-%20Python%20SDK&description=OpenRouterWebSearchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `OPENROUTER_WEB_SEARCH` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/operator.mdx b/client-sdks/python/api-reference/components/operator.mdx deleted file mode 100644 index 82a34ff2..00000000 --- a/client-sdks/python/api-reference/components/operator.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Operator - Python SDK -sidebarTitle: Operator -description: Operator method reference -seoTitle: Operator | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/operator' -'og:site_name': OpenRouter Documentation -'og:title': Operator | OpenRouter Python SDK -'og:description': >- - Operator method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Operator%20-%20Python%20SDK&description=Operator%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `EQUALS` | equals | -| `NOT_EQUALS` | not_equals | -| `CONTAINS` | contains | -| `NOT_CONTAINS` | not_contains | -| `REGEX` | regex | -| `STARTS_WITH` | starts_with | -| `ENDS_WITH` | ends_with | -| `GT` | gt | -| `LT` | lt | -| `GTE` | gte | -| `LTE` | lte | -| `EXISTS` | exists | -| `NOT_EXISTS` | not_exists | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/options.mdx b/client-sdks/python/api-reference/components/options.mdx deleted file mode 100644 index ee5cbe95..00000000 --- a/client-sdks/python/api-reference/components/options.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Options - Python SDK -sidebarTitle: Options -description: Options method reference -seoTitle: Options | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/options' -'og:site_name': OpenRouter Documentation -'og:title': Options | OpenRouter Python SDK -'og:description': >- - Options method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Options%20-%20Python%20SDK&description=Options%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `oneai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ai21` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `aion_labs` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `akashml` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `alibaba` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `amazon_nova` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ambient` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `anthropic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `anyscale` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `arcee_ai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `atlas_cloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `atoma` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `avian` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `azure` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `baidu` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `baseten` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `black_forest_labs` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `byteplus` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `centml` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cerebras` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `chutes` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cirrascale` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `clarifai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cloudflare` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cohere` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crofai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crucible` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crusoe` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `darkbloom` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `deepinfra` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `deepseek` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `dekallm` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `digitalocean` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `enfer` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `fake_provider` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `featherless` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `fireworks` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `friendli` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `gmicloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `google_ai_studio` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `google_vertex` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `gopomelo` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `groq` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `huggingface` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `hyperbolic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `hyperbolic_quantized` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inception` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inceptron` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inference_net` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `infermatic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inflection` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inocloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `io_net` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ionstream` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `klusterai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lambda_` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lepton` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `liquid` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lynn` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lynn_private` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mancer` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mancer_old` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mara` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `meta` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `minimax` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mistral` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modal` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modelrun` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modular` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `moonshotai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `morph` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ncompass` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nebius` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nex_agi` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nextbit` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nineteen` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `novita` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nvidia` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `octoai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `open_inference` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `openai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `parasail` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `perceptron` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `perplexity` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `phala` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `poolside` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `recraft` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `recursal` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `reflection` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `reka` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `relace` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `replicate` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sambanova` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sambanova_cloaked` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `seed` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sf_compute` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `siliconflow` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sourceful` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `stealth` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `stepfun` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `streamlake` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `switchpoint` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `targon` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `together` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `together_lite` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ubicloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `upstage` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `venice` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `wandb` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `xai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `xiaomi` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `z_ai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/order.mdx b/client-sdks/python/api-reference/components/order.mdx deleted file mode 100644 index 891d7481..00000000 --- a/client-sdks/python/api-reference/components/order.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Order - Python SDK -sidebarTitle: Order -description: Order method reference -seoTitle: Order | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/order' -'og:site_name': OpenRouter Documentation -'og:title': Order | OpenRouter Python SDK -'og:description': >- - Order method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Order%20-%20Python%20SDK&description=Order%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputapplypatchcallitem.mdx b/client-sdks/python/api-reference/components/outputapplypatchcallitem.mdx deleted file mode 100644 index fd74975b..00000000 --- a/client-sdks/python/api-reference/components/outputapplypatchcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputApplyPatchCallItem - Python SDK -sidebarTitle: OutputApplyPatchCallItem -description: OutputApplyPatchCallItem method reference -seoTitle: OutputApplyPatchCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputapplypatchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchCallItem | OpenRouter Python SDK -'og:description': >- - OutputApplyPatchCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchCallItem%20-%20Python%20SDK&description=OutputApplyPatchCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A native `apply_patch_call` output item matching OpenAI's Responses API shape. Emitted when the client requested the `apply_patch` shorthand. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `operation` | [components.ApplyPatchCallOperation](/client-sdks/python/api-reference/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](/client-sdks/python/api-reference/components/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [components.OutputApplyPatchCallItemType](/client-sdks/python/api-reference/components/outputapplypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputapplypatchcallitemtype.mdx b/client-sdks/python/api-reference/components/outputapplypatchcallitemtype.mdx deleted file mode 100644 index d5254f67..00000000 --- a/client-sdks/python/api-reference/components/outputapplypatchcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputApplyPatchCallItemType - Python SDK -sidebarTitle: OutputApplyPatchCallItemType -description: OutputApplyPatchCallItemType method reference -seoTitle: OutputApplyPatchCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputapplypatchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchCallItemType | OpenRouter Python SDK -'og:description': >- - OutputApplyPatchCallItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchCallItemType%20-%20Python%20SDK&description=OutputApplyPatchCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `APPLY_PATCH_CALL` | apply_patch_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputapplypatchservertoolitem.mdx b/client-sdks/python/api-reference/components/outputapplypatchservertoolitem.mdx deleted file mode 100644 index 6ec19b69..00000000 --- a/client-sdks/python/api-reference/components/outputapplypatchservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputApplyPatchServerToolItem - Python SDK -sidebarTitle: OutputApplyPatchServerToolItem -description: OutputApplyPatchServerToolItem method reference -seoTitle: OutputApplyPatchServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputapplypatchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputApplyPatchServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItem%20-%20Python%20SDK&description=OutputApplyPatchServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:apply_patch server tool output item. The turn halts when validation succeeds so the client can apply the patch and echo an `apply_patch_call_output` on the next turn. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `call_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `operation` | [Optional[components.ApplyPatchCallOperation]](../components/applypatchcalloperation.md) | :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](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputApplyPatchServerToolItemType](/client-sdks/python/api-reference/components/outputapplypatchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputapplypatchservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputapplypatchservertoolitemtype.mdx deleted file mode 100644 index 2ff6b99a..00000000 --- a/client-sdks/python/api-reference/components/outputapplypatchservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputApplyPatchServerToolItemType - Python SDK -sidebarTitle: OutputApplyPatchServerToolItemType -description: OutputApplyPatchServerToolItemType method reference -seoTitle: OutputApplyPatchServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputapplypatchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputApplyPatchServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItemType%20-%20Python%20SDK&description=OutputApplyPatchServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_APPLY_PATCH` | openrouter:apply_patch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputbashservertoolitem.mdx b/client-sdks/python/api-reference/components/outputbashservertoolitem.mdx deleted file mode 100644 index 4494ab9a..00000000 --- a/client-sdks/python/api-reference/components/outputbashservertoolitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputBashServerToolItem - Python SDK -sidebarTitle: OutputBashServerToolItem -description: OutputBashServerToolItem method reference -seoTitle: OutputBashServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputbashservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputBashServerToolItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItem%20-%20Python%20SDK&description=OutputBashServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:bash server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `command` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputBashServerToolItemType](/client-sdks/python/api-reference/components/outputbashservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputbashservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputbashservertoolitemtype.mdx deleted file mode 100644 index e43474c1..00000000 --- a/client-sdks/python/api-reference/components/outputbashservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputBashServerToolItemType - Python SDK -sidebarTitle: OutputBashServerToolItemType -description: OutputBashServerToolItemType method reference -seoTitle: OutputBashServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputbashservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputBashServerToolItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItemType%20-%20Python%20SDK&description=OutputBashServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `OPENROUTER_BASH` | openrouter:bash | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputbrowseruseservertoolitem.mdx b/client-sdks/python/api-reference/components/outputbrowseruseservertoolitem.mdx deleted file mode 100644 index b7dfb700..00000000 --- a/client-sdks/python/api-reference/components/outputbrowseruseservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputBrowserUseServerToolItem - Python SDK -sidebarTitle: OutputBrowserUseServerToolItem -description: OutputBrowserUseServerToolItem method reference -seoTitle: OutputBrowserUseServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputbrowseruseservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputBrowserUseServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItem%20-%20Python%20SDK&description=OutputBrowserUseServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:browser_use server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `action` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `screenshot_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputBrowserUseServerToolItemType](/client-sdks/python/api-reference/components/outputbrowseruseservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputbrowseruseservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputbrowseruseservertoolitemtype.mdx deleted file mode 100644 index d8a794a5..00000000 --- a/client-sdks/python/api-reference/components/outputbrowseruseservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputBrowserUseServerToolItemType - Python SDK -sidebarTitle: OutputBrowserUseServerToolItemType -description: OutputBrowserUseServerToolItemType method reference -seoTitle: OutputBrowserUseServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputbrowseruseservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputBrowserUseServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItemType%20-%20Python%20SDK&description=OutputBrowserUseServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_BROWSER_USE` | openrouter:browser_use | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcodeinterpretercallitem.mdx b/client-sdks/python/api-reference/components/outputcodeinterpretercallitem.mdx deleted file mode 100644 index c967fbec..00000000 --- a/client-sdks/python/api-reference/components/outputcodeinterpretercallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputCodeInterpreterCallItem - Python SDK -sidebarTitle: OutputCodeInterpreterCallItem -description: OutputCodeInterpreterCallItem method reference -seoTitle: OutputCodeInterpreterCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcodeinterpretercallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItem | OpenRouter Python SDK -'og:description': >- - OutputCodeInterpreterCallItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItem%20-%20Python%20SDK&description=OutputCodeInterpreterCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A code interpreter execution call with outputs - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `code` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `container_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `outputs` | List[[components.OutputCodeInterpreterCallItemOutputUnion](/client-sdks/python/api-reference/components/outputcodeinterpretercallitemoutputunion)] | :heavy_check_mark: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.TypeCodeInterpreterCall](/client-sdks/python/api-reference/components/typecodeinterpretercall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcodeinterpretercallitemoutputunion.mdx b/client-sdks/python/api-reference/components/outputcodeinterpretercallitemoutputunion.mdx deleted file mode 100644 index e8ebd1d0..00000000 --- a/client-sdks/python/api-reference/components/outputcodeinterpretercallitemoutputunion.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputCodeInterpreterCallItemOutputUnion - Python SDK -sidebarTitle: OutputCodeInterpreterCallItemOutputUnion -description: OutputCodeInterpreterCallItemOutputUnion method reference -seoTitle: OutputCodeInterpreterCallItemOutputUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcodeinterpretercallitemoutputunion -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItemOutputUnion | OpenRouter Python SDK -'og:description': >- - OutputCodeInterpreterCallItemOutputUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItemOutputUnion%20-%20Python%20SDK&description=OutputCodeInterpreterCallItemOutputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputImage` - -```python lines -value: components.OutputImage = /* values here */ -``` - -### `components.OutputLogs` - -```python lines -value: components.OutputLogs = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcodeinterpretercallitemtypeimage.mdx b/client-sdks/python/api-reference/components/outputcodeinterpretercallitemtypeimage.mdx deleted file mode 100644 index 25169106..00000000 --- a/client-sdks/python/api-reference/components/outputcodeinterpretercallitemtypeimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputCodeInterpreterCallItemTypeImage - Python SDK -sidebarTitle: OutputCodeInterpreterCallItemTypeImage -description: OutputCodeInterpreterCallItemTypeImage method reference -seoTitle: OutputCodeInterpreterCallItemTypeImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcodeinterpretercallitemtypeimage -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItemTypeImage | OpenRouter Python SDK -'og:description': >- - OutputCodeInterpreterCallItemTypeImage method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItemTypeImage%20-%20Python%20SDK&description=OutputCodeInterpreterCallItemTypeImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitem.mdx b/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitem.mdx deleted file mode 100644 index 5c82bcf2..00000000 --- a/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItem - Python SDK -sidebarTitle: OutputCodeInterpreterServerToolItem -description: OutputCodeInterpreterServerToolItem method reference -seoTitle: OutputCodeInterpreterServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcodeinterpreterservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputCodeInterpreterServerToolItem method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItem%20-%20Python%20SDK&description=OutputCodeInterpreterServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:code_interpreter server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `code` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `exit_code` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `language` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `stderr` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `stdout` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputCodeInterpreterServerToolItemType](/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitemtype.mdx deleted file mode 100644 index 6b2dc102..00000000 --- a/client-sdks/python/api-reference/components/outputcodeinterpreterservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItemType - Python SDK -sidebarTitle: OutputCodeInterpreterServerToolItemType -description: OutputCodeInterpreterServerToolItemType method reference -seoTitle: OutputCodeInterpreterServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcodeinterpreterservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputCodeInterpreterServerToolItemType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItemType%20-%20Python%20SDK&description=OutputCodeInterpreterServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `OPENROUTER_CODE_INTERPRETER` | openrouter:code_interpreter | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcomputercallitem.mdx b/client-sdks/python/api-reference/components/outputcomputercallitem.mdx deleted file mode 100644 index b3b7375a..00000000 --- a/client-sdks/python/api-reference/components/outputcomputercallitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputComputerCallItem - Python SDK -sidebarTitle: OutputComputerCallItem -description: OutputComputerCallItem method reference -seoTitle: OutputComputerCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcomputercallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItem | OpenRouter Python SDK -'og:description': >- - OutputComputerCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItem%20-%20Python%20SDK&description=OutputComputerCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `action` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `pending_safety_checks` | List[[components.PendingSafetyCheck](/client-sdks/python/api-reference/components/pendingsafetycheck)] | :heavy_check_mark: | N/A | -| `status` | [components.OutputComputerCallItemStatus](/client-sdks/python/api-reference/components/outputcomputercallitemstatus) | :heavy_check_mark: | N/A | -| `type` | [components.OutputComputerCallItemType](/client-sdks/python/api-reference/components/outputcomputercallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcomputercallitemstatus.mdx b/client-sdks/python/api-reference/components/outputcomputercallitemstatus.mdx deleted file mode 100644 index 7efcffc3..00000000 --- a/client-sdks/python/api-reference/components/outputcomputercallitemstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OutputComputerCallItemStatus - Python SDK -sidebarTitle: OutputComputerCallItemStatus -description: OutputComputerCallItemStatus method reference -seoTitle: OutputComputerCallItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcomputercallitemstatus -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemStatus | OpenRouter Python SDK -'og:description': >- - OutputComputerCallItemStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemStatus%20-%20Python%20SDK&description=OutputComputerCallItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcomputercallitemtype.mdx b/client-sdks/python/api-reference/components/outputcomputercallitemtype.mdx deleted file mode 100644 index 5da504bc..00000000 --- a/client-sdks/python/api-reference/components/outputcomputercallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputComputerCallItemType - Python SDK -sidebarTitle: OutputComputerCallItemType -description: OutputComputerCallItemType method reference -seoTitle: OutputComputerCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcomputercallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemType | OpenRouter Python SDK -'og:description': >- - OutputComputerCallItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemType%20-%20Python%20SDK&description=OutputComputerCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `COMPUTER_CALL` | computer_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcustomtoolcallitem.mdx b/client-sdks/python/api-reference/components/outputcustomtoolcallitem.mdx deleted file mode 100644 index 21dcc316..00000000 --- a/client-sdks/python/api-reference/components/outputcustomtoolcallitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputCustomToolCallItem - Python SDK -sidebarTitle: OutputCustomToolCallItem -description: OutputCustomToolCallItem method reference -seoTitle: OutputCustomToolCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcustomtoolcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItem | OpenRouter Python SDK -'og:description': >- - OutputCustomToolCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItem%20-%20Python%20SDK&description=OutputCustomToolCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `input` | *str* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [components.OutputCustomToolCallItemType](/client-sdks/python/api-reference/components/outputcustomtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputcustomtoolcallitemtype.mdx b/client-sdks/python/api-reference/components/outputcustomtoolcallitemtype.mdx deleted file mode 100644 index 6ab2d254..00000000 --- a/client-sdks/python/api-reference/components/outputcustomtoolcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputCustomToolCallItemType - Python SDK -sidebarTitle: OutputCustomToolCallItemType -description: OutputCustomToolCallItemType method reference -seoTitle: OutputCustomToolCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputcustomtoolcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItemType | OpenRouter Python SDK -'og:description': >- - OutputCustomToolCallItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItemType%20-%20Python%20SDK&description=OutputCustomToolCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `CUSTOM_TOOL_CALL` | custom_tool_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputdatetimeitem.mdx b/client-sdks/python/api-reference/components/outputdatetimeitem.mdx deleted file mode 100644 index b30f29f0..00000000 --- a/client-sdks/python/api-reference/components/outputdatetimeitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputDatetimeItem - Python SDK -sidebarTitle: OutputDatetimeItem -description: OutputDatetimeItem method reference -seoTitle: OutputDatetimeItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputdatetimeitem -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItem | OpenRouter Python SDK -'og:description': >- - OutputDatetimeItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItem%20-%20Python%20SDK&description=OutputDatetimeItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:datetime server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `datetime` | *str* | :heavy_check_mark: | ISO 8601 datetime string | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `timezone` | *str* | :heavy_check_mark: | IANA timezone name | | -| `type` | [components.OutputDatetimeItemType](/client-sdks/python/api-reference/components/outputdatetimeitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputdatetimeitemtype.mdx b/client-sdks/python/api-reference/components/outputdatetimeitemtype.mdx deleted file mode 100644 index 711bbcae..00000000 --- a/client-sdks/python/api-reference/components/outputdatetimeitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputDatetimeItemType - Python SDK -sidebarTitle: OutputDatetimeItemType -description: OutputDatetimeItemType method reference -seoTitle: OutputDatetimeItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputdatetimeitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItemType | OpenRouter Python SDK -'og:description': >- - OutputDatetimeItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItemType%20-%20Python%20SDK&description=OutputDatetimeItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `OPENROUTER_DATETIME` | openrouter:datetime | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfilesearchcallitem.mdx b/client-sdks/python/api-reference/components/outputfilesearchcallitem.mdx deleted file mode 100644 index 1cffa9f3..00000000 --- a/client-sdks/python/api-reference/components/outputfilesearchcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputFileSearchCallItem - Python SDK -sidebarTitle: OutputFileSearchCallItem -description: OutputFileSearchCallItem method reference -seoTitle: OutputFileSearchCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfilesearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItem | OpenRouter Python SDK -'og:description': >- - OutputFileSearchCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItem%20-%20Python%20SDK&description=OutputFileSearchCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `queries` | List[*str*] | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](/client-sdks/python/api-reference/components/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFileSearchCallItemType](/client-sdks/python/api-reference/components/outputfilesearchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfilesearchcallitemtype.mdx b/client-sdks/python/api-reference/components/outputfilesearchcallitemtype.mdx deleted file mode 100644 index 106774a3..00000000 --- a/client-sdks/python/api-reference/components/outputfilesearchcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFileSearchCallItemType - Python SDK -sidebarTitle: OutputFileSearchCallItemType -description: OutputFileSearchCallItemType method reference -seoTitle: OutputFileSearchCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfilesearchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItemType | OpenRouter Python SDK -'og:description': >- - OutputFileSearchCallItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItemType%20-%20Python%20SDK&description=OutputFileSearchCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `FILE_SEARCH_CALL` | file_search_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfilesearchservertoolitem.mdx b/client-sdks/python/api-reference/components/outputfilesearchservertoolitem.mdx deleted file mode 100644 index d5119ff7..00000000 --- a/client-sdks/python/api-reference/components/outputfilesearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputFileSearchServerToolItem - Python SDK -sidebarTitle: OutputFileSearchServerToolItem -description: OutputFileSearchServerToolItem method reference -seoTitle: OutputFileSearchServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfilesearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputFileSearchServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItem%20-%20Python%20SDK&description=OutputFileSearchServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:file_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `queries` | List[*str*] | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFileSearchServerToolItemType](/client-sdks/python/api-reference/components/outputfilesearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfilesearchservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputfilesearchservertoolitemtype.mdx deleted file mode 100644 index 1f0dcaaa..00000000 --- a/client-sdks/python/api-reference/components/outputfilesearchservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFileSearchServerToolItemType - Python SDK -sidebarTitle: OutputFileSearchServerToolItemType -description: OutputFileSearchServerToolItemType method reference -seoTitle: OutputFileSearchServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfilesearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputFileSearchServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItemType%20-%20Python%20SDK&description=OutputFileSearchServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_FILE_SEARCH` | openrouter:file_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputformat.mdx b/client-sdks/python/api-reference/components/outputformat.mdx deleted file mode 100644 index 18a365c4..00000000 --- a/client-sdks/python/api-reference/components/outputformat.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OutputFormat - Python SDK -sidebarTitle: OutputFormat -description: OutputFormat method reference -seoTitle: OutputFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputformat' -'og:site_name': OpenRouter Documentation -'og:title': OutputFormat | OpenRouter Python SDK -'og:description': >- - OutputFormat method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFormat%20-%20Python%20SDK&description=OutputFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `PNG` | png | -| `WEBP` | webp | -| `JPEG` | jpeg | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitem.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitem.mdx deleted file mode 100644 index b89804d6..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputFunctionCallItem - Python SDK -sidebarTitle: OutputFunctionCallItem -description: OutputFunctionCallItem method reference -seoTitle: OutputFunctionCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItem | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItem%20-%20Python%20SDK&description=OutputFunctionCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `namespace` | *Optional[str]* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `status` | [Optional[components.OutputFunctionCallItemStatusUnion]](../components/outputfunctioncallitemstatusunion.md) | :heavy_minus_sign: | N/A | -| `type` | [components.OutputFunctionCallItemType](/client-sdks/python/api-reference/components/outputfunctioncallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitemstatuscompleted.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitemstatuscompleted.mdx deleted file mode 100644 index c56eca1c..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitemstatuscompleted.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFunctionCallItemStatusCompleted - Python SDK -sidebarTitle: OutputFunctionCallItemStatusCompleted -description: OutputFunctionCallItemStatusCompleted method reference -seoTitle: OutputFunctionCallItemStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusCompleted | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItemStatusCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusCompleted%20-%20Python%20SDK&description=OutputFunctionCallItemStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusincomplete.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitemstatusincomplete.mdx deleted file mode 100644 index ee10485f..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusincomplete.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFunctionCallItemStatusIncomplete - Python SDK -sidebarTitle: OutputFunctionCallItemStatusIncomplete -description: OutputFunctionCallItemStatusIncomplete method reference -seoTitle: OutputFunctionCallItemStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItemStatusIncomplete method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusIncomplete%20-%20Python%20SDK&description=OutputFunctionCallItemStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusinprogress.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitemstatusinprogress.mdx deleted file mode 100644 index 82753a91..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusinprogress.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFunctionCallItemStatusInProgress - Python SDK -sidebarTitle: OutputFunctionCallItemStatusInProgress -description: OutputFunctionCallItemStatusInProgress method reference -seoTitle: OutputFunctionCallItemStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusInProgress | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItemStatusInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusInProgress%20-%20Python%20SDK&description=OutputFunctionCallItemStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusunion.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitemstatusunion.mdx deleted file mode 100644 index 6b6bccf1..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputFunctionCallItemStatusUnion - Python SDK -sidebarTitle: OutputFunctionCallItemStatusUnion -description: OutputFunctionCallItemStatusUnion method reference -seoTitle: OutputFunctionCallItemStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusUnion | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItemStatusUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusUnion%20-%20Python%20SDK&description=OutputFunctionCallItemStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputFunctionCallItemStatusCompleted` - -```python lines -value: components.OutputFunctionCallItemStatusCompleted = /* values here */ -``` - -### `components.OutputFunctionCallItemStatusIncomplete` - -```python lines -value: components.OutputFunctionCallItemStatusIncomplete = /* values here */ -``` - -### `components.OutputFunctionCallItemStatusInProgress` - -```python lines -value: components.OutputFunctionCallItemStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfunctioncallitemtype.mdx b/client-sdks/python/api-reference/components/outputfunctioncallitemtype.mdx deleted file mode 100644 index b81f007e..00000000 --- a/client-sdks/python/api-reference/components/outputfunctioncallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFunctionCallItemType - Python SDK -sidebarTitle: OutputFunctionCallItemType -description: OutputFunctionCallItemType method reference -seoTitle: OutputFunctionCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfunctioncallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemType | OpenRouter Python SDK -'og:description': >- - OutputFunctionCallItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemType%20-%20Python%20SDK&description=OutputFunctionCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfusionservertoolitem.mdx b/client-sdks/python/api-reference/components/outputfusionservertoolitem.mdx deleted file mode 100644 index d34ccbc1..00000000 --- a/client-sdks/python/api-reference/components/outputfusionservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputFusionServerToolItem - Python SDK -sidebarTitle: OutputFusionServerToolItem -description: OutputFusionServerToolItem method reference -seoTitle: OutputFusionServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfusionservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFusionServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputFusionServerToolItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFusionServerToolItem%20-%20Python%20SDK&description=OutputFusionServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:fusion server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [Optional[components.Analysis]](../components/analysis.md) | :heavy_minus_sign: | Structured analysis produced by the fusion judge model. | | -| `error` | *Optional[str]* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `failed_models` | List[[components.FailedModel](/client-sdks/python/api-reference/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. | | -| `failure_reason` | *Optional[str]* | :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. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `responses` | List[[components.Response](/client-sdks/python/api-reference/components/response)] | :heavy_minus_sign: | Slugs of the analysis models that produced a response in this fusion run. | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputFusionServerToolItemType](/client-sdks/python/api-reference/components/outputfusionservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputfusionservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputfusionservertoolitemtype.mdx deleted file mode 100644 index 8dc2086b..00000000 --- a/client-sdks/python/api-reference/components/outputfusionservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputFusionServerToolItemType - Python SDK -sidebarTitle: OutputFusionServerToolItemType -description: OutputFusionServerToolItemType method reference -seoTitle: OutputFusionServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputfusionservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFusionServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputFusionServerToolItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFusionServerToolItemType%20-%20Python%20SDK&description=OutputFusionServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `OPENROUTER_FUSION` | openrouter:fusion | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputimage.mdx b/client-sdks/python/api-reference/components/outputimage.mdx deleted file mode 100644 index 3c5e3665..00000000 --- a/client-sdks/python/api-reference/components/outputimage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputImage - Python SDK -sidebarTitle: OutputImage -description: OutputImage method reference -seoTitle: OutputImage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputimage' -'og:site_name': OpenRouter Documentation -'og:title': OutputImage | OpenRouter Python SDK -'og:description': >- - OutputImage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImage%20-%20Python%20SDK&description=OutputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OutputCodeInterpreterCallItemTypeImage](/client-sdks/python/api-reference/components/outputcodeinterpretercallitemtypeimage) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputimagegenerationcallitem.mdx b/client-sdks/python/api-reference/components/outputimagegenerationcallitem.mdx deleted file mode 100644 index 44b8d2cd..00000000 --- a/client-sdks/python/api-reference/components/outputimagegenerationcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputImageGenerationCallItem - Python SDK -sidebarTitle: OutputImageGenerationCallItem -description: OutputImageGenerationCallItem method reference -seoTitle: OutputImageGenerationCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputimagegenerationcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItem | OpenRouter Python SDK -'og:description': >- - OutputImageGenerationCallItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItem%20-%20Python%20SDK&description=OutputImageGenerationCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](/client-sdks/python/api-reference/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputImageGenerationCallItemType](/client-sdks/python/api-reference/components/outputimagegenerationcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputimagegenerationcallitemtype.mdx b/client-sdks/python/api-reference/components/outputimagegenerationcallitemtype.mdx deleted file mode 100644 index 2d875232..00000000 --- a/client-sdks/python/api-reference/components/outputimagegenerationcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputImageGenerationCallItemType - Python SDK -sidebarTitle: OutputImageGenerationCallItemType -description: OutputImageGenerationCallItemType method reference -seoTitle: OutputImageGenerationCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputimagegenerationcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItemType | OpenRouter Python SDK -'og:description': >- - OutputImageGenerationCallItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItemType%20-%20Python%20SDK&description=OutputImageGenerationCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `IMAGE_GENERATION_CALL` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputimagegenerationservertoolitem.mdx b/client-sdks/python/api-reference/components/outputimagegenerationservertoolitem.mdx deleted file mode 100644 index 7429cf5c..00000000 --- a/client-sdks/python/api-reference/components/outputimagegenerationservertoolitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputImageGenerationServerToolItem - Python SDK -sidebarTitle: OutputImageGenerationServerToolItem -description: OutputImageGenerationServerToolItem method reference -seoTitle: OutputImageGenerationServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputimagegenerationservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputImageGenerationServerToolItem method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItem%20-%20Python%20SDK&description=OutputImageGenerationServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:image_generation server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `image_b64` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `image_url` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `revised_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputImageGenerationServerToolItemType](/client-sdks/python/api-reference/components/outputimagegenerationservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputimagegenerationservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputimagegenerationservertoolitemtype.mdx deleted file mode 100644 index f10445cc..00000000 --- a/client-sdks/python/api-reference/components/outputimagegenerationservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputImageGenerationServerToolItemType - Python SDK -sidebarTitle: OutputImageGenerationServerToolItemType -description: OutputImageGenerationServerToolItemType method reference -seoTitle: OutputImageGenerationServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputimagegenerationservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputImageGenerationServerToolItemType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItemType%20-%20Python%20SDK&description=OutputImageGenerationServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `OPENROUTER_IMAGE_GENERATION` | openrouter:image_generation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputitemimagegenerationcall.mdx b/client-sdks/python/api-reference/components/outputitemimagegenerationcall.mdx deleted file mode 100644 index b96514c5..00000000 --- a/client-sdks/python/api-reference/components/outputitemimagegenerationcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputItemImageGenerationCall - Python SDK -sidebarTitle: OutputItemImageGenerationCall -description: OutputItemImageGenerationCall method reference -seoTitle: OutputItemImageGenerationCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputitemimagegenerationcall -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCall | OpenRouter Python SDK -'og:description': >- - OutputItemImageGenerationCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCall%20-%20Python%20SDK&description=OutputItemImageGenerationCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](/client-sdks/python/api-reference/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputItemImageGenerationCallType](/client-sdks/python/api-reference/components/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputitemimagegenerationcalltype.mdx b/client-sdks/python/api-reference/components/outputitemimagegenerationcalltype.mdx deleted file mode 100644 index 463fc321..00000000 --- a/client-sdks/python/api-reference/components/outputitemimagegenerationcalltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputItemImageGenerationCallType - Python SDK -sidebarTitle: OutputItemImageGenerationCallType -description: OutputItemImageGenerationCallType method reference -seoTitle: OutputItemImageGenerationCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputitemimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCallType | OpenRouter Python SDK -'og:description': >- - OutputItemImageGenerationCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCallType%20-%20Python%20SDK&description=OutputItemImageGenerationCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `IMAGE_GENERATION_CALL` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputitems.mdx b/client-sdks/python/api-reference/components/outputitems.mdx deleted file mode 100644 index 8f81140b..00000000 --- a/client-sdks/python/api-reference/components/outputitems.mdx +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: OutputItems - Python SDK -sidebarTitle: OutputItems -description: OutputItems method reference -seoTitle: OutputItems | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputitems' -'og:site_name': OpenRouter Documentation -'og:title': OutputItems | OpenRouter Python SDK -'og:description': >- - OutputItems method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItems%20-%20Python%20SDK&description=OutputItems%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output item from the response - -## Supported Types - -### `components.OutputApplyPatchCallItem` - -```python lines -value: components.OutputApplyPatchCallItem = /* values here */ -``` - -### `components.OutputCodeInterpreterCallItem` - -```python lines -value: components.OutputCodeInterpreterCallItem = /* values here */ -``` - -### `components.OutputComputerCallItem` - -```python lines -value: components.OutputComputerCallItem = /* values here */ -``` - -### `components.OutputCustomToolCallItem` - -```python lines -value: components.OutputCustomToolCallItem = /* values here */ -``` - -### `components.OutputFileSearchCallItem` - -```python lines -value: components.OutputFileSearchCallItem = /* values here */ -``` - -### `components.OutputFunctionCallItem` - -```python lines -value: components.OutputFunctionCallItem = /* values here */ -``` - -### `components.OutputImageGenerationCallItem` - -```python lines -value: components.OutputImageGenerationCallItem = /* values here */ -``` - -### `components.OutputMessageItem` - -```python lines -value: components.OutputMessageItem = /* values here */ -``` - -### `components.OutputApplyPatchServerToolItem` - -```python lines -value: components.OutputApplyPatchServerToolItem = /* values here */ -``` - -### `components.OutputBashServerToolItem` - -```python lines -value: components.OutputBashServerToolItem = /* values here */ -``` - -### `components.OutputBrowserUseServerToolItem` - -```python lines -value: components.OutputBrowserUseServerToolItem = /* values here */ -``` - -### `components.OutputCodeInterpreterServerToolItem` - -```python lines -value: components.OutputCodeInterpreterServerToolItem = /* values here */ -``` - -### `components.OutputDatetimeItem` - -```python lines -value: components.OutputDatetimeItem = /* values here */ -``` - -### `components.OutputSearchModelsServerToolItem` - -```python lines -value: components.OutputSearchModelsServerToolItem = /* values here */ -``` - -### `components.OutputFileSearchServerToolItem` - -```python lines -value: components.OutputFileSearchServerToolItem = /* values here */ -``` - -### `components.OutputFusionServerToolItem` - -```python lines -value: components.OutputFusionServerToolItem = /* values here */ -``` - -### `components.OutputImageGenerationServerToolItem` - -```python lines -value: components.OutputImageGenerationServerToolItem = /* values here */ -``` - -### `components.OutputMcpServerToolItem` - -```python lines -value: components.OutputMcpServerToolItem = /* values here */ -``` - -### `components.OutputMemoryServerToolItem` - -```python lines -value: components.OutputMemoryServerToolItem = /* values here */ -``` - -### `components.OutputTextEditorServerToolItem` - -```python lines -value: components.OutputTextEditorServerToolItem = /* values here */ -``` - -### `components.OutputToolSearchServerToolItem` - -```python lines -value: components.OutputToolSearchServerToolItem = /* values here */ -``` - -### `components.OutputWebFetchServerToolItem` - -```python lines -value: components.OutputWebFetchServerToolItem = /* values here */ -``` - -### `components.OutputWebSearchServerToolItem` - -```python lines -value: components.OutputWebSearchServerToolItem = /* values here */ -``` - -### `components.OutputReasoningItem` - -```python lines -value: components.OutputReasoningItem = /* values here */ -``` - -### `components.OutputWebSearchCallItem` - -```python lines -value: components.OutputWebSearchCallItem = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputlogs.mdx b/client-sdks/python/api-reference/components/outputlogs.mdx deleted file mode 100644 index cf0f23e4..00000000 --- a/client-sdks/python/api-reference/components/outputlogs.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputLogs - Python SDK -sidebarTitle: OutputLogs -description: OutputLogs method reference -seoTitle: OutputLogs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputlogs' -'og:site_name': OpenRouter Documentation -'og:title': OutputLogs | OpenRouter Python SDK -'og:description': >- - OutputLogs method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputLogs%20-%20Python%20SDK&description=OutputLogs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `logs` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeLogs](/client-sdks/python/api-reference/components/typelogs) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmcpservertoolitem.mdx b/client-sdks/python/api-reference/components/outputmcpservertoolitem.mdx deleted file mode 100644 index e257b81f..00000000 --- a/client-sdks/python/api-reference/components/outputmcpservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMcpServerToolItem - Python SDK -sidebarTitle: OutputMcpServerToolItem -description: OutputMcpServerToolItem method reference -seoTitle: OutputMcpServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmcpservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputMcpServerToolItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItem%20-%20Python%20SDK&description=OutputMcpServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:mcp server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `server_label` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `tool_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputMcpServerToolItemType](/client-sdks/python/api-reference/components/outputmcpservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmcpservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputmcpservertoolitemtype.mdx deleted file mode 100644 index 00ab9fb2..00000000 --- a/client-sdks/python/api-reference/components/outputmcpservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMcpServerToolItemType - Python SDK -sidebarTitle: OutputMcpServerToolItemType -description: OutputMcpServerToolItemType method reference -seoTitle: OutputMcpServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmcpservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputMcpServerToolItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItemType%20-%20Python%20SDK&description=OutputMcpServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `OPENROUTER_MCP` | openrouter:mcp | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmemoryservertoolitem.mdx b/client-sdks/python/api-reference/components/outputmemoryservertoolitem.mdx deleted file mode 100644 index 3ab2535e..00000000 --- a/client-sdks/python/api-reference/components/outputmemoryservertoolitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputMemoryServerToolItem - Python SDK -sidebarTitle: OutputMemoryServerToolItem -description: OutputMemoryServerToolItem method reference -seoTitle: OutputMemoryServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmemoryservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputMemoryServerToolItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItem%20-%20Python%20SDK&description=OutputMemoryServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:memory server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `action` | [Optional[components.ActionEnum]](../components/actionenum.md) | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputMemoryServerToolItemType](/client-sdks/python/api-reference/components/outputmemoryservertoolitemtype) | :heavy_check_mark: | N/A | | -| `value` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmemoryservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputmemoryservertoolitemtype.mdx deleted file mode 100644 index 4d7ef6c4..00000000 --- a/client-sdks/python/api-reference/components/outputmemoryservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMemoryServerToolItemType - Python SDK -sidebarTitle: OutputMemoryServerToolItemType -description: OutputMemoryServerToolItemType method reference -seoTitle: OutputMemoryServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmemoryservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputMemoryServerToolItemType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItemType%20-%20Python%20SDK&description=OutputMemoryServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `OPENROUTER_MEMORY` | openrouter:memory | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessage.mdx b/client-sdks/python/api-reference/components/outputmessage.mdx deleted file mode 100644 index 01ae6f3e..00000000 --- a/client-sdks/python/api-reference/components/outputmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OutputMessage - Python SDK -sidebarTitle: OutputMessage -description: OutputMessage method reference -seoTitle: OutputMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputmessage' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessage | OpenRouter Python SDK -'og:description': >- - OutputMessage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessage%20-%20Python%20SDK&description=OutputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageContent](/client-sdks/python/api-reference/components/outputmessagecontent)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.OutputMessagePhaseUnion]](../components/outputmessagephaseunion.md) | :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](/client-sdks/python/api-reference/components/outputmessagerole) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.md) | :heavy_minus_sign: | N/A | -| `type` | [components.OutputMessageType](/client-sdks/python/api-reference/components/outputmessagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagecontent.mdx b/client-sdks/python/api-reference/components/outputmessagecontent.mdx deleted file mode 100644 index 89c41dbf..00000000 --- a/client-sdks/python/api-reference/components/outputmessagecontent.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageContent - Python SDK -sidebarTitle: OutputMessageContent -description: OutputMessageContent method reference -seoTitle: OutputMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageContent | OpenRouter Python SDK -'og:description': >- - OutputMessageContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageContent%20-%20Python%20SDK&description=OutputMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitem.mdx b/client-sdks/python/api-reference/components/outputmessageitem.mdx deleted file mode 100644 index 451aa74d..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputMessageItem - Python SDK -sidebarTitle: OutputMessageItem -description: OutputMessageItem method reference -seoTitle: OutputMessageItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItem | OpenRouter Python SDK -'og:description': >- - OutputMessageItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItem%20-%20Python%20SDK&description=OutputMessageItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output message item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | List[[components.OutputMessageItemContent](/client-sdks/python/api-reference/components/outputmessageitemcontent)] | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `phase` | [OptionalNullable[components.OutputMessageItemPhaseUnion]](../components/outputmessageitemphaseunion.md) | :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](/client-sdks/python/api-reference/components/outputmessageitemrole) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputMessageItemStatusUnion]](../components/outputmessageitemstatusunion.md) | :heavy_minus_sign: | N/A | -| `type` | [components.OutputMessageItemType](/client-sdks/python/api-reference/components/outputmessageitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemcontent.mdx b/client-sdks/python/api-reference/components/outputmessageitemcontent.mdx deleted file mode 100644 index 114a356a..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemcontent.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemContent - Python SDK -sidebarTitle: OutputMessageItemContent -description: OutputMessageItemContent method reference -seoTitle: OutputMessageItemContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemContent | OpenRouter Python SDK -'og:description': >- - OutputMessageItemContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemContent%20-%20Python%20SDK&description=OutputMessageItemContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemphasecommentary.mdx b/client-sdks/python/api-reference/components/outputmessageitemphasecommentary.mdx deleted file mode 100644 index 7323c316..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemphasecommentary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemPhaseCommentary - Python SDK -sidebarTitle: OutputMessageItemPhaseCommentary -description: OutputMessageItemPhaseCommentary method reference -seoTitle: OutputMessageItemPhaseCommentary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseCommentary | OpenRouter Python SDK -'og:description': >- - OutputMessageItemPhaseCommentary method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseCommentary%20-%20Python%20SDK&description=OutputMessageItemPhaseCommentary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMMENTARY` | commentary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemphasefinalanswer.mdx b/client-sdks/python/api-reference/components/outputmessageitemphasefinalanswer.mdx deleted file mode 100644 index 1af169aa..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemphasefinalanswer.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemPhaseFinalAnswer - Python SDK -sidebarTitle: OutputMessageItemPhaseFinalAnswer -description: OutputMessageItemPhaseFinalAnswer method reference -seoTitle: OutputMessageItemPhaseFinalAnswer | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseFinalAnswer | OpenRouter Python SDK -'og:description': >- - OutputMessageItemPhaseFinalAnswer method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseFinalAnswer%20-%20Python%20SDK&description=OutputMessageItemPhaseFinalAnswer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FINAL_ANSWER` | final_answer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemphaseunion.mdx b/client-sdks/python/api-reference/components/outputmessageitemphaseunion.mdx deleted file mode 100644 index 4fe806a7..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemphaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputMessageItemPhaseUnion - Python SDK -sidebarTitle: OutputMessageItemPhaseUnion -description: OutputMessageItemPhaseUnion method reference -seoTitle: OutputMessageItemPhaseUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemphaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseUnion | OpenRouter Python SDK -'og:description': >- - OutputMessageItemPhaseUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseUnion%20-%20Python%20SDK&description=OutputMessageItemPhaseUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `components.OutputMessageItemPhaseCommentary` - -```python lines -value: components.OutputMessageItemPhaseCommentary = /* values here */ -``` - -### `components.OutputMessageItemPhaseFinalAnswer` - -```python lines -value: components.OutputMessageItemPhaseFinalAnswer = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemrole.mdx b/client-sdks/python/api-reference/components/outputmessageitemrole.mdx deleted file mode 100644 index 7a8e3bcd..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemrole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemRole - Python SDK -sidebarTitle: OutputMessageItemRole -description: OutputMessageItemRole method reference -seoTitle: OutputMessageItemRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemrole -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemRole | OpenRouter Python SDK -'og:description': >- - OutputMessageItemRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemRole%20-%20Python%20SDK&description=OutputMessageItemRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemstatuscompleted.mdx b/client-sdks/python/api-reference/components/outputmessageitemstatuscompleted.mdx deleted file mode 100644 index 9dd04180..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemstatuscompleted.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemStatusCompleted - Python SDK -sidebarTitle: OutputMessageItemStatusCompleted -description: OutputMessageItemStatusCompleted method reference -seoTitle: OutputMessageItemStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusCompleted | OpenRouter Python SDK -'og:description': >- - OutputMessageItemStatusCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusCompleted%20-%20Python%20SDK&description=OutputMessageItemStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemstatusincomplete.mdx b/client-sdks/python/api-reference/components/outputmessageitemstatusincomplete.mdx deleted file mode 100644 index b7494e2c..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemstatusincomplete.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemStatusIncomplete - Python SDK -sidebarTitle: OutputMessageItemStatusIncomplete -description: OutputMessageItemStatusIncomplete method reference -seoTitle: OutputMessageItemStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OutputMessageItemStatusIncomplete method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusIncomplete%20-%20Python%20SDK&description=OutputMessageItemStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemstatusinprogress.mdx b/client-sdks/python/api-reference/components/outputmessageitemstatusinprogress.mdx deleted file mode 100644 index 0039985e..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemstatusinprogress.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemStatusInProgress - Python SDK -sidebarTitle: OutputMessageItemStatusInProgress -description: OutputMessageItemStatusInProgress method reference -seoTitle: OutputMessageItemStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusInProgress | OpenRouter Python SDK -'og:description': >- - OutputMessageItemStatusInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusInProgress%20-%20Python%20SDK&description=OutputMessageItemStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemstatusunion.mdx b/client-sdks/python/api-reference/components/outputmessageitemstatusunion.mdx deleted file mode 100644 index f5387c39..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageItemStatusUnion - Python SDK -sidebarTitle: OutputMessageItemStatusUnion -description: OutputMessageItemStatusUnion method reference -seoTitle: OutputMessageItemStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusUnion | OpenRouter Python SDK -'og:description': >- - OutputMessageItemStatusUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusUnion%20-%20Python%20SDK&description=OutputMessageItemStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputMessageItemStatusCompleted` - -```python lines -value: components.OutputMessageItemStatusCompleted = /* values here */ -``` - -### `components.OutputMessageItemStatusIncomplete` - -```python lines -value: components.OutputMessageItemStatusIncomplete = /* values here */ -``` - -### `components.OutputMessageItemStatusInProgress` - -```python lines -value: components.OutputMessageItemStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessageitemtype.mdx b/client-sdks/python/api-reference/components/outputmessageitemtype.mdx deleted file mode 100644 index d8e9efd0..00000000 --- a/client-sdks/python/api-reference/components/outputmessageitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageItemType - Python SDK -sidebarTitle: OutputMessageItemType -description: OutputMessageItemType method reference -seoTitle: OutputMessageItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessageitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemType | OpenRouter Python SDK -'og:description': >- - OutputMessageItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemType%20-%20Python%20SDK&description=OutputMessageItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagephasecommentary.mdx b/client-sdks/python/api-reference/components/outputmessagephasecommentary.mdx deleted file mode 100644 index fc91c1db..00000000 --- a/client-sdks/python/api-reference/components/outputmessagephasecommentary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessagePhaseCommentary - Python SDK -sidebarTitle: OutputMessagePhaseCommentary -description: OutputMessagePhaseCommentary method reference -seoTitle: OutputMessagePhaseCommentary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseCommentary | OpenRouter Python SDK -'og:description': >- - OutputMessagePhaseCommentary method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseCommentary%20-%20Python%20SDK&description=OutputMessagePhaseCommentary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `COMMENTARY` | commentary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagephasefinalanswer.mdx b/client-sdks/python/api-reference/components/outputmessagephasefinalanswer.mdx deleted file mode 100644 index 3b83173c..00000000 --- a/client-sdks/python/api-reference/components/outputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessagePhaseFinalAnswer - Python SDK -sidebarTitle: OutputMessagePhaseFinalAnswer -description: OutputMessagePhaseFinalAnswer method reference -seoTitle: OutputMessagePhaseFinalAnswer | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseFinalAnswer | OpenRouter Python SDK -'og:description': >- - OutputMessagePhaseFinalAnswer method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseFinalAnswer%20-%20Python%20SDK&description=OutputMessagePhaseFinalAnswer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FINAL_ANSWER` | final_answer | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagephaseunion.mdx b/client-sdks/python/api-reference/components/outputmessagephaseunion.mdx deleted file mode 100644 index efba7140..00000000 --- a/client-sdks/python/api-reference/components/outputmessagephaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputMessagePhaseUnion - Python SDK -sidebarTitle: OutputMessagePhaseUnion -description: OutputMessagePhaseUnion method reference -seoTitle: OutputMessagePhaseUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseUnion | OpenRouter Python SDK -'og:description': >- - OutputMessagePhaseUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseUnion%20-%20Python%20SDK&description=OutputMessagePhaseUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `components.OutputMessagePhaseCommentary` - -```python lines -value: components.OutputMessagePhaseCommentary = /* values here */ -``` - -### `components.OutputMessagePhaseFinalAnswer` - -```python lines -value: components.OutputMessagePhaseFinalAnswer = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagerole.mdx b/client-sdks/python/api-reference/components/outputmessagerole.mdx deleted file mode 100644 index 0ada1849..00000000 --- a/client-sdks/python/api-reference/components/outputmessagerole.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageRole - Python SDK -sidebarTitle: OutputMessageRole -description: OutputMessageRole method reference -seoTitle: OutputMessageRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagerole -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageRole | OpenRouter Python SDK -'og:description': >- - OutputMessageRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageRole%20-%20Python%20SDK&description=OutputMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagestatuscompleted.mdx b/client-sdks/python/api-reference/components/outputmessagestatuscompleted.mdx deleted file mode 100644 index d0e2100f..00000000 --- a/client-sdks/python/api-reference/components/outputmessagestatuscompleted.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageStatusCompleted - Python SDK -sidebarTitle: OutputMessageStatusCompleted -description: OutputMessageStatusCompleted method reference -seoTitle: OutputMessageStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagestatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusCompleted | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusCompleted method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusCompleted%20-%20Python%20SDK&description=OutputMessageStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagestatusincomplete.mdx b/client-sdks/python/api-reference/components/outputmessagestatusincomplete.mdx deleted file mode 100644 index 3adbcfd5..00000000 --- a/client-sdks/python/api-reference/components/outputmessagestatusincomplete.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageStatusIncomplete - Python SDK -sidebarTitle: OutputMessageStatusIncomplete -description: OutputMessageStatusIncomplete method reference -seoTitle: OutputMessageStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusIncomplete method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusIncomplete%20-%20Python%20SDK&description=OutputMessageStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagestatusinprogress.mdx b/client-sdks/python/api-reference/components/outputmessagestatusinprogress.mdx deleted file mode 100644 index 67d9e1ea..00000000 --- a/client-sdks/python/api-reference/components/outputmessagestatusinprogress.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageStatusInProgress - Python SDK -sidebarTitle: OutputMessageStatusInProgress -description: OutputMessageStatusInProgress method reference -seoTitle: OutputMessageStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusInProgress | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusInProgress method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusInProgress%20-%20Python%20SDK&description=OutputMessageStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagestatusunion.mdx b/client-sdks/python/api-reference/components/outputmessagestatusunion.mdx deleted file mode 100644 index ba0f77dd..00000000 --- a/client-sdks/python/api-reference/components/outputmessagestatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageStatusUnion - Python SDK -sidebarTitle: OutputMessageStatusUnion -description: OutputMessageStatusUnion method reference -seoTitle: OutputMessageStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagestatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusUnion | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusUnion%20-%20Python%20SDK&description=OutputMessageStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputMessageStatusCompleted` - -```python lines -value: components.OutputMessageStatusCompleted = /* values here */ -``` - -### `components.OutputMessageStatusIncomplete` - -```python lines -value: components.OutputMessageStatusIncomplete = /* values here */ -``` - -### `components.OutputMessageStatusInProgress` - -```python lines -value: components.OutputMessageStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmessagetype.mdx b/client-sdks/python/api-reference/components/outputmessagetype.mdx deleted file mode 100644 index 683454a8..00000000 --- a/client-sdks/python/api-reference/components/outputmessagetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputMessageType - Python SDK -sidebarTitle: OutputMessageType -description: OutputMessageType method reference -seoTitle: OutputMessageType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmessagetype -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageType | OpenRouter Python SDK -'og:description': >- - OutputMessageType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageType%20-%20Python%20SDK&description=OutputMessageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmodality.mdx b/client-sdks/python/api-reference/components/outputmodality.mdx deleted file mode 100644 index 0c796100..00000000 --- a/client-sdks/python/api-reference/components/outputmodality.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputModality - Python SDK -sidebarTitle: OutputModality -description: OutputModality method reference -seoTitle: OutputModality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/outputmodality' -'og:site_name': OpenRouter Documentation -'og:title': OutputModality | OpenRouter Python SDK -'og:description': >- - OutputModality method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModality%20-%20Python%20SDK&description=OutputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `TEXT` | text | -| `IMAGE` | image | -| `EMBEDDINGS` | embeddings | -| `AUDIO` | audio | -| `VIDEO` | video | -| `RERANK` | rerank | -| `SPEECH` | speech | -| `TRANSCRIPTION` | transcription | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputmodalityenum.mdx b/client-sdks/python/api-reference/components/outputmodalityenum.mdx deleted file mode 100644 index 79fcf5f1..00000000 --- a/client-sdks/python/api-reference/components/outputmodalityenum.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OutputModalityEnum - Python SDK -sidebarTitle: OutputModalityEnum -description: OutputModalityEnum method reference -seoTitle: OutputModalityEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputmodalityenum -'og:site_name': OpenRouter Documentation -'og:title': OutputModalityEnum | OpenRouter Python SDK -'og:description': >- - OutputModalityEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModalityEnum%20-%20Python%20SDK&description=OutputModalityEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitem.mdx b/client-sdks/python/api-reference/components/outputreasoningitem.mdx deleted file mode 100644 index 50417050..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputReasoningItem - Python SDK -sidebarTitle: OutputReasoningItem -description: OutputReasoningItem method reference -seoTitle: OutputReasoningItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitem -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItem | OpenRouter Python SDK -'og:description': >- - OutputReasoningItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItem%20-%20Python%20SDK&description=OutputReasoningItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](/client-sdks/python/api-reference/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.OutputReasoningItemStatusUnion]](../components/outputreasoningitemstatusunion.md) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext)] | :heavy_check_mark: | N/A | | -| `type` | [components.OutputReasoningItemType](/client-sdks/python/api-reference/components/outputreasoningitemtype) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitemstatuscompleted.mdx b/client-sdks/python/api-reference/components/outputreasoningitemstatuscompleted.mdx deleted file mode 100644 index 14fb272e..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputReasoningItemStatusCompleted - Python SDK -sidebarTitle: OutputReasoningItemStatusCompleted -description: OutputReasoningItemStatusCompleted method reference -seoTitle: OutputReasoningItemStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusCompleted | OpenRouter Python SDK -'og:description': >- - OutputReasoningItemStatusCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusCompleted%20-%20Python%20SDK&description=OutputReasoningItemStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitemstatusincomplete.mdx b/client-sdks/python/api-reference/components/outputreasoningitemstatusincomplete.mdx deleted file mode 100644 index e439216f..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputReasoningItemStatusIncomplete - Python SDK -sidebarTitle: OutputReasoningItemStatusIncomplete -description: OutputReasoningItemStatusIncomplete method reference -seoTitle: OutputReasoningItemStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OutputReasoningItemStatusIncomplete method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusIncomplete%20-%20Python%20SDK&description=OutputReasoningItemStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitemstatusinprogress.mdx b/client-sdks/python/api-reference/components/outputreasoningitemstatusinprogress.mdx deleted file mode 100644 index 059e4c8e..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputReasoningItemStatusInProgress - Python SDK -sidebarTitle: OutputReasoningItemStatusInProgress -description: OutputReasoningItemStatusInProgress method reference -seoTitle: OutputReasoningItemStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusInProgress | OpenRouter Python SDK -'og:description': >- - OutputReasoningItemStatusInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusInProgress%20-%20Python%20SDK&description=OutputReasoningItemStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitemstatusunion.mdx b/client-sdks/python/api-reference/components/outputreasoningitemstatusunion.mdx deleted file mode 100644 index fcfb1ef2..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputReasoningItemStatusUnion - Python SDK -sidebarTitle: OutputReasoningItemStatusUnion -description: OutputReasoningItemStatusUnion method reference -seoTitle: OutputReasoningItemStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusUnion | OpenRouter Python SDK -'og:description': >- - OutputReasoningItemStatusUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusUnion%20-%20Python%20SDK&description=OutputReasoningItemStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputReasoningItemStatusCompleted` - -```python lines -value: components.OutputReasoningItemStatusCompleted = /* values here */ -``` - -### `components.OutputReasoningItemStatusIncomplete` - -```python lines -value: components.OutputReasoningItemStatusIncomplete = /* values here */ -``` - -### `components.OutputReasoningItemStatusInProgress` - -```python lines -value: components.OutputReasoningItemStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputreasoningitemtype.mdx b/client-sdks/python/api-reference/components/outputreasoningitemtype.mdx deleted file mode 100644 index 2b75617b..00000000 --- a/client-sdks/python/api-reference/components/outputreasoningitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputReasoningItemType - Python SDK -sidebarTitle: OutputReasoningItemType -description: OutputReasoningItemType method reference -seoTitle: OutputReasoningItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputreasoningitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemType | OpenRouter Python SDK -'og:description': >- - OutputReasoningItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemType%20-%20Python%20SDK&description=OutputReasoningItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `REASONING` | reasoning | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitem.mdx b/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitem.mdx deleted file mode 100644 index 8152561c..00000000 --- a/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputSearchModelsServerToolItem - Python SDK -sidebarTitle: OutputSearchModelsServerToolItem -description: OutputSearchModelsServerToolItem method reference -seoTitle: OutputSearchModelsServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputsearchmodelsservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputSearchModelsServerToolItem method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItem%20-%20Python%20SDK&description=OutputSearchModelsServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:experimental__search_models server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `arguments` | *Optional[str]* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. `{"query":"Claude"}`) | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputSearchModelsServerToolItemType](/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitemtype.mdx deleted file mode 100644 index f6253fdf..00000000 --- a/client-sdks/python/api-reference/components/outputsearchmodelsservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputSearchModelsServerToolItemType - Python SDK -sidebarTitle: OutputSearchModelsServerToolItemType -description: OutputSearchModelsServerToolItemType method reference -seoTitle: OutputSearchModelsServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputsearchmodelsservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputSearchModelsServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItemType%20-%20Python%20SDK&description=OutputSearchModelsServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `OPENROUTER_EXPERIMENTAL_SEARCH_MODELS` | openrouter:experimental__search_models | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputtexteditorservertoolitem.mdx b/client-sdks/python/api-reference/components/outputtexteditorservertoolitem.mdx deleted file mode 100644 index 102ee1ec..00000000 --- a/client-sdks/python/api-reference/components/outputtexteditorservertoolitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputTextEditorServerToolItem - Python SDK -sidebarTitle: OutputTextEditorServerToolItem -description: OutputTextEditorServerToolItem method reference -seoTitle: OutputTextEditorServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputtexteditorservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputTextEditorServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItem%20-%20Python%20SDK&description=OutputTextEditorServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:text_editor server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `command` | [Optional[components.Command]](../components/command.md) | :heavy_minus_sign: | N/A | | -| `file_path` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputTextEditorServerToolItemType](/client-sdks/python/api-reference/components/outputtexteditorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputtexteditorservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputtexteditorservertoolitemtype.mdx deleted file mode 100644 index ec1d7b87..00000000 --- a/client-sdks/python/api-reference/components/outputtexteditorservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputTextEditorServerToolItemType - Python SDK -sidebarTitle: OutputTextEditorServerToolItemType -description: OutputTextEditorServerToolItemType method reference -seoTitle: OutputTextEditorServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputtexteditorservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputTextEditorServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItemType%20-%20Python%20SDK&description=OutputTextEditorServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_TEXT_EDITOR` | openrouter:text_editor | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputtokensdetails.mdx b/client-sdks/python/api-reference/components/outputtokensdetails.mdx deleted file mode 100644 index d8861960..00000000 --- a/client-sdks/python/api-reference/components/outputtokensdetails.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputTokensDetails - Python SDK -sidebarTitle: OutputTokensDetails -description: OutputTokensDetails method reference -seoTitle: OutputTokensDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputtokensdetails -'og:site_name': OpenRouter Documentation -'og:title': OutputTokensDetails | OpenRouter Python SDK -'og:description': >- - OutputTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTokensDetails%20-%20Python%20SDK&description=OutputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoning_tokens` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputtoolsearchservertoolitem.mdx b/client-sdks/python/api-reference/components/outputtoolsearchservertoolitem.mdx deleted file mode 100644 index a2076605..00000000 --- a/client-sdks/python/api-reference/components/outputtoolsearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputToolSearchServerToolItem - Python SDK -sidebarTitle: OutputToolSearchServerToolItem -description: OutputToolSearchServerToolItem method reference -seoTitle: OutputToolSearchServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputtoolsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputToolSearchServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItem%20-%20Python%20SDK&description=OutputToolSearchServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:tool_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `query` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputToolSearchServerToolItemType](/client-sdks/python/api-reference/components/outputtoolsearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputtoolsearchservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputtoolsearchservertoolitemtype.mdx deleted file mode 100644 index 9003dd64..00000000 --- a/client-sdks/python/api-reference/components/outputtoolsearchservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputToolSearchServerToolItemType - Python SDK -sidebarTitle: OutputToolSearchServerToolItemType -description: OutputToolSearchServerToolItemType method reference -seoTitle: OutputToolSearchServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputtoolsearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputToolSearchServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItemType%20-%20Python%20SDK&description=OutputToolSearchServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `OPENROUTER_TOOL_SEARCH` | openrouter:tool_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebfetchservertoolitem.mdx b/client-sdks/python/api-reference/components/outputwebfetchservertoolitem.mdx deleted file mode 100644 index 30f321ce..00000000 --- a/client-sdks/python/api-reference/components/outputwebfetchservertoolitem.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputWebFetchServerToolItem - Python SDK -sidebarTitle: OutputWebFetchServerToolItem -description: OutputWebFetchServerToolItem method reference -seoTitle: OutputWebFetchServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebfetchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputWebFetchServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItem%20-%20Python%20SDK&description=OutputWebFetchServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:web_fetch server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `content` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `error` | *Optional[str]* | :heavy_minus_sign: | The error message if the fetch failed. | | -| `http_status` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `title` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.OutputWebFetchServerToolItemType](/client-sdks/python/api-reference/components/outputwebfetchservertoolitemtype) | :heavy_check_mark: | N/A | | -| `url` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebfetchservertoolitemtype.mdx b/client-sdks/python/api-reference/components/outputwebfetchservertoolitemtype.mdx deleted file mode 100644 index 1a56c3f6..00000000 --- a/client-sdks/python/api-reference/components/outputwebfetchservertoolitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputWebFetchServerToolItemType - Python SDK -sidebarTitle: OutputWebFetchServerToolItemType -description: OutputWebFetchServerToolItemType method reference -seoTitle: OutputWebFetchServerToolItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebfetchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItemType | OpenRouter Python SDK -'og:description': >- - OutputWebFetchServerToolItemType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItemType%20-%20Python%20SDK&description=OutputWebFetchServerToolItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `OPENROUTER_WEB_FETCH` | openrouter:web_fetch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchcallitem.mdx b/client-sdks/python/api-reference/components/outputwebsearchcallitem.mdx deleted file mode 100644 index 76120e31..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchcallitem.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputWebSearchCallItem - Python SDK -sidebarTitle: OutputWebSearchCallItem -description: OutputWebSearchCallItem method reference -seoTitle: OutputWebSearchCallItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItem | OpenRouter Python SDK -'og:description': >- - OutputWebSearchCallItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItem%20-%20Python%20SDK&description=OutputWebSearchCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `action` | [components.Action](/client-sdks/python/api-reference/components/action) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](/client-sdks/python/api-reference/components/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.TypeWebSearchCall](/client-sdks/python/api-reference/components/typewebsearchcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchcallitemactionsearch.mdx b/client-sdks/python/api-reference/components/outputwebsearchcallitemactionsearch.mdx deleted file mode 100644 index e2f251ae..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchcallitemactionsearch.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OutputWebSearchCallItemActionSearch - Python SDK -sidebarTitle: OutputWebSearchCallItemActionSearch -description: OutputWebSearchCallItemActionSearch method reference -seoTitle: OutputWebSearchCallItemActionSearch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchcallitemactionsearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItemActionSearch | OpenRouter Python SDK -'og:description': >- - OutputWebSearchCallItemActionSearch method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItemActionSearch%20-%20Python%20SDK&description=OutputWebSearchCallItemActionSearch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `queries` | List[*str*] | :heavy_minus_sign: | N/A | -| `query` | *str* | :heavy_check_mark: | N/A | -| `sources` | List[[components.WebSearchSource](/client-sdks/python/api-reference/components/websearchsource)] | :heavy_minus_sign: | N/A | -| `type` | [components.ActionTypeSearch](/client-sdks/python/api-reference/components/actiontypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitem.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitem.mdx deleted file mode 100644 index 5048be6e..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitem.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OutputWebSearchServerToolItem - Python SDK -sidebarTitle: OutputWebSearchServerToolItem -description: OutputWebSearchServerToolItem method reference -seoTitle: OutputWebSearchServerToolItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItem | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItem%20-%20Python%20SDK&description=OutputWebSearchServerToolItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An openrouter:web_search server tool output item - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [Optional[components.OutputWebSearchServerToolItemAction]](../components/outputwebsearchservertoolitemaction.md) | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ToolCallStatus](/client-sdks/python/api-reference/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeopenrouterwebsearch) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemaction.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitemaction.mdx deleted file mode 100644 index 491da274..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemaction.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OutputWebSearchServerToolItemAction - Python SDK -sidebarTitle: OutputWebSearchServerToolItemAction -description: OutputWebSearchServerToolItemAction method reference -seoTitle: OutputWebSearchServerToolItemAction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitemaction -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemAction | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItemAction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemAction%20-%20Python%20SDK&description=OutputWebSearchServerToolItemAction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `query` | *str* | :heavy_check_mark: | N/A | -| `sources` | List[[components.OutputWebSearchServerToolItemSource](/client-sdks/python/api-reference/components/outputwebsearchservertoolitemsource)] | :heavy_minus_sign: | N/A | -| `type` | [components.OutputWebSearchServerToolItemTypeSearch](/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemsource.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitemsource.mdx deleted file mode 100644 index 0be0b252..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemsource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OutputWebSearchServerToolItemSource - Python SDK -sidebarTitle: OutputWebSearchServerToolItemSource -description: OutputWebSearchServerToolItemSource method reference -seoTitle: OutputWebSearchServerToolItemSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitemsource -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemSource | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItemSource method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemSource%20-%20Python%20SDK&description=OutputWebSearchServerToolItemSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.OutputWebSearchServerToolItemTypeURL](/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeurl) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx deleted file mode 100644 index e1f3e32c..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeOpenrouterWebSearch - Python SDK -sidebarTitle: OutputWebSearchServerToolItemTypeOpenrouterWebSearch -description: OutputWebSearchServerToolItemTypeOpenrouterWebSearch method reference -seoTitle: OutputWebSearchServerToolItemTypeOpenrouterWebSearch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitemtypeopenrouterwebsearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeOpenrouterWebSearch | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItemTypeOpenrouterWebSearch method documentation for - the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20-%20Python%20SDK&description=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `OPENROUTER_WEB_SEARCH` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypesearch.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypesearch.mdx deleted file mode 100644 index 580586c7..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypesearch.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeSearch - Python SDK -sidebarTitle: OutputWebSearchServerToolItemTypeSearch -description: OutputWebSearchServerToolItemTypeSearch method reference -seoTitle: OutputWebSearchServerToolItemTypeSearch | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitemtypesearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeSearch | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItemTypeSearch method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeSearch%20-%20Python%20SDK&description=OutputWebSearchServerToolItemTypeSearch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SEARCH` | search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeurl.mdx b/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeurl.mdx deleted file mode 100644 index 47d3c662..00000000 --- a/client-sdks/python/api-reference/components/outputwebsearchservertoolitemtypeurl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeURL - Python SDK -sidebarTitle: OutputWebSearchServerToolItemTypeURL -description: OutputWebSearchServerToolItemTypeURL method reference -seoTitle: OutputWebSearchServerToolItemTypeURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/outputwebsearchservertoolitemtypeurl -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeURL | OpenRouter Python SDK -'og:description': >- - OutputWebSearchServerToolItemTypeURL method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeURL%20-%20Python%20SDK&description=OutputWebSearchServerToolItemTypeURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `URL` | url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/parameter.mdx b/client-sdks/python/api-reference/components/parameter.mdx deleted file mode 100644 index f087d21d..00000000 --- a/client-sdks/python/api-reference/components/parameter.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Parameter - Python SDK -sidebarTitle: Parameter -description: Parameter method reference -seoTitle: Parameter | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/parameter' -'og:site_name': OpenRouter Documentation -'og:title': Parameter | OpenRouter Python SDK -'og:description': >- - Parameter method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Parameter%20-%20Python%20SDK&description=Parameter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `TEMPERATURE` | temperature | -| `TOP_P` | top_p | -| `TOP_K` | top_k | -| `MIN_P` | min_p | -| `TOP_A` | top_a | -| `FREQUENCY_PENALTY` | frequency_penalty | -| `PRESENCE_PENALTY` | presence_penalty | -| `REPETITION_PENALTY` | repetition_penalty | -| `MAX_TOKENS` | max_tokens | -| `MAX_COMPLETION_TOKENS` | max_completion_tokens | -| `LOGIT_BIAS` | logit_bias | -| `LOGPROBS` | logprobs | -| `TOP_LOGPROBS` | top_logprobs | -| `SEED` | seed | -| `RESPONSE_FORMAT` | response_format | -| `STRUCTURED_OUTPUTS` | structured_outputs | -| `STOP` | stop | -| `TOOLS` | tools | -| `TOOL_CHOICE` | tool_choice | -| `PARALLEL_TOOL_CALLS` | parallel_tool_calls | -| `INCLUDE_REASONING` | include_reasoning | -| `REASONING` | reasoning | -| `REASONING_EFFORT` | reasoning_effort | -| `WEB_SEARCH_OPTIONS` | web_search_options | -| `VERBOSITY` | verbosity | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/paretorouterplugin.mdx b/client-sdks/python/api-reference/components/paretorouterplugin.mdx deleted file mode 100644 index 5a209619..00000000 --- a/client-sdks/python/api-reference/components/paretorouterplugin.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ParetoRouterPlugin - Python SDK -sidebarTitle: ParetoRouterPlugin -description: ParetoRouterPlugin method reference -seoTitle: ParetoRouterPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/paretorouterplugin -'og:site_name': OpenRouter Documentation -'og:title': ParetoRouterPlugin | OpenRouter Python SDK -'og:description': >- - ParetoRouterPlugin method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ParetoRouterPlugin%20-%20Python%20SDK&description=ParetoRouterPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `id` | [components.ParetoRouterPluginID](/client-sdks/python/api-reference/components/paretorouterpluginid) | :heavy_check_mark: | N/A | | -| `min_coding_score` | *Optional[float]* | :heavy_minus_sign: | Minimum desired coding score between 0 and 1, where 1 is best. Higher values select from stronger coding models (sourced from Artificial Analysis coding percentiles). Maps internally to one of three tiers (low, medium, high). Omit to use the router default tier. | 0.8 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/paretorouterpluginid.mdx b/client-sdks/python/api-reference/components/paretorouterpluginid.mdx deleted file mode 100644 index f9acb78c..00000000 --- a/client-sdks/python/api-reference/components/paretorouterpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ParetoRouterPluginID - Python SDK -sidebarTitle: ParetoRouterPluginID -description: ParetoRouterPluginID method reference -seoTitle: ParetoRouterPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/paretorouterpluginid -'og:site_name': OpenRouter Documentation -'og:title': ParetoRouterPluginID | OpenRouter Python SDK -'og:description': >- - ParetoRouterPluginID method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ParetoRouterPluginID%20-%20Python%20SDK&description=ParetoRouterPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `PARETO_ROUTER` | pareto-router | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/partialcoverage.mdx b/client-sdks/python/api-reference/components/partialcoverage.mdx deleted file mode 100644 index 2d48659a..00000000 --- a/client-sdks/python/api-reference/components/partialcoverage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PartialCoverage - Python SDK -sidebarTitle: PartialCoverage -description: PartialCoverage method reference -seoTitle: PartialCoverage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/partialcoverage -'og:site_name': OpenRouter Documentation -'og:title': PartialCoverage | OpenRouter Python SDK -'og:description': >- - PartialCoverage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PartialCoverage%20-%20Python%20SDK&description=PartialCoverage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `models` | List[*str*] | :heavy_check_mark: | N/A | -| `point` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/partition.mdx b/client-sdks/python/api-reference/components/partition.mdx deleted file mode 100644 index 412e3aa6..00000000 --- a/client-sdks/python/api-reference/components/partition.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Partition - Python SDK -sidebarTitle: Partition -description: Partition method reference -seoTitle: Partition | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/partition' -'og:site_name': OpenRouter Documentation -'og:title': Partition | OpenRouter Python SDK -'og:description': >- - Partition method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Partition%20-%20Python%20SDK&description=Partition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. - -## Values - -| Name | Value | -| ------- | ------- | -| `MODEL` | model | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/payloadtoolargeresponseerrordata.mdx b/client-sdks/python/api-reference/components/payloadtoolargeresponseerrordata.mdx deleted file mode 100644 index 9065308f..00000000 --- a/client-sdks/python/api-reference/components/payloadtoolargeresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PayloadTooLargeResponseErrorData - Python SDK -sidebarTitle: PayloadTooLargeResponseErrorData -description: PayloadTooLargeResponseErrorData method reference -seoTitle: PayloadTooLargeResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/payloadtoolargeresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseErrorData | OpenRouter Python SDK -'og:description': >- - PayloadTooLargeResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseErrorData%20-%20Python%20SDK&description=PayloadTooLargeResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for PayloadTooLargeResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/paymentrequiredresponseerrordata.mdx b/client-sdks/python/api-reference/components/paymentrequiredresponseerrordata.mdx deleted file mode 100644 index b77e9d0d..00000000 --- a/client-sdks/python/api-reference/components/paymentrequiredresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PaymentRequiredResponseErrorData - Python SDK -sidebarTitle: PaymentRequiredResponseErrorData -description: PaymentRequiredResponseErrorData method reference -seoTitle: PaymentRequiredResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/paymentrequiredresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseErrorData | OpenRouter Python SDK -'og:description': >- - PaymentRequiredResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseErrorData%20-%20Python%20SDK&description=PaymentRequiredResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for PaymentRequiredResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pdfparserengine.mdx b/client-sdks/python/api-reference/components/pdfparserengine.mdx deleted file mode 100644 index 8f4bb3bc..00000000 --- a/client-sdks/python/api-reference/components/pdfparserengine.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PDFParserEngine - Python SDK -sidebarTitle: PDFParserEngine -description: PDFParserEngine method reference -seoTitle: PDFParserEngine | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pdfparserengine -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngine | OpenRouter Python SDK -'og:description': >- - PDFParserEngine method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngine%20-%20Python%20SDK&description=PDFParserEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". - -## Supported Types - -### `components.PDFParserEngineEnum` - -```python lines -value: components.PDFParserEngineEnum = /* values here */ -``` - -### `components.PDFParserEnginePDFText` - -```python lines -value: components.PDFParserEnginePDFText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pdfparserengineenum.mdx b/client-sdks/python/api-reference/components/pdfparserengineenum.mdx deleted file mode 100644 index 5d2d8bd2..00000000 --- a/client-sdks/python/api-reference/components/pdfparserengineenum.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PDFParserEngineEnum - Python SDK -sidebarTitle: PDFParserEngineEnum -description: PDFParserEngineEnum method reference -seoTitle: PDFParserEngineEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pdfparserengineenum -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngineEnum | OpenRouter Python SDK -'og:description': >- - PDFParserEngineEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngineEnum%20-%20Python%20SDK&description=PDFParserEngineEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `MISTRAL_OCR` | mistral-ocr | -| `NATIVE` | native | -| `CLOUDFLARE_AI` | cloudflare-ai | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pdfparserenginepdftext.mdx b/client-sdks/python/api-reference/components/pdfparserenginepdftext.mdx deleted file mode 100644 index d6ec0c5a..00000000 --- a/client-sdks/python/api-reference/components/pdfparserenginepdftext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PDFParserEnginePDFText - Python SDK -sidebarTitle: PDFParserEnginePDFText -description: PDFParserEnginePDFText method reference -seoTitle: PDFParserEnginePDFText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pdfparserenginepdftext -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEnginePDFText | OpenRouter Python SDK -'og:description': >- - PDFParserEnginePDFText method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEnginePDFText%20-%20Python%20SDK&description=PDFParserEnginePDFText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `PDF_TEXT` | pdf-text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pdfparseroptions.mdx b/client-sdks/python/api-reference/components/pdfparseroptions.mdx deleted file mode 100644 index d7b03d19..00000000 --- a/client-sdks/python/api-reference/components/pdfparseroptions.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PDFParserOptions - Python SDK -sidebarTitle: PDFParserOptions -description: PDFParserOptions method reference -seoTitle: PDFParserOptions | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pdfparseroptions -'og:site_name': OpenRouter Documentation -'og:title': PDFParserOptions | OpenRouter Python SDK -'og:description': >- - PDFParserOptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserOptions%20-%20Python%20SDK&description=PDFParserOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Options for PDF parsing. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `engine` | [Optional[components.PDFParserEngine]](../components/pdfparserengine.md) | :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/client-sdks/python/api-reference/components/pendingsafetycheck.mdx b/client-sdks/python/api-reference/components/pendingsafetycheck.mdx deleted file mode 100644 index fee46857..00000000 --- a/client-sdks/python/api-reference/components/pendingsafetycheck.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PendingSafetyCheck - Python SDK -sidebarTitle: PendingSafetyCheck -description: PendingSafetyCheck method reference -seoTitle: PendingSafetyCheck | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pendingsafetycheck -'og:site_name': OpenRouter Documentation -'og:title': PendingSafetyCheck | OpenRouter Python SDK -'og:description': >- - PendingSafetyCheck method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PendingSafetyCheck%20-%20Python%20SDK&description=PendingSafetyCheck%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/percentilelatencycutoffs.mdx b/client-sdks/python/api-reference/components/percentilelatencycutoffs.mdx deleted file mode 100644 index ca7edbb2..00000000 --- a/client-sdks/python/api-reference/components/percentilelatencycutoffs.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PercentileLatencyCutoffs - Python SDK -sidebarTitle: PercentileLatencyCutoffs -description: PercentileLatencyCutoffs method reference -seoTitle: PercentileLatencyCutoffs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/percentilelatencycutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileLatencyCutoffs | OpenRouter Python SDK -'og:description': >- - PercentileLatencyCutoffs method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileLatencyCutoffs%20-%20Python%20SDK&description=PercentileLatencyCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Percentile-based latency cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/percentilestats.mdx b/client-sdks/python/api-reference/components/percentilestats.mdx deleted file mode 100644 index 4e54d0a1..00000000 --- a/client-sdks/python/api-reference/components/percentilestats.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PercentileStats - Python SDK -sidebarTitle: PercentileStats -description: PercentileStats method reference -seoTitle: PercentileStats | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/percentilestats -'og:site_name': OpenRouter Documentation -'og:title': PercentileStats | OpenRouter Python SDK -'og:description': >- - PercentileStats method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileStats%20-%20Python%20SDK&description=PercentileStats%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `p50` | *float* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *float* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *float* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *float* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/percentilethroughputcutoffs.mdx b/client-sdks/python/api-reference/components/percentilethroughputcutoffs.mdx deleted file mode 100644 index bae31169..00000000 --- a/client-sdks/python/api-reference/components/percentilethroughputcutoffs.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PercentileThroughputCutoffs - Python SDK -sidebarTitle: PercentileThroughputCutoffs -description: PercentileThroughputCutoffs method reference -seoTitle: PercentileThroughputCutoffs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/percentilethroughputcutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileThroughputCutoffs | OpenRouter Python SDK -'og:description': >- - PercentileThroughputCutoffs method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileThroughputCutoffs%20-%20Python%20SDK&description=PercentileThroughputCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Percentile-based throughput cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/perrequestlimits.mdx b/client-sdks/python/api-reference/components/perrequestlimits.mdx deleted file mode 100644 index 21e2772d..00000000 --- a/client-sdks/python/api-reference/components/perrequestlimits.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PerRequestLimits - Python SDK -sidebarTitle: PerRequestLimits -description: PerRequestLimits method reference -seoTitle: PerRequestLimits | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/perrequestlimits -'og:site_name': OpenRouter Documentation -'og:title': PerRequestLimits | OpenRouter Python SDK -'og:description': >- - PerRequestLimits method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PerRequestLimits%20-%20Python%20SDK&description=PerRequestLimits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Per-request token limits - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `completion_tokens` | *float* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `prompt_tokens` | *float* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pipelinestage.mdx b/client-sdks/python/api-reference/components/pipelinestage.mdx deleted file mode 100644 index bade35c8..00000000 --- a/client-sdks/python/api-reference/components/pipelinestage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PipelineStage - Python SDK -sidebarTitle: PipelineStage -description: PipelineStage method reference -seoTitle: PipelineStage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/pipelinestage' -'og:site_name': OpenRouter Documentation -'og:title': PipelineStage | OpenRouter Python SDK -'og:description': >- - PipelineStage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStage%20-%20Python%20SDK&description=PipelineStage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cost_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `data` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `guardrail_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `guardrail_scope` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.PipelineStageType](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/pipelinestagetype.mdx b/client-sdks/python/api-reference/components/pipelinestagetype.mdx deleted file mode 100644 index 1138cd9e..00000000 --- a/client-sdks/python/api-reference/components/pipelinestagetype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: PipelineStageType - Python SDK -sidebarTitle: PipelineStageType -description: PipelineStageType method reference -seoTitle: PipelineStageType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/pipelinestagetype -'og:site_name': OpenRouter Documentation -'og:title': PipelineStageType | OpenRouter Python SDK -'og:description': >- - PipelineStageType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStageType%20-%20Python%20SDK&description=PipelineStageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `GUARDRAIL` | guardrail | -| `PLUGIN` | plugin | -| `SERVER_TOOLS` | server_tools | -| `RESPONSE_HEALING` | response_healing | -| `CONTEXT_COMPRESSION` | context_compression | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/preferredmaxlatency.mdx b/client-sdks/python/api-reference/components/preferredmaxlatency.mdx deleted file mode 100644 index 51374bdd..00000000 --- a/client-sdks/python/api-reference/components/preferredmaxlatency.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PreferredMaxLatency - Python SDK -sidebarTitle: PreferredMaxLatency -description: PreferredMaxLatency method reference -seoTitle: PreferredMaxLatency | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/preferredmaxlatency -'og:site_name': OpenRouter Documentation -'og:title': PreferredMaxLatency | OpenRouter Python SDK -'og:description': >- - PreferredMaxLatency method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMaxLatency%20-%20Python%20SDK&description=PreferredMaxLatency%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.PercentileLatencyCutoffs` - -```python lines -value: components.PercentileLatencyCutoffs = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/preferredminthroughput.mdx b/client-sdks/python/api-reference/components/preferredminthroughput.mdx deleted file mode 100644 index 722012e0..00000000 --- a/client-sdks/python/api-reference/components/preferredminthroughput.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PreferredMinThroughput - Python SDK -sidebarTitle: PreferredMinThroughput -description: PreferredMinThroughput method reference -seoTitle: PreferredMinThroughput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/preferredminthroughput -'og:site_name': OpenRouter Documentation -'og:title': PreferredMinThroughput | OpenRouter Python SDK -'og:description': >- - PreferredMinThroughput method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMinThroughput%20-%20Python%20SDK&description=PreferredMinThroughput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.PercentileThroughputCutoffs` - -```python lines -value: components.PercentileThroughputCutoffs = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/presetdesignatedversion.mdx b/client-sdks/python/api-reference/components/presetdesignatedversion.mdx deleted file mode 100644 index a34340c3..00000000 --- a/client-sdks/python/api-reference/components/presetdesignatedversion.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PresetDesignatedVersion - Python SDK -sidebarTitle: PresetDesignatedVersion -description: PresetDesignatedVersion method reference -seoTitle: PresetDesignatedVersion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/presetdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetDesignatedVersion | OpenRouter Python SDK -'og:description': >- - PresetDesignatedVersion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetDesignatedVersion%20-%20Python%20SDK&description=PresetDesignatedVersion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A specific version of a preset, containing config and optional system prompt. - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `config` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `creator_id` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `preset_id` | *str* | :heavy_check_mark: | N/A | -| `system_prompt` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `updated_at` | *str* | :heavy_check_mark: | N/A | -| `version` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/presetwithdesignatedversion.mdx b/client-sdks/python/api-reference/components/presetwithdesignatedversion.mdx deleted file mode 100644 index 378f8112..00000000 --- a/client-sdks/python/api-reference/components/presetwithdesignatedversion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PresetWithDesignatedVersion - Python SDK -sidebarTitle: PresetWithDesignatedVersion -description: PresetWithDesignatedVersion method reference -seoTitle: PresetWithDesignatedVersion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/presetwithdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersion | OpenRouter Python SDK -'og:description': >- - PresetWithDesignatedVersion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersion%20-%20Python%20SDK&description=PresetWithDesignatedVersion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A preset with its currently designated version. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | N/A | | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `description` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `designated_version` | [Nullable[components.PresetDesignatedVersion]](../components/presetdesignatedversion.md) | :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
`\} | -| `designated_version_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `slug` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.PresetWithDesignatedVersionStatus](/client-sdks/python/api-reference/components/presetwithdesignatedversionstatus) | :heavy_check_mark: | N/A | | -| `status_updated_at` | *Nullable[str]* | :heavy_check_mark: | N/A | | -| `updated_at` | *str* | :heavy_check_mark: | N/A | | -| `workspace_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/presetwithdesignatedversionstatus.mdx b/client-sdks/python/api-reference/components/presetwithdesignatedversionstatus.mdx deleted file mode 100644 index 3fc931e2..00000000 --- a/client-sdks/python/api-reference/components/presetwithdesignatedversionstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PresetWithDesignatedVersionStatus - Python SDK -sidebarTitle: PresetWithDesignatedVersionStatus -description: PresetWithDesignatedVersionStatus method reference -seoTitle: PresetWithDesignatedVersionStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/presetwithdesignatedversionstatus -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersionStatus | OpenRouter Python SDK -'og:description': >- - PresetWithDesignatedVersionStatus method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersionStatus%20-%20Python%20SDK&description=PresetWithDesignatedVersionStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ACTIVE` | active | -| `DISABLED` | disabled | -| `ARCHIVED` | archived | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/preview20250311websearchservertool.mdx b/client-sdks/python/api-reference/components/preview20250311websearchservertool.mdx deleted file mode 100644 index 34848eab..00000000 --- a/client-sdks/python/api-reference/components/preview20250311websearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Preview20250311WebSearchServerTool - Python SDK -sidebarTitle: Preview20250311WebSearchServerTool -description: Preview20250311WebSearchServerTool method reference -seoTitle: Preview20250311WebSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/preview20250311websearchservertool -'og:site_name': OpenRouter Documentation -'og:title': Preview20250311WebSearchServerTool | OpenRouter Python SDK -'og:description': >- - Preview20250311WebSearchServerTool method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Preview20250311WebSearchServerTool%20-%20Python%20SDK&description=Preview20250311WebSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration (2025-03-11 version) - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `filters` | [OptionalNullable[components.WebSearchDomainFilter]](../components/websearchdomainfilter.md) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.Preview20250311WebSearchServerToolType](/client-sdks/python/api-reference/components/preview20250311websearchservertooltype) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.md) | :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/client-sdks/python/api-reference/components/preview20250311websearchservertooltype.mdx b/client-sdks/python/api-reference/components/preview20250311websearchservertooltype.mdx deleted file mode 100644 index ec36e23f..00000000 --- a/client-sdks/python/api-reference/components/preview20250311websearchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Preview20250311WebSearchServerToolType - Python SDK -sidebarTitle: Preview20250311WebSearchServerToolType -description: Preview20250311WebSearchServerToolType method reference -seoTitle: Preview20250311WebSearchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/preview20250311websearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': Preview20250311WebSearchServerToolType | OpenRouter Python SDK -'og:description': >- - Preview20250311WebSearchServerToolType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Preview20250311WebSearchServerToolType%20-%20Python%20SDK&description=Preview20250311WebSearchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `WEB_SEARCH_PREVIEW_2025_03_11` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/previewwebsearchservertool.mdx b/client-sdks/python/api-reference/components/previewwebsearchservertool.mdx deleted file mode 100644 index 728ac639..00000000 --- a/client-sdks/python/api-reference/components/previewwebsearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: PreviewWebSearchServerTool - Python SDK -sidebarTitle: PreviewWebSearchServerTool -description: PreviewWebSearchServerTool method reference -seoTitle: PreviewWebSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/previewwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchServerTool | OpenRouter Python SDK -'og:description': >- - PreviewWebSearchServerTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchServerTool%20-%20Python%20SDK&description=PreviewWebSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `filters` | [OptionalNullable[components.WebSearchDomainFilter]](../components/websearchdomainfilter.md) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.PreviewWebSearchServerToolType](/client-sdks/python/api-reference/components/previewwebsearchservertooltype) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.PreviewWebSearchUserLocation]](../components/previewwebsearchuserlocation.md) | :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/client-sdks/python/api-reference/components/previewwebsearchservertooltype.mdx b/client-sdks/python/api-reference/components/previewwebsearchservertooltype.mdx deleted file mode 100644 index a40f9a9a..00000000 --- a/client-sdks/python/api-reference/components/previewwebsearchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PreviewWebSearchServerToolType - Python SDK -sidebarTitle: PreviewWebSearchServerToolType -description: PreviewWebSearchServerToolType method reference -seoTitle: PreviewWebSearchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/previewwebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchServerToolType | OpenRouter Python SDK -'og:description': >- - PreviewWebSearchServerToolType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchServerToolType%20-%20Python%20SDK&description=PreviewWebSearchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `WEB_SEARCH_PREVIEW` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/previewwebsearchuserlocation.mdx b/client-sdks/python/api-reference/components/previewwebsearchuserlocation.mdx deleted file mode 100644 index f19b3be6..00000000 --- a/client-sdks/python/api-reference/components/previewwebsearchuserlocation.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PreviewWebSearchUserLocation - Python SDK -sidebarTitle: PreviewWebSearchUserLocation -description: PreviewWebSearchUserLocation method reference -seoTitle: PreviewWebSearchUserLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/previewwebsearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocation | OpenRouter Python SDK -'og:description': >- - PreviewWebSearchUserLocation method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocation%20-%20Python%20SDK&description=PreviewWebSearchUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.PreviewWebSearchUserLocationType](/client-sdks/python/api-reference/components/previewwebsearchuserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/previewwebsearchuserlocationtype.mdx b/client-sdks/python/api-reference/components/previewwebsearchuserlocationtype.mdx deleted file mode 100644 index 01bf10a2..00000000 --- a/client-sdks/python/api-reference/components/previewwebsearchuserlocationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PreviewWebSearchUserLocationType - Python SDK -sidebarTitle: PreviewWebSearchUserLocationType -description: PreviewWebSearchUserLocationType method reference -seoTitle: PreviewWebSearchUserLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/previewwebsearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocationType | OpenRouter Python SDK -'og:description': >- - PreviewWebSearchUserLocationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocationType%20-%20Python%20SDK&description=PreviewWebSearchUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/pricing.mdx b/client-sdks/python/api-reference/components/pricing.mdx deleted file mode 100644 index 25283ae3..00000000 --- a/client-sdks/python/api-reference/components/pricing.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Pricing - Python SDK -sidebarTitle: Pricing -description: Pricing method reference -seoTitle: Pricing | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/pricing' -'og:site_name': OpenRouter Documentation -'og:title': Pricing | OpenRouter Python SDK -'og:description': >- - Pricing method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pricing%20-%20Python%20SDK&description=Pricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `audio_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *str* | :heavy_check_mark: | N/A | 1000 | -| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *str* | :heavy_check_mark: | N/A | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/prompttokensdetails.mdx b/client-sdks/python/api-reference/components/prompttokensdetails.mdx deleted file mode 100644 index 7cee21bc..00000000 --- a/client-sdks/python/api-reference/components/prompttokensdetails.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: PromptTokensDetails - Python SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails method reference -seoTitle: PromptTokensDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/prompttokensdetails -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails | OpenRouter Python SDK -'og:description': >- - PromptTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20Python%20SDK&description=PromptTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Detailed prompt token usage - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Audio input tokens | -| `cache_write_tokens` | *Optional[int]* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cached_tokens` | *Optional[int]* | :heavy_minus_sign: | Cached prompt tokens | -| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Video input tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/providername.mdx b/client-sdks/python/api-reference/components/providername.mdx deleted file mode 100644 index 3b825fc5..00000000 --- a/client-sdks/python/api-reference/components/providername.mdx +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: ProviderName - Python SDK -sidebarTitle: ProviderName -description: ProviderName method reference -seoTitle: ProviderName | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/providername' -'og:site_name': OpenRouter Documentation -'og:title': ProviderName | OpenRouter Python SDK -'og:description': >- - ProviderName method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderName%20-%20Python%20SDK&description=ProviderName%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `AKASH_ML` | AkashML | -| `AI21` | AI21 | -| `AION_LABS` | AionLabs | -| `ALIBABA` | Alibaba | -| `AMBIENT` | Ambient | -| `BAIDU` | Baidu | -| `AMAZON_BEDROCK` | Amazon Bedrock | -| `AMAZON_NOVA` | Amazon Nova | -| `ANTHROPIC` | Anthropic | -| `ARCEE_AI` | Arcee AI | -| `ATLAS_CLOUD` | AtlasCloud | -| `AVIAN` | Avian | -| `AZURE` | Azure | -| `BASE_TEN` | BaseTen | -| `BYTE_PLUS` | BytePlus | -| `BLACK_FOREST_LABS` | Black Forest Labs | -| `CEREBRAS` | Cerebras | -| `CHUTES` | Chutes | -| `CIRRASCALE` | Cirrascale | -| `CLARIFAI` | Clarifai | -| `CLOUDFLARE` | Cloudflare | -| `COHERE` | Cohere | -| `CRUCIBLE` | Crucible | -| `CRUSOE` | Crusoe | -| `DARKBLOOM` | Darkbloom | -| `DEEP_INFRA` | DeepInfra | -| `DEEP_SEEK` | DeepSeek | -| `DEKA_LLM` | DekaLLM | -| `DIGITAL_OCEAN` | DigitalOcean | -| `FEATHERLESS` | Featherless | -| `FIREWORKS` | Fireworks | -| `FRIENDLI` | Friendli | -| `GMI_CLOUD` | GMICloud | -| `GOOGLE` | Google | -| `GOOGLE_AI_STUDIO` | Google AI Studio | -| `GROQ` | Groq | -| `HYPERBOLIC` | Hyperbolic | -| `INCEPTION` | Inception | -| `INCEPTRON` | Inceptron | -| `INFERENCE_NET` | InferenceNet | -| `IONSTREAM` | Ionstream | -| `INFERMATIC` | Infermatic | -| `IO_NET` | Io Net | -| `INFLECTION` | Inflection | -| `LIQUID` | Liquid | -| `MARA` | Mara | -| `MANCER_2` | Mancer 2 | -| `MINIMAX` | Minimax | -| `MODEL_RUN` | ModelRun | -| `MISTRAL` | Mistral | -| `MODULAR` | Modular | -| `MOONSHOT_AI` | Moonshot AI | -| `MORPH` | Morph | -| `N_COMPASS` | NCompass | -| `NEBIUS` | Nebius | -| `NEX_AGI` | Nex AGI | -| `NEXT_BIT` | NextBit | -| `NOVITA` | Novita | -| `NVIDIA` | Nvidia | -| `OPEN_AI` | OpenAI | -| `OPEN_INFERENCE` | OpenInference | -| `PARASAIL` | Parasail | -| `POOLSIDE` | Poolside | -| `PERCEPTRON` | Perceptron | -| `PERPLEXITY` | Perplexity | -| `PHALA` | Phala | -| `RECRAFT` | Recraft | -| `REKA` | Reka | -| `RELACE` | Relace | -| `SAMBA_NOVA` | SambaNova | -| `SEED` | Seed | -| `SILICON_FLOW` | SiliconFlow | -| `SOURCEFUL` | Sourceful | -| `STEP_FUN` | StepFun | -| `STEALTH` | Stealth | -| `STREAM_LAKE` | StreamLake | -| `SWITCHPOINT` | Switchpoint | -| `TOGETHER` | Together | -| `UPSTAGE` | Upstage | -| `VENICE` | Venice | -| `WAND_B` | WandB | -| `XIAOMI` | Xiaomi | -| `X_AI` | xAI | -| `Z_AI` | Z.AI | -| `FAKE_PROVIDER` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/provideroptions.mdx b/client-sdks/python/api-reference/components/provideroptions.mdx deleted file mode 100644 index 11d5480b..00000000 --- a/client-sdks/python/api-reference/components/provideroptions.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: ProviderOptions - Python SDK -sidebarTitle: ProviderOptions -description: ProviderOptions method reference -seoTitle: ProviderOptions | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/provideroptions -'og:site_name': OpenRouter Documentation -'og:title': ProviderOptions | OpenRouter Python SDK -'og:description': >- - ProviderOptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOptions%20-%20Python%20SDK&description=ProviderOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `oneai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ai21` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `aion_labs` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `akashml` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `alibaba` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `amazon_bedrock` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `amazon_nova` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ambient` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `anthropic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `anyscale` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `arcee_ai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `atlas_cloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `atoma` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `avian` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `azure` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `baidu` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `baseten` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `black_forest_labs` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `byteplus` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `centml` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cerebras` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `chutes` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cirrascale` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `clarifai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cloudflare` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `cohere` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crofai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crucible` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `crusoe` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `darkbloom` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `deepinfra` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `deepseek` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `dekallm` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `digitalocean` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `enfer` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `fake_provider` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `featherless` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `fireworks` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `friendli` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `gmicloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `google_ai_studio` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `google_vertex` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `gopomelo` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `groq` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `huggingface` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `hyperbolic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `hyperbolic_quantized` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inception` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inceptron` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inference_net` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `infermatic` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inflection` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `inocloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `io_net` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ionstream` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `klusterai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lambda_` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lepton` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `liquid` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lynn` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `lynn_private` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mancer` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mancer_old` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mara` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `meta` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `minimax` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `mistral` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modal` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modelrun` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `modular` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `moonshotai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `morph` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ncompass` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nebius` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nex_agi` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nextbit` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nineteen` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `novita` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `nvidia` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `octoai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `open_inference` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `openai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `parasail` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `perceptron` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `perplexity` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `phala` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `poolside` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `recraft` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `recursal` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `reflection` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `reka` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `relace` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `replicate` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sambanova` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sambanova_cloaked` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `seed` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sf_compute` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `siliconflow` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `sourceful` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `stealth` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `stepfun` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `streamlake` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `switchpoint` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `targon` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `together` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `together_lite` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `ubicloud` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `upstage` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `venice` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `wandb` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `xai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `xiaomi` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | -| `z_ai` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/provideroverloadedresponseerrordata.mdx b/client-sdks/python/api-reference/components/provideroverloadedresponseerrordata.mdx deleted file mode 100644 index a4498a2a..00000000 --- a/client-sdks/python/api-reference/components/provideroverloadedresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderOverloadedResponseErrorData - Python SDK -sidebarTitle: ProviderOverloadedResponseErrorData -description: ProviderOverloadedResponseErrorData method reference -seoTitle: ProviderOverloadedResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/provideroverloadedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseErrorData | OpenRouter Python SDK -'og:description': >- - ProviderOverloadedResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseErrorData%20-%20Python%20SDK&description=ProviderOverloadedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ProviderOverloadedResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/providerpreferences.mdx b/client-sdks/python/api-reference/components/providerpreferences.mdx deleted file mode 100644 index 906d42f8..00000000 --- a/client-sdks/python/api-reference/components/providerpreferences.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ProviderPreferences - Python SDK -sidebarTitle: ProviderPreferences -description: ProviderPreferences method reference -seoTitle: ProviderPreferences | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/providerpreferences -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferences | OpenRouter Python SDK -'og:description': >- - ProviderPreferences method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferences%20-%20Python%20SDK&description=ProviderPreferences%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -When multiple model providers are available, optionally indicate your routing preference. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| | -| `data_collection` | [OptionalNullable[components.DataCollection]](../components/datacollection.md) | :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 | -| `enforce_distillable_text` | *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` | List[[components.Ignore](/client-sdks/python/api-reference/components/ignore)] | :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"
] | -| `max_price` | [Optional[components.MaxPrice]](../components/maxprice.md) | :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` | List[[components.Only](/client-sdks/python/api-reference/components/only)] | :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` | List[[components.Order](/client-sdks/python/api-reference/components/order)] | :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"
] | -| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../components/preferredmaxlatency.md) | :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 | -| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../components/preferredminthroughput.md) | :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` | List[[components.Quantization](/client-sdks/python/api-reference/components/quantization)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `require_parameters` | *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[components.Sort]](../components/sort.md) | :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[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/client-sdks/python/api-reference/components/providerresponse.mdx b/client-sdks/python/api-reference/components/providerresponse.mdx deleted file mode 100644 index 9175023b..00000000 --- a/client-sdks/python/api-reference/components/providerresponse.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ProviderResponse - Python SDK -sidebarTitle: ProviderResponse -description: ProviderResponse method reference -seoTitle: ProviderResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/providerresponse -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponse | OpenRouter Python SDK -'og:description': >- - ProviderResponse method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponse%20-%20Python%20SDK&description=ProviderResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Details of a provider response for a generation attempt - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `endpoint_id` | *Optional[str]* | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `id` | *Optional[str]* | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | -| `latency` | *Optional[float]* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | -| `model_permaslug` | *Optional[str]* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `provider_name` | [Optional[components.ProviderResponseProviderName]](../components/providerresponseprovidername.md) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `status` | *Nullable[float]* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/providerresponseprovidername.mdx b/client-sdks/python/api-reference/components/providerresponseprovidername.mdx deleted file mode 100644 index a5dd3f7c..00000000 --- a/client-sdks/python/api-reference/components/providerresponseprovidername.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: ProviderResponseProviderName - Python SDK -sidebarTitle: ProviderResponseProviderName -description: ProviderResponseProviderName method reference -seoTitle: ProviderResponseProviderName | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/providerresponseprovidername -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponseProviderName | OpenRouter Python SDK -'og:description': >- - ProviderResponseProviderName method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponseProviderName%20-%20Python%20SDK&description=ProviderResponseProviderName%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Name of the provider - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `ANY_SCALE` | AnyScale | -| `ATOMA` | Atoma | -| `CENT_ML` | Cent-ML | -| `CROF_AI` | CrofAI | -| `ENFER` | Enfer | -| `GO_POMELO` | GoPomelo | -| `HUGGING_FACE` | HuggingFace | -| `HYPERBOLIC_2` | Hyperbolic 2 | -| `INO_CLOUD` | InoCloud | -| `KLUSTER` | Kluster | -| `LAMBDA` | Lambda | -| `LEPTON` | Lepton | -| `LYNN_2` | Lynn 2 | -| `LYNN` | Lynn | -| `MANCER` | Mancer | -| `META` | Meta | -| `MODAL` | Modal | -| `NINETEEN` | Nineteen | -| `OCTO_AI` | OctoAI | -| `RECURSAL` | Recursal | -| `REFLECTION` | Reflection | -| `REPLICATE` | Replicate | -| `SAMBA_NOVA_2` | SambaNova 2 | -| `SF_COMPUTE` | SF Compute | -| `TARGON` | Targon | -| `TOGETHER_2` | Together 2 | -| `UBICLOUD` | Ubicloud | -| `ONE_DOT_AI` | 01.AI | -| `AKASH_ML` | AkashML | -| `AI21` | AI21 | -| `AION_LABS` | AionLabs | -| `ALIBABA` | Alibaba | -| `AMBIENT` | Ambient | -| `BAIDU` | Baidu | -| `AMAZON_BEDROCK` | Amazon Bedrock | -| `AMAZON_NOVA` | Amazon Nova | -| `ANTHROPIC` | Anthropic | -| `ARCEE_AI` | Arcee AI | -| `ATLAS_CLOUD` | AtlasCloud | -| `AVIAN` | Avian | -| `AZURE` | Azure | -| `BASE_TEN` | BaseTen | -| `BYTE_PLUS` | BytePlus | -| `BLACK_FOREST_LABS` | Black Forest Labs | -| `CEREBRAS` | Cerebras | -| `CHUTES` | Chutes | -| `CIRRASCALE` | Cirrascale | -| `CLARIFAI` | Clarifai | -| `CLOUDFLARE` | Cloudflare | -| `COHERE` | Cohere | -| `CRUCIBLE` | Crucible | -| `CRUSOE` | Crusoe | -| `DARKBLOOM` | Darkbloom | -| `DEEP_INFRA` | DeepInfra | -| `DEEP_SEEK` | DeepSeek | -| `DEKA_LLM` | DekaLLM | -| `DIGITAL_OCEAN` | DigitalOcean | -| `FEATHERLESS` | Featherless | -| `FIREWORKS` | Fireworks | -| `FRIENDLI` | Friendli | -| `GMI_CLOUD` | GMICloud | -| `GOOGLE` | Google | -| `GOOGLE_AI_STUDIO` | Google AI Studio | -| `GROQ` | Groq | -| `HYPERBOLIC` | Hyperbolic | -| `INCEPTION` | Inception | -| `INCEPTRON` | Inceptron | -| `INFERENCE_NET` | InferenceNet | -| `IONSTREAM` | Ionstream | -| `INFERMATIC` | Infermatic | -| `IO_NET` | Io Net | -| `INFLECTION` | Inflection | -| `LIQUID` | Liquid | -| `MARA` | Mara | -| `MANCER_2` | Mancer 2 | -| `MINIMAX` | Minimax | -| `MODEL_RUN` | ModelRun | -| `MISTRAL` | Mistral | -| `MODULAR` | Modular | -| `MOONSHOT_AI` | Moonshot AI | -| `MORPH` | Morph | -| `N_COMPASS` | NCompass | -| `NEBIUS` | Nebius | -| `NEX_AGI` | Nex AGI | -| `NEXT_BIT` | NextBit | -| `NOVITA` | Novita | -| `NVIDIA` | Nvidia | -| `OPEN_AI` | OpenAI | -| `OPEN_INFERENCE` | OpenInference | -| `PARASAIL` | Parasail | -| `POOLSIDE` | Poolside | -| `PERCEPTRON` | Perceptron | -| `PERPLEXITY` | Perplexity | -| `PHALA` | Phala | -| `RECRAFT` | Recraft | -| `REKA` | Reka | -| `RELACE` | Relace | -| `SAMBA_NOVA` | SambaNova | -| `SEED` | Seed | -| `SILICON_FLOW` | SiliconFlow | -| `SOURCEFUL` | Sourceful | -| `STEP_FUN` | StepFun | -| `STEALTH` | Stealth | -| `STREAM_LAKE` | StreamLake | -| `SWITCHPOINT` | Switchpoint | -| `TOGETHER` | Together | -| `UPSTAGE` | Upstage | -| `VENICE` | Venice | -| `WAND_B` | WandB | -| `XIAOMI` | Xiaomi | -| `X_AI` | xAI | -| `Z_AI` | Z.AI | -| `FAKE_PROVIDER` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/providersort.mdx b/client-sdks/python/api-reference/components/providersort.mdx deleted file mode 100644 index f17b6e6f..00000000 --- a/client-sdks/python/api-reference/components/providersort.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderSort - Python SDK -sidebarTitle: ProviderSort -description: ProviderSort method reference -seoTitle: ProviderSort | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/providersort' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSort | OpenRouter Python SDK -'og:description': >- - ProviderSort method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSort%20-%20Python%20SDK&description=ProviderSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | -| `EXACTO` | exacto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/providersortconfig.mdx b/client-sdks/python/api-reference/components/providersortconfig.mdx deleted file mode 100644 index 39d6259f..00000000 --- a/client-sdks/python/api-reference/components/providersortconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ProviderSortConfig - Python SDK -sidebarTitle: ProviderSortConfig -description: ProviderSortConfig method reference -seoTitle: ProviderSortConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/providersortconfig -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfig | OpenRouter Python SDK -'og:description': >- - ProviderSortConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfig%20-%20Python%20SDK&description=ProviderSortConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [OptionalNullable[components.By]](../components/by.md) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [OptionalNullable[components.Partition]](../components/partition.md) | :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/client-sdks/python/api-reference/components/publicendpoint.mdx b/client-sdks/python/api-reference/components/publicendpoint.mdx deleted file mode 100644 index 7e0317a3..00000000 --- a/client-sdks/python/api-reference/components/publicendpoint.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: PublicEndpoint - Python SDK -sidebarTitle: PublicEndpoint -description: PublicEndpoint method reference -seoTitle: PublicEndpoint | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/publicendpoint' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpoint | OpenRouter Python SDK -'og:description': >- - PublicEndpoint method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpoint%20-%20Python%20SDK&description=PublicEndpoint%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about a specific model endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context_length` | *int* | :heavy_check_mark: | N/A | | -| `latency_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.md) | :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}` | -| `max_completion_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `max_prompt_tokens` | *Nullable[int]* | :heavy_check_mark: | N/A | | -| `model_id` | *str* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `model_name` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `pricing` | [components.Pricing](/client-sdks/python/api-reference/components/pricing) | :heavy_check_mark: | N/A | | -| `provider_name` | [components.ProviderName](/client-sdks/python/api-reference/components/providername) | :heavy_check_mark: | N/A | OpenAI | -| `quantization` | [Nullable[components.PublicEndpointQuantization]](../components/publicendpointquantization.md) | :heavy_check_mark: | N/A | fp16 | -| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.md) | :heavy_minus_sign: | N/A | 0 | -| `supported_parameters` | List[[components.Parameter](/client-sdks/python/api-reference/components/parameter)] | :heavy_check_mark: | N/A | | -| `supports_implicit_caching` | *bool* | :heavy_check_mark: | N/A | | -| `tag` | *str* | :heavy_check_mark: | N/A | | -| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.md) | :heavy_check_mark: | N/A | `{"p50": 25.5,"p75": 35.2,"p90": 48.7,"p99": 85.3}` | -| `uptime_last_1d` | *Nullable[float]* | :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. | | -| `uptime_last_30m` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `uptime_last_5m` | *Nullable[float]* | :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/client-sdks/python/api-reference/components/publicendpointquantization.mdx b/client-sdks/python/api-reference/components/publicendpointquantization.mdx deleted file mode 100644 index 140eb3fa..00000000 --- a/client-sdks/python/api-reference/components/publicendpointquantization.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PublicEndpointQuantization - Python SDK -sidebarTitle: PublicEndpointQuantization -description: PublicEndpointQuantization method reference -seoTitle: PublicEndpointQuantization | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/publicendpointquantization -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpointQuantization | OpenRouter Python SDK -'og:description': >- - PublicEndpointQuantization method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpointQuantization%20-%20Python%20SDK&description=PublicEndpointQuantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `INT4` | int4 | -| `INT8` | int8 | -| `FP4` | fp4 | -| `FP6` | fp6 | -| `FP8` | fp8 | -| `FP16` | fp16 | -| `BF16` | bf16 | -| `FP32` | fp32 | -| `UNKNOWN` | unknown | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/publicpricing.mdx b/client-sdks/python/api-reference/components/publicpricing.mdx deleted file mode 100644 index ed59e6be..00000000 --- a/client-sdks/python/api-reference/components/publicpricing.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PublicPricing - Python SDK -sidebarTitle: PublicPricing -description: PublicPricing method reference -seoTitle: PublicPricing | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/publicpricing' -'og:site_name': OpenRouter Documentation -'og:title': PublicPricing | OpenRouter Python SDK -'og:description': >- - PublicPricing method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicPricing%20-%20Python%20SDK&description=PublicPricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Pricing information for the model - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- | -| `audio` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `audio_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *str* | :heavy_check_mark: | N/A | 1000 | -| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `image` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *str* | :heavy_check_mark: | N/A | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/quality.mdx b/client-sdks/python/api-reference/components/quality.mdx deleted file mode 100644 index e1621c61..00000000 --- a/client-sdks/python/api-reference/components/quality.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Quality - Python SDK -sidebarTitle: Quality -description: Quality method reference -seoTitle: Quality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/quality' -'og:site_name': OpenRouter Documentation -'og:title': Quality | OpenRouter Python SDK -'og:description': >- - Quality method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quality%20-%20Python%20SDK&description=Quality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/quantization.mdx b/client-sdks/python/api-reference/components/quantization.mdx deleted file mode 100644 index b59aa2fb..00000000 --- a/client-sdks/python/api-reference/components/quantization.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Quantization - Python SDK -sidebarTitle: Quantization -description: Quantization method reference -seoTitle: Quantization | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/quantization' -'og:site_name': OpenRouter Documentation -'og:title': Quantization | OpenRouter Python SDK -'og:description': >- - Quantization method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantization%20-%20Python%20SDK&description=Quantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `INT4` | int4 | -| `INT8` | int8 | -| `FP4` | fp4 | -| `FP6` | fp6 | -| `FP8` | fp8 | -| `FP16` | fp16 | -| `BF16` | bf16 | -| `FP32` | fp32 | -| `UNKNOWN` | unknown | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/ranker.mdx b/client-sdks/python/api-reference/components/ranker.mdx deleted file mode 100644 index a9219a71..00000000 --- a/client-sdks/python/api-reference/components/ranker.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Ranker - Python SDK -sidebarTitle: Ranker -description: Ranker method reference -seoTitle: Ranker | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/ranker' -'og:site_name': OpenRouter Documentation -'og:title': Ranker | OpenRouter Python SDK -'og:description': >- - Ranker method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ranker%20-%20Python%20SDK&description=Ranker%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `AUTO` | auto | -| `DEFAULT_2024_11_15` | default-2024-11-15 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/rankingoptions.mdx b/client-sdks/python/api-reference/components/rankingoptions.mdx deleted file mode 100644 index 37ffe1a1..00000000 --- a/client-sdks/python/api-reference/components/rankingoptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RankingOptions - Python SDK -sidebarTitle: RankingOptions -description: RankingOptions method reference -seoTitle: RankingOptions | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/rankingoptions' -'og:site_name': OpenRouter Documentation -'og:title': RankingOptions | OpenRouter Python SDK -'og:description': >- - RankingOptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingOptions%20-%20Python%20SDK&description=RankingOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `ranker` | [Optional[components.Ranker]](../components/ranker.md) | :heavy_minus_sign: | N/A | -| `score_threshold` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/rankingsdailyitem.mdx b/client-sdks/python/api-reference/components/rankingsdailyitem.mdx deleted file mode 100644 index f9a3b98e..00000000 --- a/client-sdks/python/api-reference/components/rankingsdailyitem.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: RankingsDailyItem - Python SDK -sidebarTitle: RankingsDailyItem -description: RankingsDailyItem method reference -seoTitle: RankingsDailyItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/rankingsdailyitem -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyItem | OpenRouter Python SDK -'og:description': >- - RankingsDailyItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyItem%20-%20Python%20SDK&description=RankingsDailyItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date_` | *str* | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `model_permaslug` | *str* | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `total_tokens` | *str* | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/rankingsdailymeta.mdx b/client-sdks/python/api-reference/components/rankingsdailymeta.mdx deleted file mode 100644 index 3e38d665..00000000 --- a/client-sdks/python/api-reference/components/rankingsdailymeta.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: RankingsDailyMeta - Python SDK -sidebarTitle: RankingsDailyMeta -description: RankingsDailyMeta method reference -seoTitle: RankingsDailyMeta | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/rankingsdailymeta -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyMeta | OpenRouter Python SDK -'og:description': >- - RankingsDailyMeta method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyMeta%20-%20Python%20SDK&description=RankingsDailyMeta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `as_of` | *str* | :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 | -| `end_date` | *str* | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `start_date` | *str* | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `version` | [components.Version](/client-sdks/python/api-reference/components/version) | :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/client-sdks/python/api-reference/components/rankingsdailyresponse.mdx b/client-sdks/python/api-reference/components/rankingsdailyresponse.mdx deleted file mode 100644 index d5e87ea9..00000000 --- a/client-sdks/python/api-reference/components/rankingsdailyresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RankingsDailyResponse - Python SDK -sidebarTitle: RankingsDailyResponse -description: RankingsDailyResponse method reference -seoTitle: RankingsDailyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/rankingsdailyresponse -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyResponse | OpenRouter Python SDK -'og:description': >- - RankingsDailyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyResponse%20-%20Python%20SDK&description=RankingsDailyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | List[[components.RankingsDailyItem](/client-sdks/python/api-reference/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](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/reason.mdx b/client-sdks/python/api-reference/components/reason.mdx deleted file mode 100644 index 2e769c6e..00000000 --- a/client-sdks/python/api-reference/components/reason.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Reason - Python SDK -sidebarTitle: Reason -description: Reason method reference -seoTitle: Reason | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/reason' -'og:site_name': OpenRouter Documentation -'og:title': Reason | OpenRouter Python SDK -'og:description': >- - Reason method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reason%20-%20Python%20SDK&description=Reason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `MAX_OUTPUT_TOKENS` | max_output_tokens | -| `CONTENT_FILTER` | content_filter | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningconfig.mdx b/client-sdks/python/api-reference/components/reasoningconfig.mdx deleted file mode 100644 index e76de938..00000000 --- a/client-sdks/python/api-reference/components/reasoningconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ReasoningConfig - Python SDK -sidebarTitle: ReasoningConfig -description: ReasoningConfig method reference -seoTitle: ReasoningConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': ReasoningConfig | OpenRouter Python SDK -'og:description': >- - ReasoningConfig method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningConfig%20-%20Python%20SDK&description=ReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for reasoning mode in the response - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.ReasoningEffort]](../components/reasoningeffort.md) | :heavy_minus_sign: | N/A | medium | -| `summary` | [OptionalNullable[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.md) | :heavy_minus_sign: | N/A | auto | -| `enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdeltaevent.mdx b/client-sdks/python/api-reference/components/reasoningdeltaevent.mdx deleted file mode 100644 index 40ed129a..00000000 --- a/client-sdks/python/api-reference/components/reasoningdeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningDeltaEvent - Python SDK -sidebarTitle: ReasoningDeltaEvent -description: ReasoningDeltaEvent method reference -seoTitle: ReasoningDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDeltaEvent | OpenRouter Python SDK -'og:description': >- - ReasoningDeltaEvent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDeltaEvent%20-%20Python%20SDK&description=ReasoningDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningDeltaEventType](/client-sdks/python/api-reference/components/reasoningdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdeltaeventtype.mdx b/client-sdks/python/api-reference/components/reasoningdeltaeventtype.mdx deleted file mode 100644 index 979f68b6..00000000 --- a/client-sdks/python/api-reference/components/reasoningdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningDeltaEventType - Python SDK -sidebarTitle: ReasoningDeltaEventType -description: ReasoningDeltaEventType method reference -seoTitle: ReasoningDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDeltaEventType | OpenRouter Python SDK -'og:description': >- - ReasoningDeltaEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDeltaEventType%20-%20Python%20SDK&description=ReasoningDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `RESPONSE_REASONING_TEXT_DELTA` | response.reasoning_text.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailencrypted.mdx b/client-sdks/python/api-reference/components/reasoningdetailencrypted.mdx deleted file mode 100644 index 9e6cd9d4..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailencrypted.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDetailEncrypted - Python SDK -sidebarTitle: ReasoningDetailEncrypted -description: ReasoningDetailEncrypted method reference -seoTitle: ReasoningDetailEncrypted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailencrypted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailEncrypted | OpenRouter Python SDK -'og:description': >- - ReasoningDetailEncrypted method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailEncrypted%20-%20Python%20SDK&description=ReasoningDetailEncrypted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning detail encrypted schema - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ReasoningDetailEncryptedType](/client-sdks/python/api-reference/components/reasoningdetailencryptedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailencryptedtype.mdx b/client-sdks/python/api-reference/components/reasoningdetailencryptedtype.mdx deleted file mode 100644 index f9e5d12f..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailencryptedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningDetailEncryptedType - Python SDK -sidebarTitle: ReasoningDetailEncryptedType -description: ReasoningDetailEncryptedType method reference -seoTitle: ReasoningDetailEncryptedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailencryptedtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailEncryptedType | OpenRouter Python SDK -'og:description': >- - ReasoningDetailEncryptedType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailEncryptedType%20-%20Python%20SDK&description=ReasoningDetailEncryptedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `REASONING_ENCRYPTED` | reasoning.encrypted | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailsummary.mdx b/client-sdks/python/api-reference/components/reasoningdetailsummary.mdx deleted file mode 100644 index 869ea93d..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailsummary.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningDetailSummary - Python SDK -sidebarTitle: ReasoningDetailSummary -description: ReasoningDetailSummary method reference -seoTitle: ReasoningDetailSummary | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailsummary -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailSummary | OpenRouter Python SDK -'og:description': >- - ReasoningDetailSummary method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailSummary%20-%20Python%20SDK&description=ReasoningDetailSummary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning detail summary schema - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `summary` | *str* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningDetailSummaryType](/client-sdks/python/api-reference/components/reasoningdetailsummarytype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailsummarytype.mdx b/client-sdks/python/api-reference/components/reasoningdetailsummarytype.mdx deleted file mode 100644 index e7ea8f8c..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailsummarytype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningDetailSummaryType - Python SDK -sidebarTitle: ReasoningDetailSummaryType -description: ReasoningDetailSummaryType method reference -seoTitle: ReasoningDetailSummaryType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailsummarytype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailSummaryType | OpenRouter Python SDK -'og:description': >- - ReasoningDetailSummaryType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailSummaryType%20-%20Python%20SDK&description=ReasoningDetailSummaryType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `REASONING_SUMMARY` | reasoning.summary | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailtext.mdx b/client-sdks/python/api-reference/components/reasoningdetailtext.mdx deleted file mode 100644 index 7719c572..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailtext.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningDetailText - Python SDK -sidebarTitle: ReasoningDetailText -description: ReasoningDetailText method reference -seoTitle: ReasoningDetailText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailtext -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailText | OpenRouter Python SDK -'og:description': >- - ReasoningDetailText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailText%20-%20Python%20SDK&description=ReasoningDetailText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning detail text schema - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `type` | [components.ReasoningDetailTextType](/client-sdks/python/api-reference/components/reasoningdetailtexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailtexttype.mdx b/client-sdks/python/api-reference/components/reasoningdetailtexttype.mdx deleted file mode 100644 index 4ea0477d..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailtexttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningDetailTextType - Python SDK -sidebarTitle: ReasoningDetailTextType -description: ReasoningDetailTextType method reference -seoTitle: ReasoningDetailTextType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailtexttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailTextType | OpenRouter Python SDK -'og:description': >- - ReasoningDetailTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailTextType%20-%20Python%20SDK&description=ReasoningDetailTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `REASONING_TEXT` | reasoning.text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdetailunion.mdx b/client-sdks/python/api-reference/components/reasoningdetailunion.mdx deleted file mode 100644 index 53c0b487..00000000 --- a/client-sdks/python/api-reference/components/reasoningdetailunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ReasoningDetailUnion - Python SDK -sidebarTitle: ReasoningDetailUnion -description: ReasoningDetailUnion method reference -seoTitle: ReasoningDetailUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdetailunion -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailUnion | OpenRouter Python SDK -'og:description': >- - ReasoningDetailUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailUnion%20-%20Python%20SDK&description=ReasoningDetailUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning detail union schema - -## Supported Types - -### `components.ReasoningDetailEncrypted` - -```python lines -value: components.ReasoningDetailEncrypted = /* values here */ -``` - -### `components.ReasoningDetailSummary` - -```python lines -value: components.ReasoningDetailSummary = /* values here */ -``` - -### `components.ReasoningDetailText` - -```python lines -value: components.ReasoningDetailText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdoneevent.mdx b/client-sdks/python/api-reference/components/reasoningdoneevent.mdx deleted file mode 100644 index 6ce81665..00000000 --- a/client-sdks/python/api-reference/components/reasoningdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningDoneEvent - Python SDK -sidebarTitle: ReasoningDoneEvent -description: ReasoningDoneEvent method reference -seoTitle: ReasoningDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDoneEvent | OpenRouter Python SDK -'og:description': >- - ReasoningDoneEvent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDoneEvent%20-%20Python%20SDK&description=ReasoningDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningDoneEventType](/client-sdks/python/api-reference/components/reasoningdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningdoneeventtype.mdx b/client-sdks/python/api-reference/components/reasoningdoneeventtype.mdx deleted file mode 100644 index af7285d1..00000000 --- a/client-sdks/python/api-reference/components/reasoningdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningDoneEventType - Python SDK -sidebarTitle: ReasoningDoneEventType -description: ReasoningDoneEventType method reference -seoTitle: ReasoningDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDoneEventType | OpenRouter Python SDK -'og:description': >- - ReasoningDoneEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDoneEventType%20-%20Python%20SDK&description=ReasoningDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `RESPONSE_REASONING_TEXT_DONE` | response.reasoning_text.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningeffort.mdx b/client-sdks/python/api-reference/components/reasoningeffort.mdx deleted file mode 100644 index bba63858..00000000 --- a/client-sdks/python/api-reference/components/reasoningeffort.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ReasoningEffort - Python SDK -sidebarTitle: ReasoningEffort -description: ReasoningEffort method reference -seoTitle: ReasoningEffort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningeffort -'og:site_name': OpenRouter Documentation -'og:title': ReasoningEffort | OpenRouter Python SDK -'og:description': >- - ReasoningEffort method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningEffort%20-%20Python%20SDK&description=ReasoningEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `XHIGH` | xhigh | -| `HIGH` | high | -| `MEDIUM` | medium | -| `LOW` | low | -| `MINIMAL` | minimal | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningformat.mdx b/client-sdks/python/api-reference/components/reasoningformat.mdx deleted file mode 100644 index 546ee63d..00000000 --- a/client-sdks/python/api-reference/components/reasoningformat.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ReasoningFormat - Python SDK -sidebarTitle: ReasoningFormat -description: ReasoningFormat method reference -seoTitle: ReasoningFormat | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningformat -'og:site_name': OpenRouter Documentation -'og:title': ReasoningFormat | OpenRouter Python SDK -'og:description': >- - ReasoningFormat method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningFormat%20-%20Python%20SDK&description=ReasoningFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `UNKNOWN` | unknown | -| `OPENAI_RESPONSES_V1` | openai-responses-v1 | -| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 | -| `XAI_RESPONSES_V1` | xai-responses-v1 | -| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 | -| `GOOGLE_GEMINI_V1` | google-gemini-v1 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitem.mdx b/client-sdks/python/api-reference/components/reasoningitem.mdx deleted file mode 100644 index 6d22d96f..00000000 --- a/client-sdks/python/api-reference/components/reasoningitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItem - Python SDK -sidebarTitle: ReasoningItem -description: ReasoningItem method reference -seoTitle: ReasoningItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/reasoningitem' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItem | OpenRouter Python SDK -'og:description': >- - ReasoningItem method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItem%20-%20Python%20SDK&description=ReasoningItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning output item with signature and format extensions - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | List[[components.ReasoningTextContent](/client-sdks/python/api-reference/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.ReasoningItemStatusUnion]](../components/reasoningitemstatusunion.md) | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext)] | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningItemType](/client-sdks/python/api-reference/components/reasoningitemtype) | :heavy_check_mark: | N/A | | -| `format_` | [OptionalNullable[components.ReasoningFormat]](../components/reasoningformat.md) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitemstatuscompleted.mdx b/client-sdks/python/api-reference/components/reasoningitemstatuscompleted.mdx deleted file mode 100644 index 504e6c4a..00000000 --- a/client-sdks/python/api-reference/components/reasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningItemStatusCompleted - Python SDK -sidebarTitle: ReasoningItemStatusCompleted -description: ReasoningItemStatusCompleted method reference -seoTitle: ReasoningItemStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusCompleted | OpenRouter Python SDK -'og:description': >- - ReasoningItemStatusCompleted method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusCompleted%20-%20Python%20SDK&description=ReasoningItemStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitemstatusincomplete.mdx b/client-sdks/python/api-reference/components/reasoningitemstatusincomplete.mdx deleted file mode 100644 index 57d459f4..00000000 --- a/client-sdks/python/api-reference/components/reasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningItemStatusIncomplete - Python SDK -sidebarTitle: ReasoningItemStatusIncomplete -description: ReasoningItemStatusIncomplete method reference -seoTitle: ReasoningItemStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusIncomplete | OpenRouter Python SDK -'og:description': >- - ReasoningItemStatusIncomplete method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusIncomplete%20-%20Python%20SDK&description=ReasoningItemStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitemstatusinprogress.mdx b/client-sdks/python/api-reference/components/reasoningitemstatusinprogress.mdx deleted file mode 100644 index d44073f7..00000000 --- a/client-sdks/python/api-reference/components/reasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningItemStatusInProgress - Python SDK -sidebarTitle: ReasoningItemStatusInProgress -description: ReasoningItemStatusInProgress method reference -seoTitle: ReasoningItemStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusInProgress | OpenRouter Python SDK -'og:description': >- - ReasoningItemStatusInProgress method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusInProgress%20-%20Python%20SDK&description=ReasoningItemStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitemstatusunion.mdx b/client-sdks/python/api-reference/components/reasoningitemstatusunion.mdx deleted file mode 100644 index 9bd23d82..00000000 --- a/client-sdks/python/api-reference/components/reasoningitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ReasoningItemStatusUnion - Python SDK -sidebarTitle: ReasoningItemStatusUnion -description: ReasoningItemStatusUnion method reference -seoTitle: ReasoningItemStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusUnion | OpenRouter Python SDK -'og:description': >- - ReasoningItemStatusUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusUnion%20-%20Python%20SDK&description=ReasoningItemStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ReasoningItemStatusCompleted` - -```python lines -value: components.ReasoningItemStatusCompleted = /* values here */ -``` - -### `components.ReasoningItemStatusIncomplete` - -```python lines -value: components.ReasoningItemStatusIncomplete = /* values here */ -``` - -### `components.ReasoningItemStatusInProgress` - -```python lines -value: components.ReasoningItemStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningitemtype.mdx b/client-sdks/python/api-reference/components/reasoningitemtype.mdx deleted file mode 100644 index 6ded4e8e..00000000 --- a/client-sdks/python/api-reference/components/reasoningitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningItemType - Python SDK -sidebarTitle: ReasoningItemType -description: ReasoningItemType method reference -seoTitle: ReasoningItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningitemtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemType | OpenRouter Python SDK -'og:description': >- - ReasoningItemType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemType%20-%20Python%20SDK&description=ReasoningItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `REASONING` | reasoning | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarypartaddedevent.mdx b/client-sdks/python/api-reference/components/reasoningsummarypartaddedevent.mdx deleted file mode 100644 index 01739057..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarypartaddedevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryPartAddedEvent - Python SDK -sidebarTitle: ReasoningSummaryPartAddedEvent -description: ReasoningSummaryPartAddedEvent method reference -seoTitle: ReasoningSummaryPartAddedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarypartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartAddedEvent | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryPartAddedEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartAddedEvent%20-%20Python%20SDK&description=ReasoningSummaryPartAddedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is added - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"text": "Analyzed the problem using first principles","type": "summary_text"}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `summary_index` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningSummaryPartAddedEventType](/client-sdks/python/api-reference/components/reasoningsummarypartaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarypartaddedeventtype.mdx b/client-sdks/python/api-reference/components/reasoningsummarypartaddedeventtype.mdx deleted file mode 100644 index d7f8c1ed..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarypartaddedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryPartAddedEventType - Python SDK -sidebarTitle: ReasoningSummaryPartAddedEventType -description: ReasoningSummaryPartAddedEventType method reference -seoTitle: ReasoningSummaryPartAddedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarypartaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartAddedEventType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryPartAddedEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartAddedEventType%20-%20Python%20SDK&description=ReasoningSummaryPartAddedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_PART_ADDED` | response.reasoning_summary_part.added | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarypartdoneevent.mdx b/client-sdks/python/api-reference/components/reasoningsummarypartdoneevent.mdx deleted file mode 100644 index 75ea0108..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarypartdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryPartDoneEvent - Python SDK -sidebarTitle: ReasoningSummaryPartDoneEvent -description: ReasoningSummaryPartDoneEvent method reference -seoTitle: ReasoningSummaryPartDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarypartdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartDoneEvent | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryPartDoneEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartDoneEvent%20-%20Python%20SDK&description=ReasoningSummaryPartDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is complete - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"text": "Analyzed the problem using first principles","type": "summary_text"}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `summary_index` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.ReasoningSummaryPartDoneEventType](/client-sdks/python/api-reference/components/reasoningsummarypartdoneeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarypartdoneeventtype.mdx b/client-sdks/python/api-reference/components/reasoningsummarypartdoneeventtype.mdx deleted file mode 100644 index 012e791d..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarypartdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryPartDoneEventType - Python SDK -sidebarTitle: ReasoningSummaryPartDoneEventType -description: ReasoningSummaryPartDoneEventType method reference -seoTitle: ReasoningSummaryPartDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarypartdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartDoneEventType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryPartDoneEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartDoneEventType%20-%20Python%20SDK&description=ReasoningSummaryPartDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_PART_DONE` | response.reasoning_summary_part.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytext.mdx b/client-sdks/python/api-reference/components/reasoningsummarytext.mdx deleted file mode 100644 index 6e03603d..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytext.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ReasoningSummaryText - Python SDK -sidebarTitle: ReasoningSummaryText -description: ReasoningSummaryText method reference -seoTitle: ReasoningSummaryText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytext -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryText | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryText%20-%20Python%20SDK&description=ReasoningSummaryText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextType](/client-sdks/python/api-reference/components/reasoningsummarytexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytextdeltaevent.mdx b/client-sdks/python/api-reference/components/reasoningsummarytextdeltaevent.mdx deleted file mode 100644 index 8a4fb5a4..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytextdeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryTextDeltaEvent - Python SDK -sidebarTitle: ReasoningSummaryTextDeltaEvent -description: ReasoningSummaryTextDeltaEvent method reference -seoTitle: ReasoningSummaryTextDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytextdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDeltaEvent | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextDeltaEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDeltaEvent%20-%20Python%20SDK&description=ReasoningSummaryTextDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `summary_index` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextDeltaEventType](/client-sdks/python/api-reference/components/reasoningsummarytextdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytextdeltaeventtype.mdx b/client-sdks/python/api-reference/components/reasoningsummarytextdeltaeventtype.mdx deleted file mode 100644 index 23fc1cb3..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytextdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryTextDeltaEventType - Python SDK -sidebarTitle: ReasoningSummaryTextDeltaEventType -description: ReasoningSummaryTextDeltaEventType method reference -seoTitle: ReasoningSummaryTextDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytextdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDeltaEventType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextDeltaEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDeltaEventType%20-%20Python%20SDK&description=ReasoningSummaryTextDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_TEXT_DELTA` | response.reasoning_summary_text.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytextdoneevent.mdx b/client-sdks/python/api-reference/components/reasoningsummarytextdoneevent.mdx deleted file mode 100644 index 0e5d6fb9..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytextdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ReasoningSummaryTextDoneEvent - Python SDK -sidebarTitle: ReasoningSummaryTextDoneEvent -description: ReasoningSummaryTextDoneEvent method reference -seoTitle: ReasoningSummaryTextDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytextdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDoneEvent | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextDoneEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDoneEvent%20-%20Python%20SDK&description=ReasoningSummaryTextDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `summary_index` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningSummaryTextDoneEventType](/client-sdks/python/api-reference/components/reasoningsummarytextdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytextdoneeventtype.mdx b/client-sdks/python/api-reference/components/reasoningsummarytextdoneeventtype.mdx deleted file mode 100644 index 2c06e5ea..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytextdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryTextDoneEventType - Python SDK -sidebarTitle: ReasoningSummaryTextDoneEventType -description: ReasoningSummaryTextDoneEventType method reference -seoTitle: ReasoningSummaryTextDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytextdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDoneEventType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextDoneEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDoneEventType%20-%20Python%20SDK&description=ReasoningSummaryTextDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_TEXT_DONE` | response.reasoning_summary_text.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummarytexttype.mdx b/client-sdks/python/api-reference/components/reasoningsummarytexttype.mdx deleted file mode 100644 index 06884d97..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummarytexttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryTextType - Python SDK -sidebarTitle: ReasoningSummaryTextType -description: ReasoningSummaryTextType method reference -seoTitle: ReasoningSummaryTextType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummarytexttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextType%20-%20Python%20SDK&description=ReasoningSummaryTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `SUMMARY_TEXT` | summary_text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningsummaryverbosity.mdx b/client-sdks/python/api-reference/components/reasoningsummaryverbosity.mdx deleted file mode 100644 index 3c3d339d..00000000 --- a/client-sdks/python/api-reference/components/reasoningsummaryverbosity.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ReasoningSummaryVerbosity - Python SDK -sidebarTitle: ReasoningSummaryVerbosity -description: ReasoningSummaryVerbosity method reference -seoTitle: ReasoningSummaryVerbosity | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningsummaryverbosity -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryVerbosity | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryVerbosity method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryVerbosity%20-%20Python%20SDK&description=ReasoningSummaryVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `CONCISE` | concise | -| `DETAILED` | detailed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningtextcontent.mdx b/client-sdks/python/api-reference/components/reasoningtextcontent.mdx deleted file mode 100644 index 061b0bf4..00000000 --- a/client-sdks/python/api-reference/components/reasoningtextcontent.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ReasoningTextContent - Python SDK -sidebarTitle: ReasoningTextContent -description: ReasoningTextContent method reference -seoTitle: ReasoningTextContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningtextcontent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContent | OpenRouter Python SDK -'og:description': >- - ReasoningTextContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContent%20-%20Python%20SDK&description=ReasoningTextContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ReasoningTextContentType](/client-sdks/python/api-reference/components/reasoningtextcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/reasoningtextcontenttype.mdx b/client-sdks/python/api-reference/components/reasoningtextcontenttype.mdx deleted file mode 100644 index 90dc9ee1..00000000 --- a/client-sdks/python/api-reference/components/reasoningtextcontenttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningTextContentType - Python SDK -sidebarTitle: ReasoningTextContentType -description: ReasoningTextContentType method reference -seoTitle: ReasoningTextContentType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/reasoningtextcontenttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContentType | OpenRouter Python SDK -'og:description': >- - ReasoningTextContentType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContentType%20-%20Python%20SDK&description=ReasoningTextContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `REASONING_TEXT` | reasoning_text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/refusaldeltaevent.mdx b/client-sdks/python/api-reference/components/refusaldeltaevent.mdx deleted file mode 100644 index 1ea2c0a7..00000000 --- a/client-sdks/python/api-reference/components/refusaldeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: RefusalDeltaEvent - Python SDK -sidebarTitle: RefusalDeltaEvent -description: RefusalDeltaEvent method reference -seoTitle: RefusalDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/refusaldeltaevent -'og:site_name': OpenRouter Documentation -'og:title': RefusalDeltaEvent | OpenRouter Python SDK -'og:description': >- - RefusalDeltaEvent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDeltaEvent%20-%20Python%20SDK&description=RefusalDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a refusal delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.RefusalDeltaEventType](/client-sdks/python/api-reference/components/refusaldeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/refusaldeltaeventtype.mdx b/client-sdks/python/api-reference/components/refusaldeltaeventtype.mdx deleted file mode 100644 index 63d356d5..00000000 --- a/client-sdks/python/api-reference/components/refusaldeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RefusalDeltaEventType - Python SDK -sidebarTitle: RefusalDeltaEventType -description: RefusalDeltaEventType method reference -seoTitle: RefusalDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/refusaldeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': RefusalDeltaEventType | OpenRouter Python SDK -'og:description': >- - RefusalDeltaEventType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDeltaEventType%20-%20Python%20SDK&description=RefusalDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `RESPONSE_REFUSAL_DELTA` | response.refusal.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/refusaldoneevent.mdx b/client-sdks/python/api-reference/components/refusaldoneevent.mdx deleted file mode 100644 index c7f22838..00000000 --- a/client-sdks/python/api-reference/components/refusaldoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: RefusalDoneEvent - Python SDK -sidebarTitle: RefusalDoneEvent -description: RefusalDoneEvent method reference -seoTitle: RefusalDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/refusaldoneevent -'og:site_name': OpenRouter Documentation -'og:title': RefusalDoneEvent | OpenRouter Python SDK -'og:description': >- - RefusalDoneEvent method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDoneEvent%20-%20Python%20SDK&description=RefusalDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when refusal streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `refusal` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.RefusalDoneEventType](/client-sdks/python/api-reference/components/refusaldoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/refusaldoneeventtype.mdx b/client-sdks/python/api-reference/components/refusaldoneeventtype.mdx deleted file mode 100644 index bf6dcdc0..00000000 --- a/client-sdks/python/api-reference/components/refusaldoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RefusalDoneEventType - Python SDK -sidebarTitle: RefusalDoneEventType -description: RefusalDoneEventType method reference -seoTitle: RefusalDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/refusaldoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': RefusalDoneEventType | OpenRouter Python SDK -'og:description': >- - RefusalDoneEventType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDoneEventType%20-%20Python%20SDK&description=RefusalDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `RESPONSE_REFUSAL_DONE` | response.refusal.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/region.mdx b/client-sdks/python/api-reference/components/region.mdx deleted file mode 100644 index 63286be5..00000000 --- a/client-sdks/python/api-reference/components/region.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Region - Python SDK -sidebarTitle: Region -description: Region method reference -seoTitle: Region | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/region' -'og:site_name': OpenRouter Documentation -'og:title': Region | OpenRouter Python SDK -'og:description': >- - Region method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Region%20-%20Python%20SDK&description=Region%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `US` | us | -| `EU` | eu | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/requesttimeoutresponseerrordata.mdx b/client-sdks/python/api-reference/components/requesttimeoutresponseerrordata.mdx deleted file mode 100644 index eef0fc3c..00000000 --- a/client-sdks/python/api-reference/components/requesttimeoutresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: RequestTimeoutResponseErrorData - Python SDK -sidebarTitle: RequestTimeoutResponseErrorData -description: RequestTimeoutResponseErrorData method reference -seoTitle: RequestTimeoutResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/requesttimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseErrorData | OpenRouter Python SDK -'og:description': >- - RequestTimeoutResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseErrorData%20-%20Python%20SDK&description=RequestTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for RequestTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/requireapproval.mdx b/client-sdks/python/api-reference/components/requireapproval.mdx deleted file mode 100644 index 25396bea..00000000 --- a/client-sdks/python/api-reference/components/requireapproval.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RequireApproval - Python SDK -sidebarTitle: RequireApproval -description: RequireApproval method reference -seoTitle: RequireApproval | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/requireapproval -'og:site_name': OpenRouter Documentation -'og:title': RequireApproval | OpenRouter Python SDK -'og:description': >- - RequireApproval method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApproval%20-%20Python%20SDK&description=RequireApproval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `always` | [Optional[components.Always]](../components/always.md) | :heavy_minus_sign: | N/A | -| `never` | [Optional[components.Never]](../components/never.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/requireapprovalalways.mdx b/client-sdks/python/api-reference/components/requireapprovalalways.mdx deleted file mode 100644 index 7c00ca6e..00000000 --- a/client-sdks/python/api-reference/components/requireapprovalalways.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RequireApprovalAlways - Python SDK -sidebarTitle: RequireApprovalAlways -description: RequireApprovalAlways method reference -seoTitle: RequireApprovalAlways | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/requireapprovalalways -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalAlways | OpenRouter Python SDK -'og:description': >- - RequireApprovalAlways method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalAlways%20-%20Python%20SDK&description=RequireApprovalAlways%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `ALWAYS` | always | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/requireapprovalnever.mdx b/client-sdks/python/api-reference/components/requireapprovalnever.mdx deleted file mode 100644 index 8a416641..00000000 --- a/client-sdks/python/api-reference/components/requireapprovalnever.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RequireApprovalNever - Python SDK -sidebarTitle: RequireApprovalNever -description: RequireApprovalNever method reference -seoTitle: RequireApprovalNever | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/requireapprovalnever -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalNever | OpenRouter Python SDK -'og:description': >- - RequireApprovalNever method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalNever%20-%20Python%20SDK&description=RequireApprovalNever%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `NEVER` | never | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/requireapprovalunion.mdx b/client-sdks/python/api-reference/components/requireapprovalunion.mdx deleted file mode 100644 index b52a4cad..00000000 --- a/client-sdks/python/api-reference/components/requireapprovalunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: RequireApprovalUnion - Python SDK -sidebarTitle: RequireApprovalUnion -description: RequireApprovalUnion method reference -seoTitle: RequireApprovalUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/requireapprovalunion -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalUnion | OpenRouter Python SDK -'og:description': >- - RequireApprovalUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalUnion%20-%20Python%20SDK&description=RequireApprovalUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.RequireApproval` - -```python lines -value: components.RequireApproval = /* values here */ -``` - -### `components.RequireApprovalAlways` - -```python lines -value: components.RequireApprovalAlways = /* values here */ -``` - -### `components.RequireApprovalNever` - -```python lines -value: components.RequireApprovalNever = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/resolution.mdx b/client-sdks/python/api-reference/components/resolution.mdx deleted file mode 100644 index 9e23d0a9..00000000 --- a/client-sdks/python/api-reference/components/resolution.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Resolution - Python SDK -sidebarTitle: Resolution -description: Resolution method reference -seoTitle: Resolution | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/resolution' -'og:site_name': OpenRouter Documentation -'og:title': Resolution | OpenRouter Python SDK -'og:description': >- - Resolution method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Resolution%20-%20Python%20SDK&description=Resolution%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Resolution of the generated video - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `FOUR_HUNDRED_AND_EIGHTYP` | 480p | -| `SEVEN_HUNDRED_AND_TWENTYP` | 720p | -| `ONE_THOUSAND_AND_EIGHTYP` | 1080p | -| `ONE_K` | 1K | -| `TWO_K` | 2K | -| `FOUR_K` | 4K | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/response.mdx b/client-sdks/python/api-reference/components/response.mdx deleted file mode 100644 index f3ae9a06..00000000 --- a/client-sdks/python/api-reference/components/response.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Response - Python SDK -sidebarTitle: Response -description: Response method reference -seoTitle: Response | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/response' -'og:site_name': OpenRouter Documentation -'og:title': Response | OpenRouter Python SDK -'og:description': >- - Response method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Response%20-%20Python%20SDK&description=Response%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseformat.mdx b/client-sdks/python/api-reference/components/responseformat.mdx deleted file mode 100644 index 0f360feb..00000000 --- a/client-sdks/python/api-reference/components/responseformat.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ResponseFormat - Python SDK -sidebarTitle: ResponseFormat -description: ResponseFormat method reference -seoTitle: ResponseFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/responseformat' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormat | OpenRouter Python SDK -'og:description': >- - ResponseFormat method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormat%20-%20Python%20SDK&description=ResponseFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Response format configuration - -## Supported Types - -### `components.ChatFormatGrammarConfig` - -```python lines -value: components.ChatFormatGrammarConfig = /* values here */ -``` - -### `components.FormatJSONObjectConfig` - -```python lines -value: components.FormatJSONObjectConfig = /* values here */ -``` - -### `components.ChatFormatJSONSchemaConfig` - -```python lines -value: components.ChatFormatJSONSchemaConfig = /* values here */ -``` - -### `components.ChatFormatPythonConfig` - -```python lines -value: components.ChatFormatPythonConfig = /* values here */ -``` - -### `components.ChatFormatTextConfig` - -```python lines -value: components.ChatFormatTextConfig = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseformatenum.mdx b/client-sdks/python/api-reference/components/responseformatenum.mdx deleted file mode 100644 index 0cc2c58a..00000000 --- a/client-sdks/python/api-reference/components/responseformatenum.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ResponseFormatEnum - Python SDK -sidebarTitle: ResponseFormatEnum -description: ResponseFormatEnum method reference -seoTitle: ResponseFormatEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseformatenum -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatEnum | OpenRouter Python SDK -'og:description': >- - ResponseFormatEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatEnum%20-%20Python%20SDK&description=ResponseFormatEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Audio output format - -## Values - -| Name | Value | -| ----- | ----- | -| `MP3` | mp3 | -| `PCM` | pcm | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsehealingplugin.mdx b/client-sdks/python/api-reference/components/responsehealingplugin.mdx deleted file mode 100644 index cd801bdf..00000000 --- a/client-sdks/python/api-reference/components/responsehealingplugin.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseHealingPlugin - Python SDK -sidebarTitle: ResponseHealingPlugin -description: ResponseHealingPlugin method reference -seoTitle: ResponseHealingPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsehealingplugin -'og:site_name': OpenRouter Documentation -'og:title': ResponseHealingPlugin | OpenRouter Python SDK -'og:description': >- - ResponseHealingPlugin method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseHealingPlugin%20-%20Python%20SDK&description=ResponseHealingPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `id` | [components.ResponseHealingPluginID](/client-sdks/python/api-reference/components/responsehealingpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsehealingpluginid.mdx b/client-sdks/python/api-reference/components/responsehealingpluginid.mdx deleted file mode 100644 index ce0f6d69..00000000 --- a/client-sdks/python/api-reference/components/responsehealingpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseHealingPluginID - Python SDK -sidebarTitle: ResponseHealingPluginID -description: ResponseHealingPluginID method reference -seoTitle: ResponseHealingPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsehealingpluginid -'og:site_name': OpenRouter Documentation -'og:title': ResponseHealingPluginID | OpenRouter Python SDK -'og:description': >- - ResponseHealingPluginID method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseHealingPluginID%20-%20Python%20SDK&description=ResponseHealingPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `RESPONSE_HEALING` | response-healing | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseincludesenum.mdx b/client-sdks/python/api-reference/components/responseincludesenum.mdx deleted file mode 100644 index 6665fe91..00000000 --- a/client-sdks/python/api-reference/components/responseincludesenum.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ResponseIncludesEnum - Python SDK -sidebarTitle: ResponseIncludesEnum -description: ResponseIncludesEnum method reference -seoTitle: ResponseIncludesEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseincludesenum -'og:site_name': OpenRouter Documentation -'og:title': ResponseIncludesEnum | OpenRouter Python SDK -'og:description': >- - ResponseIncludesEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseIncludesEnum%20-%20Python%20SDK&description=ResponseIncludesEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `FILE_SEARCH_CALL_RESULTS` | file_search_call.results | -| `MESSAGE_INPUT_IMAGE_IMAGE_URL` | message.input_image.image_url | -| `COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL` | computer_call_output.output.image_url | -| `REASONING_ENCRYPTED_CONTENT` | reasoning.encrypted_content | -| `CODE_INTERPRETER_CALL_OUTPUTS` | code_interpreter_call.outputs | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseoutputtext.mdx b/client-sdks/python/api-reference/components/responseoutputtext.mdx deleted file mode 100644 index 7d50312b..00000000 --- a/client-sdks/python/api-reference/components/responseoutputtext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ResponseOutputText - Python SDK -sidebarTitle: ResponseOutputText -description: ResponseOutputText method reference -seoTitle: ResponseOutputText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseoutputtext -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputText | OpenRouter Python SDK -'og:description': >- - ResponseOutputText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputText%20-%20Python%20SDK&description=ResponseOutputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `annotations` | List[[components.OpenAIResponsesAnnotation](/client-sdks/python/api-reference/components/openairesponsesannotation)] | :heavy_minus_sign: | N/A | -| `logprobs` | List[[components.Logprob](/client-sdks/python/api-reference/components/logprob)] | :heavy_minus_sign: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.ResponseOutputTextType](/client-sdks/python/api-reference/components/responseoutputtexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseoutputtexttoplogprob.mdx b/client-sdks/python/api-reference/components/responseoutputtexttoplogprob.mdx deleted file mode 100644 index f9d74044..00000000 --- a/client-sdks/python/api-reference/components/responseoutputtexttoplogprob.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponseOutputTextTopLogprob - Python SDK -sidebarTitle: ResponseOutputTextTopLogprob -description: ResponseOutputTextTopLogprob method reference -seoTitle: ResponseOutputTextTopLogprob | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseoutputtexttoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextTopLogprob | OpenRouter Python SDK -'og:description': >- - ResponseOutputTextTopLogprob method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextTopLogprob%20-%20Python%20SDK&description=ResponseOutputTextTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseoutputtexttype.mdx b/client-sdks/python/api-reference/components/responseoutputtexttype.mdx deleted file mode 100644 index b088e580..00000000 --- a/client-sdks/python/api-reference/components/responseoutputtexttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseOutputTextType - Python SDK -sidebarTitle: ResponseOutputTextType -description: ResponseOutputTextType method reference -seoTitle: ResponseOutputTextType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseoutputtexttype -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextType | OpenRouter Python SDK -'og:description': >- - ResponseOutputTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextType%20-%20Python%20SDK&description=ResponseOutputTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `OUTPUT_TEXT` | output_text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responseserrorfield.mdx b/client-sdks/python/api-reference/components/responseserrorfield.mdx deleted file mode 100644 index 74fa3fdc..00000000 --- a/client-sdks/python/api-reference/components/responseserrorfield.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ResponsesErrorField - Python SDK -sidebarTitle: ResponsesErrorField -description: ResponsesErrorField method reference -seoTitle: ResponsesErrorField | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responseserrorfield -'og:site_name': OpenRouter Documentation -'og:title': ResponsesErrorField | OpenRouter Python SDK -'og:description': >- - ResponsesErrorField method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesErrorField%20-%20Python%20SDK&description=ResponsesErrorField%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error information returned from the API - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `code` | [components.Code](/client-sdks/python/api-reference/components/code) | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesrequest.mdx b/client-sdks/python/api-reference/components/responsesrequest.mdx deleted file mode 100644 index 36b26b7e..00000000 --- a/client-sdks/python/api-reference/components/responsesrequest.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: ResponsesRequest - Python SDK -sidebarTitle: ResponsesRequest -description: ResponsesRequest method reference -seoTitle: ResponsesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequest -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequest | OpenRouter Python SDK -'og:description': >- - ResponsesRequest method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequest%20-%20Python%20SDK&description=ResponsesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request schema for Responses endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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` | List[[components.ResponseIncludesEnum](/client-sdks/python/api-reference/components/responseincludesenum)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](../components/inputsunion.md) | :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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](/client-sdks/python/api-reference/components/outputmodalityenum)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](/client-sdks/python/api-reference/components/responsesrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](../components/storedprompttemplate.md) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](../components/reasoningconfig.md) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"effort": "medium","summary": "auto"}` | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](../components/responsesrequestservicetier.md) | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `store` | *Optional[Literal[False]]* | :heavy_minus_sign: | N/A | | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](../components/textextendedconfig.md) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
\} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.md) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](/client-sdks/python/api-reference/components/responsesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](../components/traceconfig.md) | :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[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.md) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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/client-sdks/python/api-reference/components/responsesrequestplugin.mdx b/client-sdks/python/api-reference/components/responsesrequestplugin.mdx deleted file mode 100644 index 84aa9391..00000000 --- a/client-sdks/python/api-reference/components/responsesrequestplugin.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: ResponsesRequestPlugin - Python SDK -sidebarTitle: ResponsesRequestPlugin -description: ResponsesRequestPlugin method reference -seoTitle: ResponsesRequestPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestPlugin | OpenRouter Python SDK -'og:description': >- - ResponsesRequestPlugin method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestPlugin%20-%20Python%20SDK&description=ResponsesRequestPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AutoRouterPlugin` - -```python lines -value: components.AutoRouterPlugin = /* values here */ -``` - -### `components.ContextCompressionPlugin` - -```python lines -value: components.ContextCompressionPlugin = /* values here */ -``` - -### `components.FileParserPlugin` - -```python lines -value: components.FileParserPlugin = /* values here */ -``` - -### `components.FusionPlugin` - -```python lines -value: components.FusionPlugin = /* values here */ -``` - -### `components.ModerationPlugin` - -```python lines -value: components.ModerationPlugin = /* values here */ -``` - -### `components.ParetoRouterPlugin` - -```python lines -value: components.ParetoRouterPlugin = /* values here */ -``` - -### `components.ResponseHealingPlugin` - -```python lines -value: components.ResponseHealingPlugin = /* values here */ -``` - -### `components.WebSearchPlugin` - -```python lines -value: components.WebSearchPlugin = /* values here */ -``` - -### `components.WebFetchPlugin` - -```python lines -value: components.WebFetchPlugin = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesrequestservicetier.mdx b/client-sdks/python/api-reference/components/responsesrequestservicetier.mdx deleted file mode 100644 index 75f6798a..00000000 --- a/client-sdks/python/api-reference/components/responsesrequestservicetier.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ResponsesRequestServiceTier - Python SDK -sidebarTitle: ResponsesRequestServiceTier -description: ResponsesRequestServiceTier method reference -seoTitle: ResponsesRequestServiceTier | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequestservicetier -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestServiceTier | OpenRouter Python SDK -'og:description': >- - ResponsesRequestServiceTier method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestServiceTier%20-%20Python%20SDK&description=ResponsesRequestServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DEFAULT` | default | -| `FLEX` | flex | -| `PRIORITY` | priority | -| `SCALE` | scale | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesrequesttoolfunction.mdx b/client-sdks/python/api-reference/components/responsesrequesttoolfunction.mdx deleted file mode 100644 index 2581b9e6..00000000 --- a/client-sdks/python/api-reference/components/responsesrequesttoolfunction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponsesRequestToolFunction - Python SDK -sidebarTitle: ResponsesRequestToolFunction -description: ResponsesRequestToolFunction method reference -seoTitle: ResponsesRequestToolFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequesttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolFunction | OpenRouter Python SDK -'og:description': >- - ResponsesRequestToolFunction method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolFunction%20-%20Python%20SDK&description=ResponsesRequestToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.ResponsesRequestType](/client-sdks/python/api-reference/components/responsesrequesttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesrequesttoolunion.mdx b/client-sdks/python/api-reference/components/responsesrequesttoolunion.mdx deleted file mode 100644 index 48db9dc0..00000000 --- a/client-sdks/python/api-reference/components/responsesrequesttoolunion.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: ResponsesRequestToolUnion - Python SDK -sidebarTitle: ResponsesRequestToolUnion -description: ResponsesRequestToolUnion method reference -seoTitle: ResponsesRequestToolUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolUnion | OpenRouter Python SDK -'og:description': >- - ResponsesRequestToolUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolUnion%20-%20Python%20SDK&description=ResponsesRequestToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponsesRequestToolFunction` - -```python lines -value: components.ResponsesRequestToolFunction = /* values here */ -``` - -### `components.PreviewWebSearchServerTool` - -```python lines -value: components.PreviewWebSearchServerTool = /* values here */ -``` - -### `components.Preview20250311WebSearchServerTool` - -```python lines -value: components.Preview20250311WebSearchServerTool = /* values here */ -``` - -### `components.LegacyWebSearchServerTool` - -```python lines -value: components.LegacyWebSearchServerTool = /* values here */ -``` - -### `components.WebSearchServerTool` - -```python lines -value: components.WebSearchServerTool = /* values here */ -``` - -### `components.FileSearchServerTool` - -```python lines -value: components.FileSearchServerTool = /* values here */ -``` - -### `components.ComputerUseServerTool` - -```python lines -value: components.ComputerUseServerTool = /* values here */ -``` - -### `components.CodeInterpreterServerTool` - -```python lines -value: components.CodeInterpreterServerTool = /* values here */ -``` - -### `components.McpServerTool` - -```python lines -value: components.McpServerTool = /* values here */ -``` - -### `components.ImageGenerationServerTool` - -```python lines -value: components.ImageGenerationServerTool = /* values here */ -``` - -### `components.CodexLocalShellTool` - -```python lines -value: components.CodexLocalShellTool = /* values here */ -``` - -### `components.ShellServerTool` - -```python lines -value: components.ShellServerTool = /* values here */ -``` - -### `components.ApplyPatchServerTool` - -```python lines -value: components.ApplyPatchServerTool = /* values here */ -``` - -### `components.CustomTool` - -```python lines -value: components.CustomTool = /* values here */ -``` - -### `components.DatetimeServerTool` - -```python lines -value: components.DatetimeServerTool = /* values here */ -``` - -### `components.FusionServerToolOpenRouter` - -```python lines -value: components.FusionServerToolOpenRouter = /* values here */ -``` - -### `components.ImageGenerationServerToolOpenRouter` - -```python lines -value: components.ImageGenerationServerToolOpenRouter = /* values here */ -``` - -### `components.ChatSearchModelsServerTool` - -```python lines -value: components.ChatSearchModelsServerTool = /* values here */ -``` - -### `components.WebFetchServerTool` - -```python lines -value: components.WebFetchServerTool = /* values here */ -``` - -### `components.WebSearchServerToolOpenRouter` - -```python lines -value: components.WebSearchServerToolOpenRouter = /* values here */ -``` - -### `components.ApplyPatchServerToolOpenRouter` - -```python lines -value: components.ApplyPatchServerToolOpenRouter = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesrequesttype.mdx b/client-sdks/python/api-reference/components/responsesrequesttype.mdx deleted file mode 100644 index a24fa11a..00000000 --- a/client-sdks/python/api-reference/components/responsesrequesttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesRequestType - Python SDK -sidebarTitle: ResponsesRequestType -description: ResponsesRequestType method reference -seoTitle: ResponsesRequestType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesrequesttype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestType | OpenRouter Python SDK -'og:description': >- - ResponsesRequestType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestType%20-%20Python%20SDK&description=ResponsesRequestType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/responsesstreamingresponse.mdx b/client-sdks/python/api-reference/components/responsesstreamingresponse.mdx deleted file mode 100644 index 1e09f277..00000000 --- a/client-sdks/python/api-reference/components/responsesstreamingresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesStreamingResponse - Python SDK -sidebarTitle: ResponsesStreamingResponse -description: ResponsesStreamingResponse method reference -seoTitle: ResponsesStreamingResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/responsesstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': ResponsesStreamingResponse | OpenRouter Python SDK -'og:description': >- - ResponsesStreamingResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesStreamingResponse%20-%20Python%20SDK&description=ResponsesStreamingResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.StreamEvents](/client-sdks/python/api-reference/components/streamevents) | :heavy_check_mark: | Union of all possible event types emitted during response streaming | `{"response": {"created_at": 1704067200,"error": 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,"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/client-sdks/python/api-reference/components/routerattempt.mdx b/client-sdks/python/api-reference/components/routerattempt.mdx deleted file mode 100644 index e1d9df30..00000000 --- a/client-sdks/python/api-reference/components/routerattempt.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RouterAttempt - Python SDK -sidebarTitle: RouterAttempt -description: RouterAttempt method reference -seoTitle: RouterAttempt | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/routerattempt' -'og:site_name': OpenRouter Documentation -'og:title': RouterAttempt | OpenRouter Python SDK -'og:description': >- - RouterAttempt method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterAttempt%20-%20Python%20SDK&description=RouterAttempt%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *str* | :heavy_check_mark: | N/A | -| `status` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/routerparams.mdx b/client-sdks/python/api-reference/components/routerparams.mdx deleted file mode 100644 index dda77a9f..00000000 --- a/client-sdks/python/api-reference/components/routerparams.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: RouterParams - Python SDK -sidebarTitle: RouterParams -description: RouterParams method reference -seoTitle: RouterParams | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/routerparams' -'og:site_name': OpenRouter Documentation -'og:title': RouterParams | OpenRouter Python SDK -'og:description': >- - RouterParams method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterParams%20-%20Python%20SDK&description=RouterParams%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `quality_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `throughput_floor` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `version_group` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/routingstrategy.mdx b/client-sdks/python/api-reference/components/routingstrategy.mdx deleted file mode 100644 index 850e5dcd..00000000 --- a/client-sdks/python/api-reference/components/routingstrategy.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: RoutingStrategy - Python SDK -sidebarTitle: RoutingStrategy -description: RoutingStrategy method reference -seoTitle: RoutingStrategy | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/routingstrategy -'og:site_name': OpenRouter Documentation -'og:title': RoutingStrategy | OpenRouter Python SDK -'og:description': >- - RoutingStrategy method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RoutingStrategy%20-%20Python%20SDK&description=RoutingStrategy%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `DIRECT` | direct | -| `AUTO` | auto | -| `FREE` | free | -| `LATEST` | latest | -| `ALIAS` | alias | -| `FALLBACK` | fallback | -| `PARETO` | pareto | -| `BODYBUILDER` | bodybuilder | -| `FUSION` | fusion | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/rule.mdx b/client-sdks/python/api-reference/components/rule.mdx deleted file mode 100644 index 86cf8c70..00000000 --- a/client-sdks/python/api-reference/components/rule.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Rule - Python SDK -sidebarTitle: Rule -description: Rule method reference -seoTitle: Rule | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/rule' -'og:site_name': OpenRouter Documentation -'og:title': Rule | OpenRouter Python SDK -'og:description': >- - Rule method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rule%20-%20Python%20SDK&description=Rule%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `field` | [components.FieldT](/client-sdks/python/api-reference/components/fieldt) | :heavy_check_mark: | N/A | -| `operator` | [components.Operator](/client-sdks/python/api-reference/components/operator) | :heavy_check_mark: | N/A | -| `value` | [Optional[components.ObservabilityFilterRulesConfigValue]](../components/observabilityfilterrulesconfigvalue.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/searchcontextsizeenum.mdx b/client-sdks/python/api-reference/components/searchcontextsizeenum.mdx deleted file mode 100644 index b5f45feb..00000000 --- a/client-sdks/python/api-reference/components/searchcontextsizeenum.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SearchContextSizeEnum - Python SDK -sidebarTitle: SearchContextSizeEnum -description: SearchContextSizeEnum method reference -seoTitle: SearchContextSizeEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/searchcontextsizeenum -'og:site_name': OpenRouter Documentation -'og:title': SearchContextSizeEnum | OpenRouter Python SDK -'og:description': >- - SearchContextSizeEnum method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchContextSizeEnum%20-%20Python%20SDK&description=SearchContextSizeEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Size of the search context for web search tools - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/searchmodelsservertoolconfig.mdx b/client-sdks/python/api-reference/components/searchmodelsservertoolconfig.mdx deleted file mode 100644 index 7fc6fe66..00000000 --- a/client-sdks/python/api-reference/components/searchmodelsservertoolconfig.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SearchModelsServerToolConfig - Python SDK -sidebarTitle: SearchModelsServerToolConfig -description: SearchModelsServerToolConfig method reference -seoTitle: SearchModelsServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/searchmodelsservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': SearchModelsServerToolConfig | OpenRouter Python SDK -'og:description': >- - SearchModelsServerToolConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchModelsServerToolConfig%20-%20Python%20SDK&description=SearchModelsServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:experimental__search_models server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/searchqualitylevel.mdx b/client-sdks/python/api-reference/components/searchqualitylevel.mdx deleted file mode 100644 index 28d6c634..00000000 --- a/client-sdks/python/api-reference/components/searchqualitylevel.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SearchQualityLevel - Python SDK -sidebarTitle: SearchQualityLevel -description: SearchQualityLevel method reference -seoTitle: SearchQualityLevel | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/searchqualitylevel -'og:site_name': OpenRouter Documentation -'og:title': SearchQualityLevel | OpenRouter Python SDK -'og:description': >- - SearchQualityLevel method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchQualityLevel%20-%20Python%20SDK&description=SearchQualityLevel%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -How much context to retrieve per result. Applies to Exa and Parallel 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. - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/security.mdx b/client-sdks/python/api-reference/components/security.mdx deleted file mode 100644 index 76543fb8..00000000 --- a/client-sdks/python/api-reference/components/security.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Security - Python SDK -sidebarTitle: Security -description: Security method reference -seoTitle: Security | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/security' -'og:site_name': OpenRouter Documentation -'og:title': Security | OpenRouter Python SDK -'og:description': >- - Security method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Security%20-%20Python%20SDK&description=Security%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/serviceunavailableresponseerrordata.mdx b/client-sdks/python/api-reference/components/serviceunavailableresponseerrordata.mdx deleted file mode 100644 index 71dad29f..00000000 --- a/client-sdks/python/api-reference/components/serviceunavailableresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ServiceUnavailableResponseErrorData - Python SDK -sidebarTitle: ServiceUnavailableResponseErrorData -description: ServiceUnavailableResponseErrorData method reference -seoTitle: ServiceUnavailableResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/serviceunavailableresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseErrorData | OpenRouter Python SDK -'og:description': >- - ServiceUnavailableResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseErrorData%20-%20Python%20SDK&description=ServiceUnavailableResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ServiceUnavailableResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcallitem.mdx b/client-sdks/python/api-reference/components/shellcallitem.mdx deleted file mode 100644 index 30af6c34..00000000 --- a/client-sdks/python/api-reference/components/shellcallitem.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ShellCallItem - Python SDK -sidebarTitle: ShellCallItem -description: ShellCallItem method reference -seoTitle: ShellCallItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/shellcallitem' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItem | OpenRouter Python SDK -'og:description': >- - ShellCallItem method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItem%20-%20Python%20SDK&description=ShellCallItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A shell command execution call (newer variant) - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `action` | [components.ShellCallItemAction](/client-sdks/python/api-reference/components/shellcallitemaction) | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `environment` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [OptionalNullable[components.ShellCallItemStatus]](../components/shellcallitemstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.ShellCallItemType](/client-sdks/python/api-reference/components/shellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcallitemaction.mdx b/client-sdks/python/api-reference/components/shellcallitemaction.mdx deleted file mode 100644 index fe3ccb3b..00000000 --- a/client-sdks/python/api-reference/components/shellcallitemaction.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ShellCallItemAction - Python SDK -sidebarTitle: ShellCallItemAction -description: ShellCallItemAction method reference -seoTitle: ShellCallItemAction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcallitemaction -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemAction | OpenRouter Python SDK -'og:description': >- - ShellCallItemAction method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemAction%20-%20Python%20SDK&description=ShellCallItemAction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `commands` | List[*str*] | :heavy_check_mark: | N/A | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `timeout_ms` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcallitemstatus.mdx b/client-sdks/python/api-reference/components/shellcallitemstatus.mdx deleted file mode 100644 index f2b0ea8b..00000000 --- a/client-sdks/python/api-reference/components/shellcallitemstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ShellCallItemStatus - Python SDK -sidebarTitle: ShellCallItemStatus -description: ShellCallItemStatus method reference -seoTitle: ShellCallItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcallitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemStatus | OpenRouter Python SDK -'og:description': >- - ShellCallItemStatus method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemStatus%20-%20Python%20SDK&description=ShellCallItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcallitemtype.mdx b/client-sdks/python/api-reference/components/shellcallitemtype.mdx deleted file mode 100644 index 418da5d6..00000000 --- a/client-sdks/python/api-reference/components/shellcallitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ShellCallItemType - Python SDK -sidebarTitle: ShellCallItemType -description: ShellCallItemType method reference -seoTitle: ShellCallItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemType | OpenRouter Python SDK -'og:description': >- - ShellCallItemType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemType%20-%20Python%20SDK&description=ShellCallItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `SHELL_CALL` | shell_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcalloutputitem.mdx b/client-sdks/python/api-reference/components/shellcalloutputitem.mdx deleted file mode 100644 index fa06484f..00000000 --- a/client-sdks/python/api-reference/components/shellcalloutputitem.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ShellCallOutputItem - Python SDK -sidebarTitle: ShellCallOutputItem -description: ShellCallOutputItem method reference -seoTitle: ShellCallOutputItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItem | OpenRouter Python SDK -'og:description': >- - ShellCallOutputItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItem%20-%20Python%20SDK&description=ShellCallOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Output from a shell command execution (newer variant) - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `max_output_length` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `output` | List[[components.ShellCallOutputItemOutput](/client-sdks/python/api-reference/components/shellcalloutputitemoutput)] | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ShellCallOutputItemStatus]](../components/shellcalloutputitemstatus.md) | :heavy_minus_sign: | N/A | completed | -| `type` | [components.ShellCallOutputItemType](/client-sdks/python/api-reference/components/shellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcalloutputitemoutput.mdx b/client-sdks/python/api-reference/components/shellcalloutputitemoutput.mdx deleted file mode 100644 index 6ac65be6..00000000 --- a/client-sdks/python/api-reference/components/shellcalloutputitemoutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ShellCallOutputItemOutput - Python SDK -sidebarTitle: ShellCallOutputItemOutput -description: ShellCallOutputItemOutput method reference -seoTitle: ShellCallOutputItemOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcalloutputitemoutput -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemOutput | OpenRouter Python SDK -'og:description': >- - ShellCallOutputItemOutput method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemOutput%20-%20Python%20SDK&description=ShellCallOutputItemOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `exit_code` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `type` | *str* | :heavy_check_mark: | N/A | -| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcalloutputitemstatus.mdx b/client-sdks/python/api-reference/components/shellcalloutputitemstatus.mdx deleted file mode 100644 index 9907b600..00000000 --- a/client-sdks/python/api-reference/components/shellcalloutputitemstatus.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ShellCallOutputItemStatus - Python SDK -sidebarTitle: ShellCallOutputItemStatus -description: ShellCallOutputItemStatus method reference -seoTitle: ShellCallOutputItemStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemStatus | OpenRouter Python SDK -'og:description': >- - ShellCallOutputItemStatus method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemStatus%20-%20Python%20SDK&description=ShellCallOutputItemStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellcalloutputitemtype.mdx b/client-sdks/python/api-reference/components/shellcalloutputitemtype.mdx deleted file mode 100644 index 43f60d18..00000000 --- a/client-sdks/python/api-reference/components/shellcalloutputitemtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ShellCallOutputItemType - Python SDK -sidebarTitle: ShellCallOutputItemType -description: ShellCallOutputItemType method reference -seoTitle: ShellCallOutputItemType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemType | OpenRouter Python SDK -'og:description': >- - ShellCallOutputItemType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemType%20-%20Python%20SDK&description=ShellCallOutputItemType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `SHELL_CALL_OUTPUT` | shell_call_output | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellservertool.mdx b/client-sdks/python/api-reference/components/shellservertool.mdx deleted file mode 100644 index 9af174e6..00000000 --- a/client-sdks/python/api-reference/components/shellservertool.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ShellServerTool - Python SDK -sidebarTitle: ShellServerTool -description: ShellServerTool method reference -seoTitle: ShellServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellservertool -'og:site_name': OpenRouter Documentation -'og:title': ShellServerTool | OpenRouter Python SDK -'og:description': >- - ShellServerTool method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellServerTool%20-%20Python%20SDK&description=ShellServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Shell tool configuration - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.ShellServerToolType](/client-sdks/python/api-reference/components/shellservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/shellservertooltype.mdx b/client-sdks/python/api-reference/components/shellservertooltype.mdx deleted file mode 100644 index 9518aae9..00000000 --- a/client-sdks/python/api-reference/components/shellservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ShellServerToolType - Python SDK -sidebarTitle: ShellServerToolType -description: ShellServerToolType method reference -seoTitle: ShellServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/shellservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ShellServerToolType | OpenRouter Python SDK -'og:description': >- - ShellServerToolType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellServerToolType%20-%20Python%20SDK&description=ShellServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `SHELL` | shell | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/size.mdx b/client-sdks/python/api-reference/components/size.mdx deleted file mode 100644 index c125a13c..00000000 --- a/client-sdks/python/api-reference/components/size.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Size - Python SDK -sidebarTitle: Size -description: Size method reference -seoTitle: Size | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/size' -'og:site_name': OpenRouter Documentation -'og:title': Size | OpenRouter Python SDK -'og:description': >- - Size method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Size%20-%20Python%20SDK&description=Size%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------------------------- | ----------------------------------------------- | -| `ONE_THOUSAND_AND_TWENTY_FOURX1024` | 1024x1024 | -| `ONE_THOUSAND_AND_TWENTY_FOURX1536` | 1024x1536 | -| `ONE_THOUSAND_FIVE_HUNDRED_AND_THIRTY_SIXX1024` | 1536x1024 | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sort.mdx b/client-sdks/python/api-reference/components/sort.mdx deleted file mode 100644 index cc30cadc..00000000 --- a/client-sdks/python/api-reference/components/sort.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Sort - Python SDK -sidebarTitle: Sort -description: Sort method reference -seoTitle: Sort | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sort' -'og:site_name': OpenRouter Documentation -'og:title': Sort | OpenRouter Python SDK -'og:description': >- - Sort method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Sort%20-%20Python%20SDK&description=Sort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `components.ProviderSort` - -```python lines -value: components.ProviderSort = /* values here */ -``` - -### `components.ProviderSortConfig` - -```python lines -value: components.ProviderSortConfig = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sourcecontent.mdx b/client-sdks/python/api-reference/components/sourcecontent.mdx deleted file mode 100644 index 665c7874..00000000 --- a/client-sdks/python/api-reference/components/sourcecontent.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SourceContent - Python SDK -sidebarTitle: SourceContent -description: SourceContent method reference -seoTitle: SourceContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sourcecontent' -'og:site_name': OpenRouter Documentation -'og:title': SourceContent | OpenRouter Python SDK -'og:description': >- - SourceContent method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SourceContent%20-%20Python%20SDK&description=SourceContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content` | [components.AnthropicDocumentBlockParamContent2](/client-sdks/python/api-reference/components/anthropicdocumentblockparamcontent2) | :heavy_check_mark: | N/A | -| `type` | [components.SourceType](/client-sdks/python/api-reference/components/sourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sourcetype.mdx b/client-sdks/python/api-reference/components/sourcetype.mdx deleted file mode 100644 index f84ea314..00000000 --- a/client-sdks/python/api-reference/components/sourcetype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: SourceType - Python SDK -sidebarTitle: SourceType -description: SourceType method reference -seoTitle: SourceType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sourcetype' -'og:site_name': OpenRouter Documentation -'og:title': SourceType | OpenRouter Python SDK -'og:description': >- - SourceType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SourceType%20-%20Python%20SDK&description=SourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `CONTENT` | content | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/speechrequest.mdx b/client-sdks/python/api-reference/components/speechrequest.mdx deleted file mode 100644 index 6ca0909e..00000000 --- a/client-sdks/python/api-reference/components/speechrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: SpeechRequest - Python SDK -sidebarTitle: SpeechRequest -description: SpeechRequest method reference -seoTitle: SpeechRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/speechrequest' -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequest | OpenRouter Python SDK -'og:description': >- - SpeechRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequest%20-%20Python%20SDK&description=SpeechRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text-to-speech request input - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `input` | *str* | :heavy_check_mark: | Text to synthesize | Hello world | -| `model` | *str* | :heavy_check_mark: | TTS model identifier | elevenlabs/eleven-turbo-v2 | -| `provider` | [Optional[components.SpeechRequestProvider]](../components/speechrequestprovider.md) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `response_format` | [Optional[components.ResponseFormatEnum]](../components/responseformatenum.md) | :heavy_minus_sign: | Audio output format | pcm | -| `speed` | *Optional[float]* | :heavy_minus_sign: | Playback speed multiplier. Only used by models that support it (e.g. OpenAI TTS). Ignored by other providers. | 1 | -| `voice` | *str* | :heavy_check_mark: | Voice identifier (provider-specific). | alloy | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/speechrequestprovider.mdx b/client-sdks/python/api-reference/components/speechrequestprovider.mdx deleted file mode 100644 index 68cd9354..00000000 --- a/client-sdks/python/api-reference/components/speechrequestprovider.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SpeechRequestProvider - Python SDK -sidebarTitle: SpeechRequestProvider -description: SpeechRequestProvider method reference -seoTitle: SpeechRequestProvider | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/speechrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequestProvider | OpenRouter Python SDK -'og:description': >- - SpeechRequestProvider method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequestProvider%20-%20Python%20SDK&description=SpeechRequestProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [Optional[components.ProviderOptions]](../components/provideroptions.md) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/speed.mdx b/client-sdks/python/api-reference/components/speed.mdx deleted file mode 100644 index df51d3f2..00000000 --- a/client-sdks/python/api-reference/components/speed.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Speed - Python SDK -sidebarTitle: Speed -description: Speed method reference -seoTitle: Speed | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/speed' -'og:site_name': OpenRouter Documentation -'og:title': Speed | OpenRouter Python SDK -'og:description': >- - Speed method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speed%20-%20Python%20SDK&description=Speed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Controls output generation speed. When set to `fast`, uses a higher-speed inference configuration at premium pricing. Defaults to `standard` when omitted. - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FAST` | fast | -| `STANDARD` | standard | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stance.mdx b/client-sdks/python/api-reference/components/stance.mdx deleted file mode 100644 index c2c80e5d..00000000 --- a/client-sdks/python/api-reference/components/stance.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Stance - Python SDK -sidebarTitle: Stance -description: Stance method reference -seoTitle: Stance | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/stance' -'og:site_name': OpenRouter Documentation -'og:title': Stance | OpenRouter Python SDK -'og:description': >- - Stance method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stance%20-%20Python%20SDK&description=Stance%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *str* | :heavy_check_mark: | N/A | -| `stance` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stop.mdx b/client-sdks/python/api-reference/components/stop.mdx deleted file mode 100644 index 72527858..00000000 --- a/client-sdks/python/api-reference/components/stop.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Stop - Python SDK -sidebarTitle: Stop -description: Stop method reference -seoTitle: Stop | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/stop' -'og:site_name': OpenRouter Documentation -'og:title': Stop | OpenRouter Python SDK -'og:description': >- - Stop method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stop%20-%20Python%20SDK&description=Stop%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop sequences (up to 4) - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhencondition.mdx b/client-sdks/python/api-reference/components/stopservertoolswhencondition.mdx deleted file mode 100644 index d1615789..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhencondition.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: StopServerToolsWhenCondition - Python SDK -sidebarTitle: StopServerToolsWhenCondition -description: StopServerToolsWhenCondition method reference -seoTitle: StopServerToolsWhenCondition | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhencondition -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenCondition | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenCondition method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenCondition%20-%20Python%20SDK&description=StopServerToolsWhenCondition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A single condition that, when met, halts the server-tool agent loop. - -## Supported Types - -### `components.StopServerToolsWhenFinishReasonIs` - -```python lines -value: components.StopServerToolsWhenFinishReasonIs = /* values here */ -``` - -### `components.StopServerToolsWhenHasToolCall` - -```python lines -value: components.StopServerToolsWhenHasToolCall = /* values here */ -``` - -### `components.StopServerToolsWhenMaxCost` - -```python lines -value: components.StopServerToolsWhenMaxCost = /* values here */ -``` - -### `components.StopServerToolsWhenMaxTokensUsed` - -```python lines -value: components.StopServerToolsWhenMaxTokensUsed = /* values here */ -``` - -### `components.StopServerToolsWhenStepCountIs` - -```python lines -value: components.StopServerToolsWhenStepCountIs = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonis.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonis.mdx deleted file mode 100644 index f7e50343..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonis.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenFinishReasonIs - Python SDK -sidebarTitle: StopServerToolsWhenFinishReasonIs -description: StopServerToolsWhenFinishReasonIs method reference -seoTitle: StopServerToolsWhenFinishReasonIs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenfinishreasonis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenFinishReasonIs | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenFinishReasonIs method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenFinishReasonIs%20-%20Python%20SDK&description=StopServerToolsWhenFinishReasonIs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop when the upstream model emits this finish reason (e.g. `length`). - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `reason` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenFinishReasonIsType](/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonistype.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonistype.mdx deleted file mode 100644 index 894ebdfd..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenfinishreasonistype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StopServerToolsWhenFinishReasonIsType - Python SDK -sidebarTitle: StopServerToolsWhenFinishReasonIsType -description: StopServerToolsWhenFinishReasonIsType method reference -seoTitle: StopServerToolsWhenFinishReasonIsType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenfinishreasonistype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenFinishReasonIsType | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenFinishReasonIsType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenFinishReasonIsType%20-%20Python%20SDK&description=StopServerToolsWhenFinishReasonIsType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `FINISH_REASON_IS` | finish_reason_is | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcall.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcall.mdx deleted file mode 100644 index 609d74a8..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcall.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenHasToolCall - Python SDK -sidebarTitle: StopServerToolsWhenHasToolCall -description: StopServerToolsWhenHasToolCall method reference -seoTitle: StopServerToolsWhenHasToolCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenhastoolcall -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenHasToolCall | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenHasToolCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenHasToolCall%20-%20Python%20SDK&description=StopServerToolsWhenHasToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop after a tool with this name has been called. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `tool_name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenHasToolCallType](/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcalltype.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcalltype.mdx deleted file mode 100644 index 39f5e2f5..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenhastoolcalltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StopServerToolsWhenHasToolCallType - Python SDK -sidebarTitle: StopServerToolsWhenHasToolCallType -description: StopServerToolsWhenHasToolCallType method reference -seoTitle: StopServerToolsWhenHasToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenhastoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenHasToolCallType | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenHasToolCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenHasToolCallType%20-%20Python%20SDK&description=StopServerToolsWhenHasToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `HAS_TOOL_CALL` | has_tool_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenmaxcost.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenmaxcost.mdx deleted file mode 100644 index ce3c0aa3..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenmaxcost.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenMaxCost - Python SDK -sidebarTitle: StopServerToolsWhenMaxCost -description: StopServerToolsWhenMaxCost method reference -seoTitle: StopServerToolsWhenMaxCost | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenmaxcost -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxCost | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenMaxCost method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxCost%20-%20Python%20SDK&description=StopServerToolsWhenMaxCost%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop once cumulative cost across the loop exceeds this dollar threshold. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `max_cost_in_dollars` | *float* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenMaxCostType](/client-sdks/python/api-reference/components/stopservertoolswhenmaxcosttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenmaxcosttype.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenmaxcosttype.mdx deleted file mode 100644 index 9e736b80..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenmaxcosttype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StopServerToolsWhenMaxCostType - Python SDK -sidebarTitle: StopServerToolsWhenMaxCostType -description: StopServerToolsWhenMaxCostType method reference -seoTitle: StopServerToolsWhenMaxCostType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenmaxcosttype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxCostType | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenMaxCostType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxCostType%20-%20Python%20SDK&description=StopServerToolsWhenMaxCostType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `MAX_COST` | max_cost | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensused.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensused.mdx deleted file mode 100644 index ffeab62e..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensused.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenMaxTokensUsed - Python SDK -sidebarTitle: StopServerToolsWhenMaxTokensUsed -description: StopServerToolsWhenMaxTokensUsed method reference -seoTitle: StopServerToolsWhenMaxTokensUsed | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenmaxtokensused -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxTokensUsed | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenMaxTokensUsed method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxTokensUsed%20-%20Python%20SDK&description=StopServerToolsWhenMaxTokensUsed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop once cumulative token usage across the loop exceeds this threshold. - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `max_tokens` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenMaxTokensUsedType](/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensusedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensusedtype.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensusedtype.mdx deleted file mode 100644 index 0dd3299a..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenmaxtokensusedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StopServerToolsWhenMaxTokensUsedType - Python SDK -sidebarTitle: StopServerToolsWhenMaxTokensUsedType -description: StopServerToolsWhenMaxTokensUsedType method reference -seoTitle: StopServerToolsWhenMaxTokensUsedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenmaxtokensusedtype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxTokensUsedType | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenMaxTokensUsedType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxTokensUsedType%20-%20Python%20SDK&description=StopServerToolsWhenMaxTokensUsedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `MAX_TOKENS_USED` | max_tokens_used | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenstepcountis.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenstepcountis.mdx deleted file mode 100644 index 95380942..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenstepcountis.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: StopServerToolsWhenStepCountIs - Python SDK -sidebarTitle: StopServerToolsWhenStepCountIs -description: StopServerToolsWhenStepCountIs method reference -seoTitle: StopServerToolsWhenStepCountIs | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenstepcountis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenStepCountIs | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenStepCountIs method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenStepCountIs%20-%20Python%20SDK&description=StopServerToolsWhenStepCountIs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Stop after the agent loop has executed this many steps. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `step_count` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.StopServerToolsWhenStepCountIsType](/client-sdks/python/api-reference/components/stopservertoolswhenstepcountistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/stopservertoolswhenstepcountistype.mdx b/client-sdks/python/api-reference/components/stopservertoolswhenstepcountistype.mdx deleted file mode 100644 index 3d891d69..00000000 --- a/client-sdks/python/api-reference/components/stopservertoolswhenstepcountistype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StopServerToolsWhenStepCountIsType - Python SDK -sidebarTitle: StopServerToolsWhenStepCountIsType -description: StopServerToolsWhenStepCountIsType method reference -seoTitle: StopServerToolsWhenStepCountIsType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/stopservertoolswhenstepcountistype -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenStepCountIsType | OpenRouter Python SDK -'og:description': >- - StopServerToolsWhenStepCountIsType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenStepCountIsType%20-%20Python%20SDK&description=StopServerToolsWhenStepCountIsType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `STEP_COUNT_IS` | step_count_is | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/storedprompttemplate.mdx b/client-sdks/python/api-reference/components/storedprompttemplate.mdx deleted file mode 100644 index fb33b8b1..00000000 --- a/client-sdks/python/api-reference/components/storedprompttemplate.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: StoredPromptTemplate - Python SDK -sidebarTitle: StoredPromptTemplate -description: StoredPromptTemplate method reference -seoTitle: StoredPromptTemplate | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/storedprompttemplate -'og:site_name': OpenRouter Documentation -'og:title': StoredPromptTemplate | OpenRouter Python SDK -'og:description': >- - StoredPromptTemplate method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StoredPromptTemplate%20-%20Python%20SDK&description=StoredPromptTemplate%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `variables` | Dict[str, [components.Variables](/client-sdks/python/api-reference/components/variables)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streamevents.mdx b/client-sdks/python/api-reference/components/streamevents.mdx deleted file mode 100644 index 67c18301..00000000 --- a/client-sdks/python/api-reference/components/streamevents.mdx +++ /dev/null @@ -1,235 +0,0 @@ ---- -title: StreamEvents - Python SDK -sidebarTitle: StreamEvents -description: StreamEvents method reference -seoTitle: StreamEvents | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/streamevents' -'og:site_name': OpenRouter Documentation -'og:title': StreamEvents | OpenRouter Python SDK -'og:description': >- - StreamEvents method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEvents%20-%20Python%20SDK&description=StreamEvents%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Union of all possible event types emitted during response streaming - -## Supported Types - -### `components.ErrorEvent` - -```python lines -value: components.ErrorEvent = /* values here */ -``` - -### `components.ApplyPatchCallOperationDiffDeltaEvent` - -```python lines -value: components.ApplyPatchCallOperationDiffDeltaEvent = /* values here */ -``` - -### `components.ApplyPatchCallOperationDiffDoneEvent` - -```python lines -value: components.ApplyPatchCallOperationDiffDoneEvent = /* values here */ -``` - -### `components.StreamEventsResponseCompleted` - -```python lines -value: components.StreamEventsResponseCompleted = /* values here */ -``` - -### `components.ContentPartAddedEvent` - -```python lines -value: components.ContentPartAddedEvent = /* values here */ -``` - -### `components.ContentPartDoneEvent` - -```python lines -value: components.ContentPartDoneEvent = /* values here */ -``` - -### `components.OpenResponsesCreatedEvent` - -```python lines -value: components.OpenResponsesCreatedEvent = /* values here */ -``` - -### `components.CustomToolCallInputDeltaEvent` - -```python lines -value: components.CustomToolCallInputDeltaEvent = /* values here */ -``` - -### `components.CustomToolCallInputDoneEvent` - -```python lines -value: components.CustomToolCallInputDoneEvent = /* values here */ -``` - -### `components.StreamEventsResponseFailed` - -```python lines -value: components.StreamEventsResponseFailed = /* values here */ -``` - -### `components.FunctionCallArgsDeltaEvent` - -```python lines -value: components.FunctionCallArgsDeltaEvent = /* values here */ -``` - -### `components.FunctionCallArgsDoneEvent` - -```python lines -value: components.FunctionCallArgsDoneEvent = /* values here */ -``` - -### `components.ImageGenCallCompletedEvent` - -```python lines -value: components.ImageGenCallCompletedEvent = /* values here */ -``` - -### `components.ImageGenCallGeneratingEvent` - -```python lines -value: components.ImageGenCallGeneratingEvent = /* values here */ -``` - -### `components.ImageGenCallInProgressEvent` - -```python lines -value: components.ImageGenCallInProgressEvent = /* values here */ -``` - -### `components.ImageGenCallPartialImageEvent` - -```python lines -value: components.ImageGenCallPartialImageEvent = /* values here */ -``` - -### `components.OpenResponsesInProgressEvent` - -```python lines -value: components.OpenResponsesInProgressEvent = /* values here */ -``` - -### `components.StreamEventsResponseIncomplete` - -```python lines -value: components.StreamEventsResponseIncomplete = /* values here */ -``` - -### `components.StreamEventsResponseOutputItemAdded` - -```python lines -value: components.StreamEventsResponseOutputItemAdded = /* values here */ -``` - -### `components.StreamEventsResponseOutputItemDone` - -```python lines -value: components.StreamEventsResponseOutputItemDone = /* values here */ -``` - -### `components.AnnotationAddedEvent` - -```python lines -value: components.AnnotationAddedEvent = /* values here */ -``` - -### `components.TextDeltaEvent` - -```python lines -value: components.TextDeltaEvent = /* values here */ -``` - -### `components.TextDoneEvent` - -```python lines -value: components.TextDoneEvent = /* values here */ -``` - -### `components.ReasoningSummaryPartAddedEvent` - -```python lines -value: components.ReasoningSummaryPartAddedEvent = /* values here */ -``` - -### `components.ReasoningSummaryPartDoneEvent` - -```python lines -value: components.ReasoningSummaryPartDoneEvent = /* values here */ -``` - -### `components.ReasoningSummaryTextDeltaEvent` - -```python lines -value: components.ReasoningSummaryTextDeltaEvent = /* values here */ -``` - -### `components.ReasoningSummaryTextDoneEvent` - -```python lines -value: components.ReasoningSummaryTextDoneEvent = /* values here */ -``` - -### `components.ReasoningDeltaEvent` - -```python lines -value: components.ReasoningDeltaEvent = /* values here */ -``` - -### `components.ReasoningDoneEvent` - -```python lines -value: components.ReasoningDoneEvent = /* values here */ -``` - -### `components.RefusalDeltaEvent` - -```python lines -value: components.RefusalDeltaEvent = /* values here */ -``` - -### `components.RefusalDoneEvent` - -```python lines -value: components.RefusalDoneEvent = /* values here */ -``` - -### `components.WebSearchCallCompletedEvent` - -```python lines -value: components.WebSearchCallCompletedEvent = /* values here */ -``` - -### `components.WebSearchCallInProgressEvent` - -```python lines -value: components.WebSearchCallInProgressEvent = /* values here */ -``` - -### `components.WebSearchCallSearchingEvent` - -```python lines -value: components.WebSearchCallSearchingEvent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponsecompleted.mdx b/client-sdks/python/api-reference/components/streameventsresponsecompleted.mdx deleted file mode 100644 index e015d749..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponsecompleted.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseCompleted - Python SDK -sidebarTitle: StreamEventsResponseCompleted -description: StreamEventsResponseCompleted method reference -seoTitle: StreamEventsResponseCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponsecompleted -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseCompleted | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseCompleted method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseCompleted%20-%20Python%20SDK&description=StreamEventsResponseCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has completed successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](/client-sdks/python/api-reference/components/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"completed_at": 1704067210,"created_at": 1704067200,"error": 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,"status": "completed","temperature": null,"tool_choice": "auto","tools": [],"top_p": null}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseCompletedType](/client-sdks/python/api-reference/components/streameventsresponsecompletedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponsecompletedtype.mdx b/client-sdks/python/api-reference/components/streameventsresponsecompletedtype.mdx deleted file mode 100644 index eaec5008..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponsecompletedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StreamEventsResponseCompletedType - Python SDK -sidebarTitle: StreamEventsResponseCompletedType -description: StreamEventsResponseCompletedType method reference -seoTitle: StreamEventsResponseCompletedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponsecompletedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseCompletedType | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseCompletedType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseCompletedType%20-%20Python%20SDK&description=StreamEventsResponseCompletedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `RESPONSE_COMPLETED` | response.completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponsefailed.mdx b/client-sdks/python/api-reference/components/streameventsresponsefailed.mdx deleted file mode 100644 index 3fcff02a..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponsefailed.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseFailed - Python SDK -sidebarTitle: StreamEventsResponseFailed -description: StreamEventsResponseFailed method reference -seoTitle: StreamEventsResponseFailed | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponsefailed -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseFailed | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseFailed method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseFailed%20-%20Python%20SDK&description=StreamEventsResponseFailed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has failed - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](/client-sdks/python/api-reference/components/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"completed_at": 1704067210,"created_at": 1704067200,"error": 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,"status": "completed","temperature": null,"tool_choice": "auto","tools": [],"top_p": null}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseFailedType](/client-sdks/python/api-reference/components/streameventsresponsefailedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponsefailedtype.mdx b/client-sdks/python/api-reference/components/streameventsresponsefailedtype.mdx deleted file mode 100644 index 61f21413..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponsefailedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StreamEventsResponseFailedType - Python SDK -sidebarTitle: StreamEventsResponseFailedType -description: StreamEventsResponseFailedType method reference -seoTitle: StreamEventsResponseFailedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponsefailedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseFailedType | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseFailedType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseFailedType%20-%20Python%20SDK&description=StreamEventsResponseFailedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `RESPONSE_FAILED` | response.failed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseincomplete.mdx b/client-sdks/python/api-reference/components/streameventsresponseincomplete.mdx deleted file mode 100644 index f071ed31..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseincomplete.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamEventsResponseIncomplete - Python SDK -sidebarTitle: StreamEventsResponseIncomplete -description: StreamEventsResponseIncomplete method reference -seoTitle: StreamEventsResponseIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseincomplete -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseIncomplete | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseIncomplete method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseIncomplete%20-%20Python%20SDK&description=StreamEventsResponseIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is incomplete - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [components.OpenResponsesResult](/client-sdks/python/api-reference/components/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"completed_at": 1704067210,"created_at": 1704067200,"error": 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,"status": "completed","temperature": null,"tool_choice": "auto","tools": [],"top_p": null}` | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseIncompleteType](/client-sdks/python/api-reference/components/streameventsresponseincompletetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseincompletetype.mdx b/client-sdks/python/api-reference/components/streameventsresponseincompletetype.mdx deleted file mode 100644 index c59bad4c..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseincompletetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StreamEventsResponseIncompleteType - Python SDK -sidebarTitle: StreamEventsResponseIncompleteType -description: StreamEventsResponseIncompleteType method reference -seoTitle: StreamEventsResponseIncompleteType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseincompletetype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseIncompleteType | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseIncompleteType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseIncompleteType%20-%20Python%20SDK&description=StreamEventsResponseIncompleteType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `RESPONSE_INCOMPLETE` | response.incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseoutputitemadded.mdx b/client-sdks/python/api-reference/components/streameventsresponseoutputitemadded.mdx deleted file mode 100644 index a0ce56eb..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseoutputitemadded.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: StreamEventsResponseOutputItemAdded - Python SDK -sidebarTitle: StreamEventsResponseOutputItemAdded -description: StreamEventsResponseOutputItemAdded method reference -seoTitle: StreamEventsResponseOutputItemAdded | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseoutputitemadded -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemAdded | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseOutputItemAdded method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemAdded%20-%20Python%20SDK&description=StreamEventsResponseOutputItemAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a new output item is added to the response - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | [components.OutputItems](/client-sdks/python/api-reference/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"
\} | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseOutputItemAddedType](/client-sdks/python/api-reference/components/streameventsresponseoutputitemaddedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseoutputitemaddedtype.mdx b/client-sdks/python/api-reference/components/streameventsresponseoutputitemaddedtype.mdx deleted file mode 100644 index ec59266d..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseoutputitemaddedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StreamEventsResponseOutputItemAddedType - Python SDK -sidebarTitle: StreamEventsResponseOutputItemAddedType -description: StreamEventsResponseOutputItemAddedType method reference -seoTitle: StreamEventsResponseOutputItemAddedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseoutputitemaddedtype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemAddedType | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseOutputItemAddedType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemAddedType%20-%20Python%20SDK&description=StreamEventsResponseOutputItemAddedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_OUTPUT_ITEM_ADDED` | response.output_item.added | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseoutputitemdone.mdx b/client-sdks/python/api-reference/components/streameventsresponseoutputitemdone.mdx deleted file mode 100644 index 3334f438..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseoutputitemdone.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: StreamEventsResponseOutputItemDone - Python SDK -sidebarTitle: StreamEventsResponseOutputItemDone -description: StreamEventsResponseOutputItemDone method reference -seoTitle: StreamEventsResponseOutputItemDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseoutputitemdone -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemDone | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseOutputItemDone method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemDone%20-%20Python%20SDK&description=StreamEventsResponseOutputItemDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when an output item is complete - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | [components.OutputItems](/client-sdks/python/api-reference/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"
\} | -| `output_index` | *int* | :heavy_check_mark: | N/A | | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | | -| `type` | [components.StreamEventsResponseOutputItemDoneType](/client-sdks/python/api-reference/components/streameventsresponseoutputitemdonetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streameventsresponseoutputitemdonetype.mdx b/client-sdks/python/api-reference/components/streameventsresponseoutputitemdonetype.mdx deleted file mode 100644 index ba45937e..00000000 --- a/client-sdks/python/api-reference/components/streameventsresponseoutputitemdonetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: StreamEventsResponseOutputItemDoneType - Python SDK -sidebarTitle: StreamEventsResponseOutputItemDoneType -description: StreamEventsResponseOutputItemDoneType method reference -seoTitle: StreamEventsResponseOutputItemDoneType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streameventsresponseoutputitemdonetype -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemDoneType | OpenRouter Python SDK -'og:description': >- - StreamEventsResponseOutputItemDoneType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemDoneType%20-%20Python%20SDK&description=StreamEventsResponseOutputItemDoneType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `RESPONSE_OUTPUT_ITEM_DONE` | response.output_item.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streamlogprob.mdx b/client-sdks/python/api-reference/components/streamlogprob.mdx deleted file mode 100644 index 0668e155..00000000 --- a/client-sdks/python/api-reference/components/streamlogprob.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamLogprob - Python SDK -sidebarTitle: StreamLogprob -description: StreamLogprob method reference -seoTitle: StreamLogprob | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/streamlogprob' -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprob | OpenRouter Python SDK -'og:description': >- - StreamLogprob method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprob%20-%20Python%20SDK&description=StreamLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Log probability information for a token - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.StreamLogprobTopLogprob](/client-sdks/python/api-reference/components/streamlogprobtoplogprob)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/streamlogprobtoplogprob.mdx b/client-sdks/python/api-reference/components/streamlogprobtoplogprob.mdx deleted file mode 100644 index db63dd01..00000000 --- a/client-sdks/python/api-reference/components/streamlogprobtoplogprob.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: StreamLogprobTopLogprob - Python SDK -sidebarTitle: StreamLogprobTopLogprob -description: StreamLogprobTopLogprob method reference -seoTitle: StreamLogprobTopLogprob | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/streamlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprobTopLogprob | OpenRouter Python SDK -'og:description': >- - StreamLogprobTopLogprob method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprobTopLogprob%20-%20Python%20SDK&description=StreamLogprobTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Alternative token with its log probability - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes_` | List[*int*] | :heavy_minus_sign: | N/A | -| `logprob` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sttinputaudio.mdx b/client-sdks/python/api-reference/components/sttinputaudio.mdx deleted file mode 100644 index abe18e07..00000000 --- a/client-sdks/python/api-reference/components/sttinputaudio.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: STTInputAudio - Python SDK -sidebarTitle: STTInputAudio -description: STTInputAudio method reference -seoTitle: STTInputAudio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sttinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': STTInputAudio | OpenRouter Python SDK -'og:description': >- - STTInputAudio method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTInputAudio%20-%20Python%20SDK&description=STTInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Base64-encoded audio to transcribe - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `format_` | *str* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sttrequest.mdx b/client-sdks/python/api-reference/components/sttrequest.mdx deleted file mode 100644 index 40b6a278..00000000 --- a/client-sdks/python/api-reference/components/sttrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: STTRequest - Python SDK -sidebarTitle: STTRequest -description: STTRequest method reference -seoTitle: STTRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sttrequest' -'og:site_name': OpenRouter Documentation -'og:title': STTRequest | OpenRouter Python SDK -'og:description': >- - STTRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequest%20-%20Python%20SDK&description=STTRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Speech-to-text request input. Accepts a JSON body with input_audio containing base64-encoded audio. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `input_audio` | [components.STTInputAudio](/client-sdks/python/api-reference/components/sttinputaudio) | :heavy_check_mark: | Base64-encoded audio to transcribe | `{"data": "UklGRiQA...","format": "wav"}` | -| `language` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `provider` | [Optional[components.STTRequestProvider]](../components/sttrequestprovider.md) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sttrequestprovider.mdx b/client-sdks/python/api-reference/components/sttrequestprovider.mdx deleted file mode 100644 index b3344775..00000000 --- a/client-sdks/python/api-reference/components/sttrequestprovider.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: STTRequestProvider - Python SDK -sidebarTitle: STTRequestProvider -description: STTRequestProvider method reference -seoTitle: STTRequestProvider | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/sttrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': STTRequestProvider | OpenRouter Python SDK -'og:description': >- - STTRequestProvider method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequestProvider%20-%20Python%20SDK&description=STTRequestProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [Optional[components.ProviderOptions]](../components/provideroptions.md) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sttresponse.mdx b/client-sdks/python/api-reference/components/sttresponse.mdx deleted file mode 100644 index 25e399cf..00000000 --- a/client-sdks/python/api-reference/components/sttresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: STTResponse - Python SDK -sidebarTitle: STTResponse -description: STTResponse method reference -seoTitle: STTResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sttresponse' -'og:site_name': OpenRouter Documentation -'og:title': STTResponse | OpenRouter Python SDK -'og:description': >- - STTResponse method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTResponse%20-%20Python%20SDK&description=STTResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -STT response containing transcribed text and optional usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `text` | *str* | :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` | [Optional[components.STTUsage]](../components/sttusage.md) | :heavy_minus_sign: | Aggregated usage statistics for the request | `{"cost": 0.000508,"input_tokens": 83,"output_tokens": 30,"seconds": 9.2,"total_tokens": 113}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/sttusage.mdx b/client-sdks/python/api-reference/components/sttusage.mdx deleted file mode 100644 index d8dcc74b..00000000 --- a/client-sdks/python/api-reference/components/sttusage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: STTUsage - Python SDK -sidebarTitle: STTUsage -description: STTUsage method reference -seoTitle: STTUsage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/sttusage' -'og:site_name': OpenRouter Documentation -'og:title': STTUsage | OpenRouter Python SDK -'og:description': >- - STTUsage method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTUsage%20-%20Python%20SDK&description=STTUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Aggregated usage statistics for the request - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `input_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `output_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `seconds` | *Optional[float]* | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/supportedaspectratio.mdx b/client-sdks/python/api-reference/components/supportedaspectratio.mdx deleted file mode 100644 index 9e087cbf..00000000 --- a/client-sdks/python/api-reference/components/supportedaspectratio.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: SupportedAspectRatio - Python SDK -sidebarTitle: SupportedAspectRatio -description: SupportedAspectRatio method reference -seoTitle: SupportedAspectRatio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/supportedaspectratio -'og:site_name': OpenRouter Documentation -'og:title': SupportedAspectRatio | OpenRouter Python SDK -'og:description': >- - SupportedAspectRatio method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedAspectRatio%20-%20Python%20SDK&description=SupportedAspectRatio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `ONE_HUNDRED_AND_SIXTY_NINE` | 16:9 | -| `NINE_HUNDRED_AND_SIXTEEN` | 9:16 | -| `ELEVEN` | 1:1 | -| `FORTY_THREE` | 4:3 | -| `THIRTY_FOUR` | 3:4 | -| `THIRTY_TWO` | 3:2 | -| `TWENTY_THREE` | 2:3 | -| `TWO_HUNDRED_AND_NINETEEN` | 21:9 | -| `NINE_HUNDRED_AND_TWENTY_ONE` | 9:21 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/supportedframeimage.mdx b/client-sdks/python/api-reference/components/supportedframeimage.mdx deleted file mode 100644 index c61d5045..00000000 --- a/client-sdks/python/api-reference/components/supportedframeimage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: SupportedFrameImage - Python SDK -sidebarTitle: SupportedFrameImage -description: SupportedFrameImage method reference -seoTitle: SupportedFrameImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/supportedframeimage -'og:site_name': OpenRouter Documentation -'og:title': SupportedFrameImage | OpenRouter Python SDK -'og:description': >- - SupportedFrameImage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedFrameImage%20-%20Python%20SDK&description=SupportedFrameImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `FIRST_FRAME` | first_frame | -| `LAST_FRAME` | last_frame | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/supportedresolution.mdx b/client-sdks/python/api-reference/components/supportedresolution.mdx deleted file mode 100644 index 55a4d0ad..00000000 --- a/client-sdks/python/api-reference/components/supportedresolution.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: SupportedResolution - Python SDK -sidebarTitle: SupportedResolution -description: SupportedResolution method reference -seoTitle: SupportedResolution | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/supportedresolution -'og:site_name': OpenRouter Documentation -'og:title': SupportedResolution | OpenRouter Python SDK -'og:description': >- - SupportedResolution method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedResolution%20-%20Python%20SDK&description=SupportedResolution%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `FOUR_HUNDRED_AND_EIGHTYP` | 480p | -| `SEVEN_HUNDRED_AND_TWENTYP` | 720p | -| `ONE_THOUSAND_AND_EIGHTYP` | 1080p | -| `ONE_K` | 1K | -| `TWO_K` | 2K | -| `FOUR_K` | 4K | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/supportedsize.mdx b/client-sdks/python/api-reference/components/supportedsize.mdx deleted file mode 100644 index 2e1d52ae..00000000 --- a/client-sdks/python/api-reference/components/supportedsize.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: SupportedSize - Python SDK -sidebarTitle: SupportedSize -description: SupportedSize method reference -seoTitle: SupportedSize | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/supportedsize' -'og:site_name': OpenRouter Documentation -'og:title': SupportedSize | OpenRouter Python SDK -'og:description': >- - SupportedSize method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedSize%20-%20Python%20SDK&description=SupportedSize%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `FOUR_HUNDRED_AND_EIGHTYX480` | 480x480 | -| `FOUR_HUNDRED_AND_EIGHTYX640` | 480x640 | -| `FOUR_HUNDRED_AND_EIGHTYX720` | 480x720 | -| `FOUR_HUNDRED_AND_EIGHTYX854` | 480x854 | -| `FOUR_HUNDRED_AND_EIGHTYX1120` | 480x1120 | -| `SIX_HUNDRED_AND_FORTYX480` | 640x480 | -| `SEVEN_HUNDRED_AND_TWENTYX480` | 720x480 | -| `SEVEN_HUNDRED_AND_TWENTYX720` | 720x720 | -| `SEVEN_HUNDRED_AND_TWENTYX960` | 720x960 | -| `SEVEN_HUNDRED_AND_TWENTYX1080` | 720x1080 | -| `SEVEN_HUNDRED_AND_TWENTYX1280` | 720x1280 | -| `SEVEN_HUNDRED_AND_TWENTYX1680` | 720x1680 | -| `EIGHT_HUNDRED_AND_FIFTY_FOURX480` | 854x480 | -| `NINE_HUNDRED_AND_SIXTYX720` | 960x720 | -| `ONE_THOUSAND_AND_EIGHTYX720` | 1080x720 | -| `ONE_THOUSAND_AND_EIGHTYX1080` | 1080x1080 | -| `ONE_THOUSAND_AND_EIGHTYX1440` | 1080x1440 | -| `ONE_THOUSAND_AND_EIGHTYX1620` | 1080x1620 | -| `ONE_THOUSAND_AND_EIGHTYX1920` | 1080x1920 | -| `ONE_THOUSAND_AND_EIGHTYX2520` | 1080x2520 | -| `ONE_THOUSAND_ONE_HUNDRED_AND_TWENTYX480` | 1120x480 | -| `ONE_THOUSAND_TWO_HUNDRED_AND_EIGHTYX720` | 1280x720 | -| `ONE_THOUSAND_FOUR_HUNDRED_AND_FORTYX1080` | 1440x1080 | -| `ONE_THOUSAND_SIX_HUNDRED_AND_TWENTYX1080` | 1620x1080 | -| `ONE_THOUSAND_SIX_HUNDRED_AND_EIGHTYX720` | 1680x720 | -| `ONE_THOUSAND_NINE_HUNDRED_AND_TWENTYX1080` | 1920x1080 | -| `TWO_THOUSAND_ONE_HUNDRED_AND_SIXTYX2160` | 2160x2160 | -| `TWO_THOUSAND_ONE_HUNDRED_AND_SIXTYX2880` | 2160x2880 | -| `TWO_THOUSAND_ONE_HUNDRED_AND_SIXTYX3240` | 2160x3240 | -| `TWO_THOUSAND_ONE_HUNDRED_AND_SIXTYX3840` | 2160x3840 | -| `TWO_THOUSAND_ONE_HUNDRED_AND_SIXTYX5040` | 2160x5040 | -| `TWO_THOUSAND_FIVE_HUNDRED_AND_TWENTYX1080` | 2520x1080 | -| `TWO_THOUSAND_EIGHT_HUNDRED_AND_EIGHTYX2160` | 2880x2160 | -| `THREE_THOUSAND_TWO_HUNDRED_AND_FORTYX2160` | 3240x2160 | -| `THREE_THOUSAND_EIGHT_HUNDRED_AND_FORTYX2160` | 3840x2160 | -| `FIVE_THOUSAND_AND_FORTYX2160` | 5040x2160 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/syntax.mdx b/client-sdks/python/api-reference/components/syntax.mdx deleted file mode 100644 index 5890c0b5..00000000 --- a/client-sdks/python/api-reference/components/syntax.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Syntax - Python SDK -sidebarTitle: Syntax -description: Syntax method reference -seoTitle: Syntax | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/syntax' -'og:site_name': OpenRouter Documentation -'og:title': Syntax | OpenRouter Python SDK -'og:description': >- - Syntax method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Syntax%20-%20Python%20SDK&description=Syntax%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `LARK` | lark | -| `REGEX` | regex | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/system.mdx b/client-sdks/python/api-reference/components/system.mdx deleted file mode 100644 index 188953fd..00000000 --- a/client-sdks/python/api-reference/components/system.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: System - Python SDK -sidebarTitle: System -description: System method reference -seoTitle: System | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/system' -'og:site_name': OpenRouter Documentation -'og:title': System | OpenRouter Python SDK -'og:description': >- - System method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=System%20-%20Python%20SDK&description=System%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.AnthropicTextBlockParam]` - -```python lines -value: List[components.AnthropicTextBlockParam] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/taskbudget.mdx b/client-sdks/python/api-reference/components/taskbudget.mdx deleted file mode 100644 index 1c0a1c1c..00000000 --- a/client-sdks/python/api-reference/components/taskbudget.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TaskBudget - Python SDK -sidebarTitle: TaskBudget -description: TaskBudget method reference -seoTitle: TaskBudget | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/taskbudget' -'og:site_name': OpenRouter Documentation -'og:title': TaskBudget | OpenRouter Python SDK -'og:description': >- - TaskBudget method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TaskBudget%20-%20Python%20SDK&description=TaskBudget%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `remaining` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `total` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.TypeTokens](/client-sdks/python/api-reference/components/typetokens) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/textdeltaevent.mdx b/client-sdks/python/api-reference/components/textdeltaevent.mdx deleted file mode 100644 index d96c93df..00000000 --- a/client-sdks/python/api-reference/components/textdeltaevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TextDeltaEvent - Python SDK -sidebarTitle: TextDeltaEvent -description: TextDeltaEvent method reference -seoTitle: TextDeltaEvent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/textdeltaevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDeltaEvent | OpenRouter Python SDK -'og:description': >- - TextDeltaEvent method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDeltaEvent%20-%20Python%20SDK&description=TextDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.StreamLogprob](/client-sdks/python/api-reference/components/streamlogprob)] | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.TextDeltaEventType](/client-sdks/python/api-reference/components/textdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/textdeltaeventtype.mdx b/client-sdks/python/api-reference/components/textdeltaeventtype.mdx deleted file mode 100644 index 5f6a86ef..00000000 --- a/client-sdks/python/api-reference/components/textdeltaeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TextDeltaEventType - Python SDK -sidebarTitle: TextDeltaEventType -description: TextDeltaEventType method reference -seoTitle: TextDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/textdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': TextDeltaEventType | OpenRouter Python SDK -'og:description': >- - TextDeltaEventType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDeltaEventType%20-%20Python%20SDK&description=TextDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_OUTPUT_TEXT_DELTA` | response.output_text.delta | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/textdoneevent.mdx b/client-sdks/python/api-reference/components/textdoneevent.mdx deleted file mode 100644 index 069b18ad..00000000 --- a/client-sdks/python/api-reference/components/textdoneevent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TextDoneEvent - Python SDK -sidebarTitle: TextDoneEvent -description: TextDoneEvent method reference -seoTitle: TextDoneEvent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/textdoneevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDoneEvent | OpenRouter Python SDK -'og:description': >- - TextDoneEvent method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDoneEvent%20-%20Python%20SDK&description=TextDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content_index` | *int* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.StreamLogprob](/client-sdks/python/api-reference/components/streamlogprob)] | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TextDoneEventType](/client-sdks/python/api-reference/components/textdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/textdoneeventtype.mdx b/client-sdks/python/api-reference/components/textdoneeventtype.mdx deleted file mode 100644 index f88bce7a..00000000 --- a/client-sdks/python/api-reference/components/textdoneeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TextDoneEventType - Python SDK -sidebarTitle: TextDoneEventType -description: TextDoneEventType method reference -seoTitle: TextDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/textdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': TextDoneEventType | OpenRouter Python SDK -'og:description': >- - TextDoneEventType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDoneEventType%20-%20Python%20SDK&description=TextDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `RESPONSE_OUTPUT_TEXT_DONE` | response.output_text.done | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/textextendedconfig.mdx b/client-sdks/python/api-reference/components/textextendedconfig.mdx deleted file mode 100644 index 5f52455d..00000000 --- a/client-sdks/python/api-reference/components/textextendedconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TextExtendedConfig - Python SDK -sidebarTitle: TextExtendedConfig -description: TextExtendedConfig method reference -seoTitle: TextExtendedConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/textextendedconfig -'og:site_name': OpenRouter Documentation -'og:title': TextExtendedConfig | OpenRouter Python SDK -'og:description': >- - TextExtendedConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextExtendedConfig%20-%20Python%20SDK&description=TextExtendedConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `format_` | [Optional[components.Formats]](../components/formats.md) | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [OptionalNullable[components.Verbosity]](../components/verbosity.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/thinking.mdx b/client-sdks/python/api-reference/components/thinking.mdx deleted file mode 100644 index 1efc8efc..00000000 --- a/client-sdks/python/api-reference/components/thinking.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Thinking - Python SDK -sidebarTitle: Thinking -description: Thinking method reference -seoTitle: Thinking | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/thinking' -'og:site_name': OpenRouter Documentation -'og:title': Thinking | OpenRouter Python SDK -'og:description': >- - Thinking method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Thinking%20-%20Python%20SDK&description=Thinking%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ThinkingEnabled` - -```python lines -value: components.ThinkingEnabled = /* values here */ -``` - -### `components.ThinkingDisabled` - -```python lines -value: components.ThinkingDisabled = /* values here */ -``` - -### `components.ThinkingAdaptive` - -```python lines -value: components.ThinkingAdaptive = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/thinkingadaptive.mdx b/client-sdks/python/api-reference/components/thinkingadaptive.mdx deleted file mode 100644 index 1e63ec3c..00000000 --- a/client-sdks/python/api-reference/components/thinkingadaptive.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ThinkingAdaptive - Python SDK -sidebarTitle: ThinkingAdaptive -description: ThinkingAdaptive method reference -seoTitle: ThinkingAdaptive | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/thinkingadaptive -'og:site_name': OpenRouter Documentation -'og:title': ThinkingAdaptive | OpenRouter Python SDK -'og:description': >- - ThinkingAdaptive method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingAdaptive%20-%20Python%20SDK&description=ThinkingAdaptive%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.md) | :heavy_minus_sign: | N/A | summarized | -| `type` | [components.TypeAdaptive](/client-sdks/python/api-reference/components/typeadaptive) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/thinkingdisabled.mdx b/client-sdks/python/api-reference/components/thinkingdisabled.mdx deleted file mode 100644 index 68c138d2..00000000 --- a/client-sdks/python/api-reference/components/thinkingdisabled.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ThinkingDisabled - Python SDK -sidebarTitle: ThinkingDisabled -description: ThinkingDisabled method reference -seoTitle: ThinkingDisabled | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/thinkingdisabled -'og:site_name': OpenRouter Documentation -'og:title': ThinkingDisabled | OpenRouter Python SDK -'og:description': >- - ThinkingDisabled method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingDisabled%20-%20Python%20SDK&description=ThinkingDisabled%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `type` | [components.TypeDisabled](/client-sdks/python/api-reference/components/typedisabled) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/thinkingenabled.mdx b/client-sdks/python/api-reference/components/thinkingenabled.mdx deleted file mode 100644 index ab762407..00000000 --- a/client-sdks/python/api-reference/components/thinkingenabled.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ThinkingEnabled - Python SDK -sidebarTitle: ThinkingEnabled -description: ThinkingEnabled method reference -seoTitle: ThinkingEnabled | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/thinkingenabled -'og:site_name': OpenRouter Documentation -'og:title': ThinkingEnabled | OpenRouter Python SDK -'og:description': >- - ThinkingEnabled method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingEnabled%20-%20Python%20SDK&description=ThinkingEnabled%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `budget_tokens` | *int* | :heavy_check_mark: | N/A | | -| `display` | [OptionalNullable[components.AnthropicThinkingDisplay]](../components/anthropicthinkingdisplay.md) | :heavy_minus_sign: | N/A | summarized | -| `type` | [components.TypeEnabled](/client-sdks/python/api-reference/components/typeenabled) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/tokenizer.mdx b/client-sdks/python/api-reference/components/tokenizer.mdx deleted file mode 100644 index 97a654ed..00000000 --- a/client-sdks/python/api-reference/components/tokenizer.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Tokenizer - Python SDK -sidebarTitle: Tokenizer -description: Tokenizer method reference -seoTitle: Tokenizer | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/tokenizer' -'og:site_name': OpenRouter Documentation -'og:title': Tokenizer | OpenRouter Python SDK -'og:description': >- - Tokenizer method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Tokenizer%20-%20Python%20SDK&description=Tokenizer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ROUTER` | Router | -| `MEDIA` | Media | -| `OTHER` | Other | -| `GPT` | GPT | -| `CLAUDE` | Claude | -| `GEMINI` | Gemini | -| `GEMMA` | Gemma | -| `GROK` | Grok | -| `COHERE` | Cohere | -| `NOVA` | Nova | -| `QWEN` | Qwen | -| `YI` | Yi | -| `DEEP_SEEK` | DeepSeek | -| `MISTRAL` | Mistral | -| `LLAMA2` | Llama2 | -| `LLAMA3` | Llama3 | -| `LLAMA4` | Llama4 | -| `PA_LM` | PaLM | -| `RWKV` | RWKV | -| `QWEN3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/tooladvisor20260301.mdx b/client-sdks/python/api-reference/components/tooladvisor20260301.mdx deleted file mode 100644 index bfb87684..00000000 --- a/client-sdks/python/api-reference/components/tooladvisor20260301.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ToolAdvisor20260301 - Python SDK -sidebarTitle: ToolAdvisor20260301 -description: ToolAdvisor20260301 method reference -seoTitle: ToolAdvisor20260301 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/tooladvisor20260301 -'og:site_name': OpenRouter Documentation -'og:title': ToolAdvisor20260301 | OpenRouter Python SDK -'og:description': >- - ToolAdvisor20260301 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolAdvisor20260301%20-%20Python%20SDK&description=ToolAdvisor20260301%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](/client-sdks/python/api-reference/components/anthropicallowedcallers)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `caching` | [OptionalNullable[components.Caching]](../components/caching.md) | :heavy_minus_sign: | N/A | `{"type": "ephemeral"}` | -| `defer_loading` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `max_uses` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `name` | [components.NameAdvisor](/client-sdks/python/api-reference/components/nameadvisor) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeAdvisor20260301](/client-sdks/python/api-reference/components/typeadvisor20260301) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolbash20250124.mdx b/client-sdks/python/api-reference/components/toolbash20250124.mdx deleted file mode 100644 index 1968ea30..00000000 --- a/client-sdks/python/api-reference/components/toolbash20250124.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ToolBash20250124 - Python SDK -sidebarTitle: ToolBash20250124 -description: ToolBash20250124 method reference -seoTitle: ToolBash20250124 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolbash20250124 -'og:site_name': OpenRouter Documentation -'og:title': ToolBash20250124 | OpenRouter Python SDK -'og:description': >- - ToolBash20250124 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolBash20250124%20-%20Python%20SDK&description=ToolBash20250124%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `name` | [components.NameBash](/client-sdks/python/api-reference/components/namebash) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeBash20250124](/client-sdks/python/api-reference/components/typebash20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolcallstatus.mdx b/client-sdks/python/api-reference/components/toolcallstatus.mdx deleted file mode 100644 index bcc723fb..00000000 --- a/client-sdks/python/api-reference/components/toolcallstatus.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolCallStatus - Python SDK -sidebarTitle: ToolCallStatus -description: ToolCallStatus method reference -seoTitle: ToolCallStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ToolCallStatus | OpenRouter Python SDK -'og:description': >- - ToolCallStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCallStatus%20-%20Python%20SDK&description=ToolCallStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoice.mdx b/client-sdks/python/api-reference/components/toolchoice.mdx deleted file mode 100644 index 2fe5fce6..00000000 --- a/client-sdks/python/api-reference/components/toolchoice.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ToolChoice - Python SDK -sidebarTitle: ToolChoice -description: ToolChoice method reference -seoTitle: ToolChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoice | OpenRouter Python SDK -'og:description': >- - ToolChoice method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoice%20-%20Python%20SDK&description=ToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ToolChoiceAuto` - -```python lines -value: components.ToolChoiceAuto = /* values here */ -``` - -### `components.ToolChoiceAny` - -```python lines -value: components.ToolChoiceAny = /* values here */ -``` - -### `components.ToolChoiceNone` - -```python lines -value: components.ToolChoiceNone = /* values here */ -``` - -### `components.ToolChoiceTool` - -```python lines -value: components.ToolChoiceTool = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoiceallowed.mdx b/client-sdks/python/api-reference/components/toolchoiceallowed.mdx deleted file mode 100644 index cffaa6d1..00000000 --- a/client-sdks/python/api-reference/components/toolchoiceallowed.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ToolChoiceAllowed - Python SDK -sidebarTitle: ToolChoiceAllowed -description: ToolChoiceAllowed method reference -seoTitle: ToolChoiceAllowed | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolchoiceallowed -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowed | OpenRouter Python SDK -'og:description': >- - ToolChoiceAllowed method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowed%20-%20Python%20SDK&description=ToolChoiceAllowed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Constrains the model to a pre-defined set of allowed tools - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `mode` | [components.Mode](/client-sdks/python/api-reference/components/mode) | :heavy_check_mark: | N/A | -| `tools` | List[Dict[str, *Nullable[Any]*]] | :heavy_check_mark: | N/A | -| `type` | [components.ToolChoiceAllowedType](/client-sdks/python/api-reference/components/toolchoiceallowedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoiceallowedtype.mdx b/client-sdks/python/api-reference/components/toolchoiceallowedtype.mdx deleted file mode 100644 index 83175712..00000000 --- a/client-sdks/python/api-reference/components/toolchoiceallowedtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceAllowedType - Python SDK -sidebarTitle: ToolChoiceAllowedType -description: ToolChoiceAllowedType method reference -seoTitle: ToolChoiceAllowedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolchoiceallowedtype -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowedType | OpenRouter Python SDK -'og:description': >- - ToolChoiceAllowedType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowedType%20-%20Python%20SDK&description=ToolChoiceAllowedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `ALLOWED_TOOLS` | allowed_tools | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoiceany.mdx b/client-sdks/python/api-reference/components/toolchoiceany.mdx deleted file mode 100644 index aae44702..00000000 --- a/client-sdks/python/api-reference/components/toolchoiceany.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceAny - Python SDK -sidebarTitle: ToolChoiceAny -description: ToolChoiceAny method reference -seoTitle: ToolChoiceAny | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolchoiceany' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAny | OpenRouter Python SDK -'og:description': >- - ToolChoiceAny method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAny%20-%20Python%20SDK&description=ToolChoiceAny%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.TypeAny](/client-sdks/python/api-reference/components/typeany) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoiceauto.mdx b/client-sdks/python/api-reference/components/toolchoiceauto.mdx deleted file mode 100644 index 2c60cd4a..00000000 --- a/client-sdks/python/api-reference/components/toolchoiceauto.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceAuto - Python SDK -sidebarTitle: ToolChoiceAuto -description: ToolChoiceAuto method reference -seoTitle: ToolChoiceAuto | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolchoiceauto' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAuto | OpenRouter Python SDK -'og:description': >- - ToolChoiceAuto method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAuto%20-%20Python%20SDK&description=ToolChoiceAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `type` | [components.ToolChoiceTypeAuto](/client-sdks/python/api-reference/components/toolchoicetypeauto) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoicenone.mdx b/client-sdks/python/api-reference/components/toolchoicenone.mdx deleted file mode 100644 index 70441bb4..00000000 --- a/client-sdks/python/api-reference/components/toolchoicenone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ToolChoiceNone - Python SDK -sidebarTitle: ToolChoiceNone -description: ToolChoiceNone method reference -seoTitle: ToolChoiceNone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolchoicenone' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceNone | OpenRouter Python SDK -'og:description': >- - ToolChoiceNone method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceNone%20-%20Python%20SDK&description=ToolChoiceNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [components.TypeNone](/client-sdks/python/api-reference/components/typenone) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoicetool.mdx b/client-sdks/python/api-reference/components/toolchoicetool.mdx deleted file mode 100644 index 211c7fbd..00000000 --- a/client-sdks/python/api-reference/components/toolchoicetool.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolChoiceTool - Python SDK -sidebarTitle: ToolChoiceTool -description: ToolChoiceTool method reference -seoTitle: ToolChoiceTool | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolchoicetool' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceTool | OpenRouter Python SDK -'og:description': >- - ToolChoiceTool method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceTool%20-%20Python%20SDK&description=ToolChoiceTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `disable_parallel_tool_use` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.TypeTool](/client-sdks/python/api-reference/components/typetool) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolchoicetypeauto.mdx b/client-sdks/python/api-reference/components/toolchoicetypeauto.mdx deleted file mode 100644 index 7c755a5b..00000000 --- a/client-sdks/python/api-reference/components/toolchoicetypeauto.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolChoiceTypeAuto - Python SDK -sidebarTitle: ToolChoiceTypeAuto -description: ToolChoiceTypeAuto method reference -seoTitle: ToolChoiceTypeAuto | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolchoicetypeauto -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceTypeAuto | OpenRouter Python SDK -'og:description': >- - ToolChoiceTypeAuto method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceTypeAuto%20-%20Python%20SDK&description=ToolChoiceTypeAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolcustom.mdx b/client-sdks/python/api-reference/components/toolcustom.mdx deleted file mode 100644 index 60f2d960..00000000 --- a/client-sdks/python/api-reference/components/toolcustom.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ToolCustom - Python SDK -sidebarTitle: ToolCustom -description: ToolCustom method reference -seoTitle: ToolCustom | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/toolcustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolCustom | OpenRouter Python SDK -'og:description': >- - ToolCustom method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCustom%20-%20Python%20SDK&description=ToolCustom%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `input_schema` | [components.InputSchema](/client-sdks/python/api-reference/components/inputschema) | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `type` | [Optional[components.ToolTypeCustom]](../components/tooltypecustom.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/tooltexteditor20250124.mdx b/client-sdks/python/api-reference/components/tooltexteditor20250124.mdx deleted file mode 100644 index 5f801720..00000000 --- a/client-sdks/python/api-reference/components/tooltexteditor20250124.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ToolTextEditor20250124 - Python SDK -sidebarTitle: ToolTextEditor20250124 -description: ToolTextEditor20250124 method reference -seoTitle: ToolTextEditor20250124 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/tooltexteditor20250124 -'og:site_name': OpenRouter Documentation -'og:title': ToolTextEditor20250124 | OpenRouter Python SDK -'og:description': >- - ToolTextEditor20250124 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTextEditor20250124%20-%20Python%20SDK&description=ToolTextEditor20250124%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `name` | [components.NameStrReplaceEditor](/client-sdks/python/api-reference/components/namestrreplaceeditor) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeTextEditor20250124](/client-sdks/python/api-reference/components/typetexteditor20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/tooltypecustom.mdx b/client-sdks/python/api-reference/components/tooltypecustom.mdx deleted file mode 100644 index e3f84b1b..00000000 --- a/client-sdks/python/api-reference/components/tooltypecustom.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ToolTypeCustom - Python SDK -sidebarTitle: ToolTypeCustom -description: ToolTypeCustom method reference -seoTitle: ToolTypeCustom | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/tooltypecustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeCustom | OpenRouter Python SDK -'og:description': >- - ToolTypeCustom method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeCustom%20-%20Python%20SDK&description=ToolTypeCustom%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `CUSTOM` | custom | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/tooltypeephemeral.mdx b/client-sdks/python/api-reference/components/tooltypeephemeral.mdx deleted file mode 100644 index 65f86cd4..00000000 --- a/client-sdks/python/api-reference/components/tooltypeephemeral.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolTypeEphemeral - Python SDK -sidebarTitle: ToolTypeEphemeral -description: ToolTypeEphemeral method reference -seoTitle: ToolTypeEphemeral | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/tooltypeephemeral -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeEphemeral | OpenRouter Python SDK -'og:description': >- - ToolTypeEphemeral method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeEphemeral%20-%20Python%20SDK&description=ToolTypeEphemeral%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `EPHEMERAL` | ephemeral | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/toolwebsearch20250305.mdx b/client-sdks/python/api-reference/components/toolwebsearch20250305.mdx deleted file mode 100644 index e0087089..00000000 --- a/client-sdks/python/api-reference/components/toolwebsearch20250305.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ToolWebSearch20250305 - Python SDK -sidebarTitle: ToolWebSearch20250305 -description: ToolWebSearch20250305 method reference -seoTitle: ToolWebSearch20250305 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolwebsearch20250305 -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20250305 | OpenRouter Python SDK -'og:description': >- - ToolWebSearch20250305 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20250305%20-%20Python%20SDK&description=ToolWebSearch20250305%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `name` | [components.NameWebSearch1](/client-sdks/python/api-reference/components/namewebsearch1) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeWebSearch20250305](/client-sdks/python/api-reference/components/typewebsearch20250305) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../components/anthropicwebsearchtooluserlocation.md) | :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/client-sdks/python/api-reference/components/toolwebsearch20260209.mdx b/client-sdks/python/api-reference/components/toolwebsearch20260209.mdx deleted file mode 100644 index 17126404..00000000 --- a/client-sdks/python/api-reference/components/toolwebsearch20260209.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ToolWebSearch20260209 - Python SDK -sidebarTitle: ToolWebSearch20260209 -description: ToolWebSearch20260209 method reference -seoTitle: ToolWebSearch20260209 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toolwebsearch20260209 -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20260209 | OpenRouter Python SDK -'og:description': >- - ToolWebSearch20260209 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20260209%20-%20Python%20SDK&description=ToolWebSearch20260209%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_callers` | List[[components.AnthropicAllowedCallers](/client-sdks/python/api-reference/components/anthropicallowedcallers)] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](../components/anthropiccachecontroldirective.md) | :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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `max_uses` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `name` | [components.NameWebSearch2](/client-sdks/python/api-reference/components/namewebsearch2) | :heavy_check_mark: | N/A | | -| `type` | [components.TypeWebSearch20260209](/client-sdks/python/api-reference/components/typewebsearch20260209) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.AnthropicWebSearchToolUserLocation]](../components/anthropicwebsearchtooluserlocation.md) | :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/client-sdks/python/api-reference/components/toomanyrequestsresponseerrordata.mdx b/client-sdks/python/api-reference/components/toomanyrequestsresponseerrordata.mdx deleted file mode 100644 index 927e187e..00000000 --- a/client-sdks/python/api-reference/components/toomanyrequestsresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: TooManyRequestsResponseErrorData - Python SDK -sidebarTitle: TooManyRequestsResponseErrorData -description: TooManyRequestsResponseErrorData method reference -seoTitle: TooManyRequestsResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/toomanyrequestsresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseErrorData | OpenRouter Python SDK -'og:description': >- - TooManyRequestsResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseErrorData%20-%20Python%20SDK&description=TooManyRequestsResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for TooManyRequestsResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/topproviderinfo.mdx b/client-sdks/python/api-reference/components/topproviderinfo.mdx deleted file mode 100644 index d16ec3ff..00000000 --- a/client-sdks/python/api-reference/components/topproviderinfo.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: TopProviderInfo - Python SDK -sidebarTitle: TopProviderInfo -description: TopProviderInfo method reference -seoTitle: TopProviderInfo | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/topproviderinfo -'og:site_name': OpenRouter Documentation -'og:title': TopProviderInfo | OpenRouter Python SDK -'og:description': >- - TopProviderInfo method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TopProviderInfo%20-%20Python%20SDK&description=TopProviderInfo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about the top provider for this model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `context_length` | *OptionalNullable[int]* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `is_moderated` | *bool* | :heavy_check_mark: | Whether the top provider moderates content | true | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum completion tokens from the top provider | 4096 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/traceconfig.mdx b/client-sdks/python/api-reference/components/traceconfig.mdx deleted file mode 100644 index e399c853..00000000 --- a/client-sdks/python/api-reference/components/traceconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: TraceConfig - Python SDK -sidebarTitle: TraceConfig -description: TraceConfig method reference -seoTitle: TraceConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/traceconfig' -'og:site_name': OpenRouter Documentation -'og:title': TraceConfig | OpenRouter Python SDK -'og:description': >- - TraceConfig method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TraceConfig%20-%20Python%20SDK&description=TraceConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `generation_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `parent_span_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `span_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `trace_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `trace_name` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `__pydantic_extra__` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | `{"trace_id": "trace-abc123","trace_name": "my-app-trace"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/trigger.mdx b/client-sdks/python/api-reference/components/trigger.mdx deleted file mode 100644 index 7a45cdae..00000000 --- a/client-sdks/python/api-reference/components/trigger.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Trigger - Python SDK -sidebarTitle: Trigger -description: Trigger method reference -seoTitle: Trigger | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/trigger' -'og:site_name': OpenRouter Documentation -'og:title': Trigger | OpenRouter Python SDK -'og:description': >- - Trigger method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Trigger%20-%20Python%20SDK&description=Trigger%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.AnthropicInputTokensTrigger` - -```python lines -value: components.AnthropicInputTokensTrigger = /* values here */ -``` - -### `components.AnthropicToolUsesTrigger` - -```python lines -value: components.AnthropicToolUsesTrigger = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/triggerinputtokens.mdx b/client-sdks/python/api-reference/components/triggerinputtokens.mdx deleted file mode 100644 index 9dc0b5a5..00000000 --- a/client-sdks/python/api-reference/components/triggerinputtokens.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: TriggerInputTokens - Python SDK -sidebarTitle: TriggerInputTokens -description: TriggerInputTokens method reference -seoTitle: TriggerInputTokens | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/triggerinputtokens -'og:site_name': OpenRouter Documentation -'og:title': TriggerInputTokens | OpenRouter Python SDK -'og:description': >- - TriggerInputTokens method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TriggerInputTokens%20-%20Python%20SDK&description=TriggerInputTokens%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.EditTypeInputTokens](/client-sdks/python/api-reference/components/edittypeinputtokens) | :heavy_check_mark: | N/A | -| `value` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/truncation.mdx b/client-sdks/python/api-reference/components/truncation.mdx deleted file mode 100644 index c3380fc5..00000000 --- a/client-sdks/python/api-reference/components/truncation.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Truncation - Python SDK -sidebarTitle: Truncation -description: Truncation method reference -seoTitle: Truncation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/truncation' -'og:site_name': OpenRouter Documentation -'og:title': Truncation | OpenRouter Python SDK -'og:description': >- - Truncation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Truncation%20-%20Python%20SDK&description=Truncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/type.mdx b/client-sdks/python/api-reference/components/type.mdx deleted file mode 100644 index abc0e932..00000000 --- a/client-sdks/python/api-reference/components/type.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Type - Python SDK -sidebarTitle: Type -description: Type method reference -seoTitle: Type | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/type' -'og:site_name': OpenRouter Documentation -'og:title': Type | OpenRouter Python SDK -'og:description': >- - Type method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Type%20-%20Python%20SDK&description=Type%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311` - -```python lines -value: components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceTypeWebSearchPreview` - -```python lines -value: components.OpenAIResponsesToolChoiceTypeWebSearchPreview = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeadaptive.mdx b/client-sdks/python/api-reference/components/typeadaptive.mdx deleted file mode 100644 index 85642d87..00000000 --- a/client-sdks/python/api-reference/components/typeadaptive.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeAdaptive - Python SDK -sidebarTitle: TypeAdaptive -description: TypeAdaptive method reference -seoTitle: TypeAdaptive | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typeadaptive' -'og:site_name': OpenRouter Documentation -'og:title': TypeAdaptive | OpenRouter Python SDK -'og:description': >- - TypeAdaptive method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAdaptive%20-%20Python%20SDK&description=TypeAdaptive%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ADAPTIVE` | adaptive | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeadvisor20260301.mdx b/client-sdks/python/api-reference/components/typeadvisor20260301.mdx deleted file mode 100644 index a816c863..00000000 --- a/client-sdks/python/api-reference/components/typeadvisor20260301.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeAdvisor20260301 - Python SDK -sidebarTitle: TypeAdvisor20260301 -description: TypeAdvisor20260301 method reference -seoTitle: TypeAdvisor20260301 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typeadvisor20260301 -'og:site_name': OpenRouter Documentation -'og:title': TypeAdvisor20260301 | OpenRouter Python SDK -'og:description': >- - TypeAdvisor20260301 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAdvisor20260301%20-%20Python%20SDK&description=TypeAdvisor20260301%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `ADVISOR_20260301` | advisor_20260301 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeany.mdx b/client-sdks/python/api-reference/components/typeany.mdx deleted file mode 100644 index 42ab4644..00000000 --- a/client-sdks/python/api-reference/components/typeany.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeAny - Python SDK -sidebarTitle: TypeAny -description: TypeAny method reference -seoTitle: TypeAny | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typeany' -'og:site_name': OpenRouter Documentation -'og:title': TypeAny | OpenRouter Python SDK -'og:description': >- - TypeAny method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAny%20-%20Python%20SDK&description=TypeAny%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `ANY` | any | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typebash20250124.mdx b/client-sdks/python/api-reference/components/typebash20250124.mdx deleted file mode 100644 index 1dae35bf..00000000 --- a/client-sdks/python/api-reference/components/typebash20250124.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeBash20250124 - Python SDK -sidebarTitle: TypeBash20250124 -description: TypeBash20250124 method reference -seoTitle: TypeBash20250124 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typebash20250124 -'og:site_name': OpenRouter Documentation -'og:title': TypeBash20250124 | OpenRouter Python SDK -'og:description': >- - TypeBash20250124 method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeBash20250124%20-%20Python%20SDK&description=TypeBash20250124%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `BASH_20250124` | bash_20250124 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeclearthinking20251015.mdx b/client-sdks/python/api-reference/components/typeclearthinking20251015.mdx deleted file mode 100644 index e0571025..00000000 --- a/client-sdks/python/api-reference/components/typeclearthinking20251015.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeClearThinking20251015 - Python SDK -sidebarTitle: TypeClearThinking20251015 -description: TypeClearThinking20251015 method reference -seoTitle: TypeClearThinking20251015 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typeclearthinking20251015 -'og:site_name': OpenRouter Documentation -'og:title': TypeClearThinking20251015 | OpenRouter Python SDK -'og:description': >- - TypeClearThinking20251015 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeClearThinking20251015%20-%20Python%20SDK&description=TypeClearThinking20251015%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------- | ------------------------- | -| `CLEAR_THINKING_20251015` | clear_thinking_20251015 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typecleartooluses20250919.mdx b/client-sdks/python/api-reference/components/typecleartooluses20250919.mdx deleted file mode 100644 index 87941a06..00000000 --- a/client-sdks/python/api-reference/components/typecleartooluses20250919.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeClearToolUses20250919 - Python SDK -sidebarTitle: TypeClearToolUses20250919 -description: TypeClearToolUses20250919 method reference -seoTitle: TypeClearToolUses20250919 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typecleartooluses20250919 -'og:site_name': OpenRouter Documentation -'og:title': TypeClearToolUses20250919 | OpenRouter Python SDK -'og:description': >- - TypeClearToolUses20250919 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeClearToolUses20250919%20-%20Python%20SDK&description=TypeClearToolUses20250919%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------- | -------------------------- | -| `CLEAR_TOOL_USES_20250919` | clear_tool_uses_20250919 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typecodeinterpreter.mdx b/client-sdks/python/api-reference/components/typecodeinterpreter.mdx deleted file mode 100644 index 1ccfc7f3..00000000 --- a/client-sdks/python/api-reference/components/typecodeinterpreter.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeCodeInterpreter - Python SDK -sidebarTitle: TypeCodeInterpreter -description: TypeCodeInterpreter method reference -seoTitle: TypeCodeInterpreter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typecodeinterpreter -'og:site_name': OpenRouter Documentation -'og:title': TypeCodeInterpreter | OpenRouter Python SDK -'og:description': >- - TypeCodeInterpreter method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCodeInterpreter%20-%20Python%20SDK&description=TypeCodeInterpreter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `CODE_INTERPRETER` | code_interpreter | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typecodeinterpretercall.mdx b/client-sdks/python/api-reference/components/typecodeinterpretercall.mdx deleted file mode 100644 index 5eb103de..00000000 --- a/client-sdks/python/api-reference/components/typecodeinterpretercall.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeCodeInterpreterCall - Python SDK -sidebarTitle: TypeCodeInterpreterCall -description: TypeCodeInterpreterCall method reference -seoTitle: TypeCodeInterpreterCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typecodeinterpretercall -'og:site_name': OpenRouter Documentation -'og:title': TypeCodeInterpreterCall | OpenRouter Python SDK -'og:description': >- - TypeCodeInterpreterCall method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCodeInterpreterCall%20-%20Python%20SDK&description=TypeCodeInterpreterCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `CODE_INTERPRETER_CALL` | code_interpreter_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typecompact20260112.mdx b/client-sdks/python/api-reference/components/typecompact20260112.mdx deleted file mode 100644 index e8615a7e..00000000 --- a/client-sdks/python/api-reference/components/typecompact20260112.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeCompact20260112 - Python SDK -sidebarTitle: TypeCompact20260112 -description: TypeCompact20260112 method reference -seoTitle: TypeCompact20260112 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typecompact20260112 -'og:site_name': OpenRouter Documentation -'og:title': TypeCompact20260112 | OpenRouter Python SDK -'og:description': >- - TypeCompact20260112 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCompact20260112%20-%20Python%20SDK&description=TypeCompact20260112%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `COMPACT_20260112` | compact_20260112 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typedisabled.mdx b/client-sdks/python/api-reference/components/typedisabled.mdx deleted file mode 100644 index 2887d731..00000000 --- a/client-sdks/python/api-reference/components/typedisabled.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeDisabled - Python SDK -sidebarTitle: TypeDisabled -description: TypeDisabled method reference -seoTitle: TypeDisabled | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typedisabled' -'og:site_name': OpenRouter Documentation -'og:title': TypeDisabled | OpenRouter Python SDK -'og:description': >- - TypeDisabled method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeDisabled%20-%20Python%20SDK&description=TypeDisabled%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typedocument.mdx b/client-sdks/python/api-reference/components/typedocument.mdx deleted file mode 100644 index 6123155f..00000000 --- a/client-sdks/python/api-reference/components/typedocument.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeDocument - Python SDK -sidebarTitle: TypeDocument -description: TypeDocument method reference -seoTitle: TypeDocument | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typedocument' -'og:site_name': OpenRouter Documentation -'og:title': TypeDocument | OpenRouter Python SDK -'og:description': >- - TypeDocument method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeDocument%20-%20Python%20SDK&description=TypeDocument%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `DOCUMENT` | document | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeenabled.mdx b/client-sdks/python/api-reference/components/typeenabled.mdx deleted file mode 100644 index 74a4387c..00000000 --- a/client-sdks/python/api-reference/components/typeenabled.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeEnabled - Python SDK -sidebarTitle: TypeEnabled -description: TypeEnabled method reference -seoTitle: TypeEnabled | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typeenabled' -'og:site_name': OpenRouter Documentation -'og:title': TypeEnabled | OpenRouter Python SDK -'og:description': >- - TypeEnabled method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeEnabled%20-%20Python%20SDK&description=TypeEnabled%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `ENABLED` | enabled | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeexec.mdx b/client-sdks/python/api-reference/components/typeexec.mdx deleted file mode 100644 index 0f032817..00000000 --- a/client-sdks/python/api-reference/components/typeexec.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeExec - Python SDK -sidebarTitle: TypeExec -description: TypeExec method reference -seoTitle: TypeExec | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typeexec' -'og:site_name': OpenRouter Documentation -'og:title': TypeExec | OpenRouter Python SDK -'og:description': >- - TypeExec method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeExec%20-%20Python%20SDK&description=TypeExec%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `EXEC` | exec | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typefilesearch.mdx b/client-sdks/python/api-reference/components/typefilesearch.mdx deleted file mode 100644 index 18300e4b..00000000 --- a/client-sdks/python/api-reference/components/typefilesearch.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeFileSearch - Python SDK -sidebarTitle: TypeFileSearch -description: TypeFileSearch method reference -seoTitle: TypeFileSearch | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typefilesearch' -'og:site_name': OpenRouter Documentation -'og:title': TypeFileSearch | OpenRouter Python SDK -'og:description': >- - TypeFileSearch method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeFileSearch%20-%20Python%20SDK&description=TypeFileSearch%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `FILE_SEARCH` | file_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typefindinpage.mdx b/client-sdks/python/api-reference/components/typefindinpage.mdx deleted file mode 100644 index 08b71d30..00000000 --- a/client-sdks/python/api-reference/components/typefindinpage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeFindInPage - Python SDK -sidebarTitle: TypeFindInPage -description: TypeFindInPage method reference -seoTitle: TypeFindInPage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typefindinpage' -'og:site_name': OpenRouter Documentation -'og:title': TypeFindInPage | OpenRouter Python SDK -'og:description': >- - TypeFindInPage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeFindInPage%20-%20Python%20SDK&description=TypeFindInPage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `FIND_IN_PAGE` | find_in_page | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typelocalshellcall.mdx b/client-sdks/python/api-reference/components/typelocalshellcall.mdx deleted file mode 100644 index 3d61c35a..00000000 --- a/client-sdks/python/api-reference/components/typelocalshellcall.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeLocalShellCall - Python SDK -sidebarTitle: TypeLocalShellCall -description: TypeLocalShellCall method reference -seoTitle: TypeLocalShellCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typelocalshellcall -'og:site_name': OpenRouter Documentation -'og:title': TypeLocalShellCall | OpenRouter Python SDK -'og:description': >- - TypeLocalShellCall method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeLocalShellCall%20-%20Python%20SDK&description=TypeLocalShellCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `LOCAL_SHELL_CALL` | local_shell_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typelogs.mdx b/client-sdks/python/api-reference/components/typelogs.mdx deleted file mode 100644 index 7a6b7e02..00000000 --- a/client-sdks/python/api-reference/components/typelogs.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeLogs - Python SDK -sidebarTitle: TypeLogs -description: TypeLogs method reference -seoTitle: TypeLogs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typelogs' -'og:site_name': OpenRouter Documentation -'og:title': TypeLogs | OpenRouter Python SDK -'og:description': >- - TypeLogs method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeLogs%20-%20Python%20SDK&description=TypeLogs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `LOGS` | logs | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typenone.mdx b/client-sdks/python/api-reference/components/typenone.mdx deleted file mode 100644 index 79c2b273..00000000 --- a/client-sdks/python/api-reference/components/typenone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeNone - Python SDK -sidebarTitle: TypeNone -description: TypeNone method reference -seoTitle: TypeNone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typenone' -'og:site_name': OpenRouter Documentation -'og:title': TypeNone | OpenRouter Python SDK -'og:description': >- - TypeNone method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeNone%20-%20Python%20SDK&description=TypeNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeopenpage.mdx b/client-sdks/python/api-reference/components/typeopenpage.mdx deleted file mode 100644 index 40ab9c95..00000000 --- a/client-sdks/python/api-reference/components/typeopenpage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeOpenPage - Python SDK -sidebarTitle: TypeOpenPage -description: TypeOpenPage method reference -seoTitle: TypeOpenPage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typeopenpage' -'og:site_name': OpenRouter Documentation -'og:title': TypeOpenPage | OpenRouter Python SDK -'og:description': >- - TypeOpenPage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeOpenPage%20-%20Python%20SDK&description=TypeOpenPage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `OPEN_PAGE` | open_page | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeredactedthinking.mdx b/client-sdks/python/api-reference/components/typeredactedthinking.mdx deleted file mode 100644 index c4c0228d..00000000 --- a/client-sdks/python/api-reference/components/typeredactedthinking.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeRedactedThinking - Python SDK -sidebarTitle: TypeRedactedThinking -description: TypeRedactedThinking method reference -seoTitle: TypeRedactedThinking | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typeredactedthinking -'og:site_name': OpenRouter Documentation -'og:title': TypeRedactedThinking | OpenRouter Python SDK -'og:description': >- - TypeRedactedThinking method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeRedactedThinking%20-%20Python%20SDK&description=TypeRedactedThinking%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `REDACTED_THINKING` | redacted_thinking | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typeservertooluse.mdx b/client-sdks/python/api-reference/components/typeservertooluse.mdx deleted file mode 100644 index 90977f66..00000000 --- a/client-sdks/python/api-reference/components/typeservertooluse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeServerToolUse - Python SDK -sidebarTitle: TypeServerToolUse -description: TypeServerToolUse method reference -seoTitle: TypeServerToolUse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typeservertooluse -'og:site_name': OpenRouter Documentation -'og:title': TypeServerToolUse | OpenRouter Python SDK -'og:description': >- - TypeServerToolUse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeServerToolUse%20-%20Python%20SDK&description=TypeServerToolUse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `SERVER_TOOL_USE` | server_tool_use | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetexteditor20250124.mdx b/client-sdks/python/api-reference/components/typetexteditor20250124.mdx deleted file mode 100644 index 4f37d03d..00000000 --- a/client-sdks/python/api-reference/components/typetexteditor20250124.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeTextEditor20250124 - Python SDK -sidebarTitle: TypeTextEditor20250124 -description: TypeTextEditor20250124 method reference -seoTitle: TypeTextEditor20250124 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typetexteditor20250124 -'og:site_name': OpenRouter Documentation -'og:title': TypeTextEditor20250124 | OpenRouter Python SDK -'og:description': >- - TypeTextEditor20250124 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTextEditor20250124%20-%20Python%20SDK&description=TypeTextEditor20250124%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `TEXT_EDITOR_20250124` | text_editor_20250124 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typethinking.mdx b/client-sdks/python/api-reference/components/typethinking.mdx deleted file mode 100644 index fad0db69..00000000 --- a/client-sdks/python/api-reference/components/typethinking.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeThinking - Python SDK -sidebarTitle: TypeThinking -description: TypeThinking method reference -seoTitle: TypeThinking | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typethinking' -'og:site_name': OpenRouter Documentation -'og:title': TypeThinking | OpenRouter Python SDK -'og:description': >- - TypeThinking method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeThinking%20-%20Python%20SDK&description=TypeThinking%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `THINKING` | thinking | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetokens.mdx b/client-sdks/python/api-reference/components/typetokens.mdx deleted file mode 100644 index 413a3d56..00000000 --- a/client-sdks/python/api-reference/components/typetokens.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeTokens - Python SDK -sidebarTitle: TypeTokens -description: TypeTokens method reference -seoTitle: TypeTokens | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typetokens' -'og:site_name': OpenRouter Documentation -'og:title': TypeTokens | OpenRouter Python SDK -'og:description': >- - TypeTokens method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTokens%20-%20Python%20SDK&description=TypeTokens%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `TOKENS` | tokens | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetool.mdx b/client-sdks/python/api-reference/components/typetool.mdx deleted file mode 100644 index cbf56fbe..00000000 --- a/client-sdks/python/api-reference/components/typetool.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeTool - Python SDK -sidebarTitle: TypeTool -description: TypeTool method reference -seoTitle: TypeTool | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typetool' -'og:site_name': OpenRouter Documentation -'og:title': TypeTool | OpenRouter Python SDK -'og:description': >- - TypeTool method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTool%20-%20Python%20SDK&description=TypeTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TOOL` | tool | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetoolreference.mdx b/client-sdks/python/api-reference/components/typetoolreference.mdx deleted file mode 100644 index d4f07723..00000000 --- a/client-sdks/python/api-reference/components/typetoolreference.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeToolReference - Python SDK -sidebarTitle: TypeToolReference -description: TypeToolReference method reference -seoTitle: TypeToolReference | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typetoolreference -'og:site_name': OpenRouter Documentation -'og:title': TypeToolReference | OpenRouter Python SDK -'og:description': >- - TypeToolReference method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolReference%20-%20Python%20SDK&description=TypeToolReference%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `TOOL_REFERENCE` | tool_reference | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetoolresult.mdx b/client-sdks/python/api-reference/components/typetoolresult.mdx deleted file mode 100644 index 2cc1c391..00000000 --- a/client-sdks/python/api-reference/components/typetoolresult.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeToolResult - Python SDK -sidebarTitle: TypeToolResult -description: TypeToolResult method reference -seoTitle: TypeToolResult | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typetoolresult' -'og:site_name': OpenRouter Documentation -'og:title': TypeToolResult | OpenRouter Python SDK -'og:description': >- - TypeToolResult method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolResult%20-%20Python%20SDK&description=TypeToolResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `TOOL_RESULT` | tool_result | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typetooluse.mdx b/client-sdks/python/api-reference/components/typetooluse.mdx deleted file mode 100644 index eb53b8a0..00000000 --- a/client-sdks/python/api-reference/components/typetooluse.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeToolUse - Python SDK -sidebarTitle: TypeToolUse -description: TypeToolUse method reference -seoTitle: TypeToolUse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/typetooluse' -'og:site_name': OpenRouter Documentation -'og:title': TypeToolUse | OpenRouter Python SDK -'og:description': >- - TypeToolUse method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeToolUse%20-%20Python%20SDK&description=TypeToolUse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `TOOL_USE` | tool_use | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typewebsearch20250305.mdx b/client-sdks/python/api-reference/components/typewebsearch20250305.mdx deleted file mode 100644 index ad55d536..00000000 --- a/client-sdks/python/api-reference/components/typewebsearch20250305.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeWebSearch20250305 - Python SDK -sidebarTitle: TypeWebSearch20250305 -description: TypeWebSearch20250305 method reference -seoTitle: TypeWebSearch20250305 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typewebsearch20250305 -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20250305 | OpenRouter Python SDK -'og:description': >- - TypeWebSearch20250305 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20250305%20-%20Python%20SDK&description=TypeWebSearch20250305%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `WEB_SEARCH_20250305` | web_search_20250305 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typewebsearch20260209.mdx b/client-sdks/python/api-reference/components/typewebsearch20260209.mdx deleted file mode 100644 index 89c91cee..00000000 --- a/client-sdks/python/api-reference/components/typewebsearch20260209.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeWebSearch20260209 - Python SDK -sidebarTitle: TypeWebSearch20260209 -description: TypeWebSearch20260209 method reference -seoTitle: TypeWebSearch20260209 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typewebsearch20260209 -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20260209 | OpenRouter Python SDK -'og:description': >- - TypeWebSearch20260209 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20260209%20-%20Python%20SDK&description=TypeWebSearch20260209%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `WEB_SEARCH_20260209` | web_search_20260209 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typewebsearchcall.mdx b/client-sdks/python/api-reference/components/typewebsearchcall.mdx deleted file mode 100644 index fbb0b9bc..00000000 --- a/client-sdks/python/api-reference/components/typewebsearchcall.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeWebSearchCall - Python SDK -sidebarTitle: TypeWebSearchCall -description: TypeWebSearchCall method reference -seoTitle: TypeWebSearchCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typewebsearchcall -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchCall | OpenRouter Python SDK -'og:description': >- - TypeWebSearchCall method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchCall%20-%20Python%20SDK&description=TypeWebSearchCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `WEB_SEARCH_CALL` | web_search_call | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typewebsearchtoolresult.mdx b/client-sdks/python/api-reference/components/typewebsearchtoolresult.mdx deleted file mode 100644 index 2825b92f..00000000 --- a/client-sdks/python/api-reference/components/typewebsearchtoolresult.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeWebSearchToolResult - Python SDK -sidebarTitle: TypeWebSearchToolResult -description: TypeWebSearchToolResult method reference -seoTitle: TypeWebSearchToolResult | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typewebsearchtoolresult -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchToolResult | OpenRouter Python SDK -'og:description': >- - TypeWebSearchToolResult method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchToolResult%20-%20Python%20SDK&description=TypeWebSearchToolResult%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `WEB_SEARCH_TOOL_RESULT` | web_search_tool_result | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/typewebsearchtoolresulterror.mdx b/client-sdks/python/api-reference/components/typewebsearchtoolresulterror.mdx deleted file mode 100644 index 9057dc11..00000000 --- a/client-sdks/python/api-reference/components/typewebsearchtoolresulterror.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: TypeWebSearchToolResultError - Python SDK -sidebarTitle: TypeWebSearchToolResultError -description: TypeWebSearchToolResultError method reference -seoTitle: TypeWebSearchToolResultError | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/typewebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchToolResultError | OpenRouter Python SDK -'og:description': >- - TypeWebSearchToolResultError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchToolResultError%20-%20Python%20SDK&description=TypeWebSearchToolResultError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `WEB_SEARCH_TOOL_RESULT_ERROR` | web_search_tool_result_error | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/unauthorizedresponseerrordata.mdx b/client-sdks/python/api-reference/components/unauthorizedresponseerrordata.mdx deleted file mode 100644 index 05b02980..00000000 --- a/client-sdks/python/api-reference/components/unauthorizedresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnauthorizedResponseErrorData - Python SDK -sidebarTitle: UnauthorizedResponseErrorData -description: UnauthorizedResponseErrorData method reference -seoTitle: UnauthorizedResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/unauthorizedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseErrorData | OpenRouter Python SDK -'og:description': >- - UnauthorizedResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseErrorData%20-%20Python%20SDK&description=UnauthorizedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for UnauthorizedResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/uniqueinsight.mdx b/client-sdks/python/api-reference/components/uniqueinsight.mdx deleted file mode 100644 index 44148a10..00000000 --- a/client-sdks/python/api-reference/components/uniqueinsight.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UniqueInsight - Python SDK -sidebarTitle: UniqueInsight -description: UniqueInsight method reference -seoTitle: UniqueInsight | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/uniqueinsight' -'og:site_name': OpenRouter Documentation -'og:title': UniqueInsight | OpenRouter Python SDK -'og:description': >- - UniqueInsight method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UniqueInsight%20-%20Python%20SDK&description=UniqueInsight%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `insight` | *str* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/unprocessableentityresponseerrordata.mdx b/client-sdks/python/api-reference/components/unprocessableentityresponseerrordata.mdx deleted file mode 100644 index 3d1b94cd..00000000 --- a/client-sdks/python/api-reference/components/unprocessableentityresponseerrordata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnprocessableEntityResponseErrorData - Python SDK -sidebarTitle: UnprocessableEntityResponseErrorData -description: UnprocessableEntityResponseErrorData method reference -seoTitle: UnprocessableEntityResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/unprocessableentityresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseErrorData | OpenRouter Python SDK -'og:description': >- - UnprocessableEntityResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseErrorData%20-%20Python%20SDK&description=UnprocessableEntityResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for UnprocessableEntityResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/updatebyokkeyrequest.mdx b/client-sdks/python/api-reference/components/updatebyokkeyrequest.mdx deleted file mode 100644 index 6a556a6c..00000000 --- a/client-sdks/python/api-reference/components/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - Python SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest method reference -seoTitle: UpdateBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updatebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - UpdateBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20Python%20SDK&description=UpdateBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowed_user_ids` | List[*str*] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `is_fallback` | *Optional[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` | *Optional[str]* | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/updatebyokkeyresponse.mdx b/client-sdks/python/api-reference/components/updatebyokkeyresponse.mdx deleted file mode 100644 index 17523f6d..00000000 --- a/client-sdks/python/api-reference/components/updatebyokkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateBYOKKeyResponse - Python SDK -sidebarTitle: UpdateBYOKKeyResponse -description: UpdateBYOKKeyResponse method reference -seoTitle: UpdateBYOKKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updatebyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyResponse | OpenRouter Python SDK -'og:description': >- - UpdateBYOKKeyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyResponse%20-%20Python%20SDK&description=UpdateBYOKKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [components.BYOKKey](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/updateguardrailrequest.mdx b/client-sdks/python/api-reference/components/updateguardrailrequest.mdx deleted file mode 100644 index 02491fef..00000000 --- a/client-sdks/python/api-reference/components/updateguardrailrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: UpdateGuardrailRequest - Python SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest method reference -seoTitle: UpdateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20Python%20SDK&description=UpdateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `content_filters` | List[[components.ContentFilterEntry](/client-sdks/python/api-reference/components/contentfilterentry)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | `` | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| ~~`enforce_zdr`~~ | *OptionalNullable[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](../components/guardrailinterval.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/updateguardrailresponse.mdx b/client-sdks/python/api-reference/components/updateguardrailresponse.mdx deleted file mode 100644 index 9cebcc93..00000000 --- a/client-sdks/python/api-reference/components/updateguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateGuardrailResponse - Python SDK -sidebarTitle: UpdateGuardrailResponse -description: UpdateGuardrailResponse method reference -seoTitle: UpdateGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResponse | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResponse%20-%20Python%20SDK&description=UpdateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Guardrail](/client-sdks/python/api-reference/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/python/api-reference/components/updateobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/components/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index 7cb9de7b..00000000 --- a/client-sdks/python/api-reference/components/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - Python SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest method reference -seoTitle: UpdateObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - UpdateObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20Python%20SDK&description=UpdateObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key_hashes` | List[*str*] | :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. | `` | -| `config` | Dict[str, *Nullable[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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfig]](../components/observabilityfilterrulesconfig.md) | :heavy_minus_sign: | N/A | `` | -| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/updateobservabilitydestinationresponse.mdx b/client-sdks/python/api-reference/components/updateobservabilitydestinationresponse.mdx deleted file mode 100644 index 8c7a307e..00000000 --- a/client-sdks/python/api-reference/components/updateobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateObservabilityDestinationResponse - Python SDK -sidebarTitle: UpdateObservabilityDestinationResponse -description: UpdateObservabilityDestinationResponse method reference -seoTitle: UpdateObservabilityDestinationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationResponse | OpenRouter Python SDK -'og:description': >- - UpdateObservabilityDestinationResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationResponse%20-%20Python%20SDK&description=UpdateObservabilityDestinationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ObservabilityDestination](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/components/updateworkspacerequest.mdx b/client-sdks/python/api-reference/components/updateworkspacerequest.mdx deleted file mode 100644 index 4cdc3211..00000000 --- a/client-sdks/python/api-reference/components/updateworkspacerequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateWorkspaceRequest - Python SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest method reference -seoTitle: UpdateWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - UpdateWorkspaceRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20Python%20SDK&description=UpdateWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/updateworkspaceresponse.mdx b/client-sdks/python/api-reference/components/updateworkspaceresponse.mdx deleted file mode 100644 index 19756d88..00000000 --- a/client-sdks/python/api-reference/components/updateworkspaceresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateWorkspaceResponse - Python SDK -sidebarTitle: UpdateWorkspaceResponse -description: UpdateWorkspaceResponse method reference -seoTitle: UpdateWorkspaceResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/updateworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceResponse | OpenRouter Python SDK -'og:description': >- - UpdateWorkspaceResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceResponse%20-%20Python%20SDK&description=UpdateWorkspaceResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.Workspace](/client-sdks/python/api-reference/components/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/python/api-reference/components/urlcitation.mdx b/client-sdks/python/api-reference/components/urlcitation.mdx deleted file mode 100644 index 4bc7a66a..00000000 --- a/client-sdks/python/api-reference/components/urlcitation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: URLCitation - Python SDK -sidebarTitle: URLCitation -description: URLCitation method reference -seoTitle: URLCitation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/urlcitation' -'og:site_name': OpenRouter Documentation -'og:title': URLCitation | OpenRouter Python SDK -'og:description': >- - URLCitation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitation%20-%20Python%20SDK&description=URLCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `end_index` | *int* | :heavy_check_mark: | N/A | -| `start_index` | *int* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `type` | [components.URLCitationType](/client-sdks/python/api-reference/components/urlcitationtype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/urlcitationtype.mdx b/client-sdks/python/api-reference/components/urlcitationtype.mdx deleted file mode 100644 index af621af3..00000000 --- a/client-sdks/python/api-reference/components/urlcitationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: URLCitationType - Python SDK -sidebarTitle: URLCitationType -description: URLCitationType method reference -seoTitle: URLCitationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/urlcitationtype -'og:site_name': OpenRouter Documentation -'og:title': URLCitationType | OpenRouter Python SDK -'og:description': >- - URLCitationType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitationType%20-%20Python%20SDK&description=URLCitationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `URL_CITATION` | url_citation | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/usage.mdx b/client-sdks/python/api-reference/components/usage.mdx deleted file mode 100644 index 3cae66a2..00000000 --- a/client-sdks/python/api-reference/components/usage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Usage - Python SDK -sidebarTitle: Usage -description: Usage method reference -seoTitle: Usage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/usage' -'og:site_name': OpenRouter Documentation -'og:title': Usage | OpenRouter Python SDK -'og:description': >- - Usage method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Usage%20-%20Python%20SDK&description=Usage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Token usage information for the response - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `input_tokens` | *int* | :heavy_check_mark: | N/A | -| `input_tokens_details` | [components.InputTokensDetails](/client-sdks/python/api-reference/components/inputtokensdetails) | :heavy_check_mark: | N/A | -| `output_tokens` | *int* | :heavy_check_mark: | N/A | -| `output_tokens_details` | [components.OutputTokensDetails](/client-sdks/python/api-reference/components/outputtokensdetails) | :heavy_check_mark: | N/A | -| `total_tokens` | *int* | :heavy_check_mark: | N/A | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | -| `cost_details` | [Optional[components.UsageCostDetails]](../components/usagecostdetails.md) | :heavy_minus_sign: | N/A | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/usagecostdetails.mdx b/client-sdks/python/api-reference/components/usagecostdetails.mdx deleted file mode 100644 index 2593c434..00000000 --- a/client-sdks/python/api-reference/components/usagecostdetails.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UsageCostDetails - Python SDK -sidebarTitle: UsageCostDetails -description: UsageCostDetails method reference -seoTitle: UsageCostDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/usagecostdetails -'og:site_name': OpenRouter Documentation -'og:title': UsageCostDetails | OpenRouter Python SDK -'og:description': >- - UsageCostDetails method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageCostDetails%20-%20Python%20SDK&description=UsageCostDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `upstream_inference_input_cost` | *float* | :heavy_check_mark: | N/A | -| `upstream_inference_output_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/userlocation.mdx b/client-sdks/python/api-reference/components/userlocation.mdx deleted file mode 100644 index ae533440..00000000 --- a/client-sdks/python/api-reference/components/userlocation.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: UserLocation - Python SDK -sidebarTitle: UserLocation -description: UserLocation method reference -seoTitle: UserLocation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/userlocation' -'og:site_name': OpenRouter Documentation -'og:title': UserLocation | OpenRouter Python SDK -'og:description': >- - UserLocation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserLocation%20-%20Python%20SDK&description=UserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased search results. Passed through to native providers that support it (e.g. Anthropic). - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [components.WebSearchPluginType](/client-sdks/python/api-reference/components/websearchplugintype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/variables.mdx b/client-sdks/python/api-reference/components/variables.mdx deleted file mode 100644 index e411c666..00000000 --- a/client-sdks/python/api-reference/components/variables.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Variables - Python SDK -sidebarTitle: Variables -description: Variables method reference -seoTitle: Variables | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/variables' -'og:site_name': OpenRouter Documentation -'og:title': Variables | OpenRouter Python SDK -'og:description': >- - Variables method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Variables%20-%20Python%20SDK&description=Variables%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `components.InputText` - -```python lines -value: components.InputText = /* values here */ -``` - -### `components.InputImage` - -```python lines -value: components.InputImage = /* values here */ -``` - -### `components.InputFile` - -```python lines -value: components.InputFile = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/verbosity.mdx b/client-sdks/python/api-reference/components/verbosity.mdx deleted file mode 100644 index 81b34098..00000000 --- a/client-sdks/python/api-reference/components/verbosity.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Verbosity - Python SDK -sidebarTitle: Verbosity -description: Verbosity method reference -seoTitle: Verbosity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/verbosity' -'og:site_name': OpenRouter Documentation -'og:title': Verbosity | OpenRouter Python SDK -'og:description': >- - Verbosity method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Verbosity%20-%20Python%20SDK&description=Verbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | -| `XHIGH` | xhigh | -| `MAX` | max | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/version.mdx b/client-sdks/python/api-reference/components/version.mdx deleted file mode 100644 index fb863caa..00000000 --- a/client-sdks/python/api-reference/components/version.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Version - Python SDK -sidebarTitle: Version -description: Version method reference -seoTitle: Version | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/version' -'og:site_name': OpenRouter Documentation -'og:title': Version | OpenRouter Python SDK -'og:description': >- - Version method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Version%20-%20Python%20SDK&description=Version%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Dataset version. Field names and grain are stable for the life of `v1`. - -## Values - -| Name | Value | -| ----- | ----- | -| `V1` | v1 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/videogenerationrequest.mdx b/client-sdks/python/api-reference/components/videogenerationrequest.mdx deleted file mode 100644 index 23d375a9..00000000 --- a/client-sdks/python/api-reference/components/videogenerationrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: VideoGenerationRequest - Python SDK -sidebarTitle: VideoGenerationRequest -description: VideoGenerationRequest method reference -seoTitle: VideoGenerationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videogenerationrequest -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequest | OpenRouter Python SDK -'og:description': >- - VideoGenerationRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequest%20-%20Python%20SDK&description=VideoGenerationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspect_ratio` | [Optional[components.AspectRatio]](../components/aspectratio.md) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](/client-sdks/python/api-reference/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. | | -| `generate_audio` | *Optional[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 | -| `input_references` | List[[components.ContentPartImage](/client-sdks/python/api-reference/components/contentpartimage)] | :heavy_minus_sign: | Reference images to guide video generation | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `prompt` | *str* | :heavy_check_mark: | N/A | | -| `provider` | [Optional[components.VideoGenerationRequestProvider]](../components/videogenerationrequestprovider.md) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.Resolution]](../components/resolution.md) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | :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` | *Optional[str]* | :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/client-sdks/python/api-reference/components/videogenerationrequestprovider.mdx b/client-sdks/python/api-reference/components/videogenerationrequestprovider.mdx deleted file mode 100644 index 4912e371..00000000 --- a/client-sdks/python/api-reference/components/videogenerationrequestprovider.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: VideoGenerationRequestProvider - Python SDK -sidebarTitle: VideoGenerationRequestProvider -description: VideoGenerationRequestProvider method reference -seoTitle: VideoGenerationRequestProvider | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videogenerationrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequestProvider | OpenRouter Python SDK -'og:description': >- - VideoGenerationRequestProvider method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequestProvider%20-%20Python%20SDK&description=VideoGenerationRequestProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `options` | [Optional[components.Options]](../components/options.md) | :heavy_minus_sign: | N/A | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/videogenerationresponse.mdx b/client-sdks/python/api-reference/components/videogenerationresponse.mdx deleted file mode 100644 index 1366b76a..00000000 --- a/client-sdks/python/api-reference/components/videogenerationresponse.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: VideoGenerationResponse - Python SDK -sidebarTitle: VideoGenerationResponse -description: VideoGenerationResponse method reference -seoTitle: VideoGenerationResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videogenerationresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponse | OpenRouter Python SDK -'og:description': >- - VideoGenerationResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponse%20-%20Python%20SDK&description=VideoGenerationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `error` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `generation_id` | *Optional[str]* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `polling_url` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.VideoGenerationResponseStatus](/client-sdks/python/api-reference/components/videogenerationresponsestatus) | :heavy_check_mark: | N/A | | -| `unsigned_urls` | List[*str*] | :heavy_minus_sign: | N/A | | -| `usage` | [Optional[components.VideoGenerationUsage]](../components/videogenerationusage.md) | :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/client-sdks/python/api-reference/components/videogenerationresponsestatus.mdx b/client-sdks/python/api-reference/components/videogenerationresponsestatus.mdx deleted file mode 100644 index d031beda..00000000 --- a/client-sdks/python/api-reference/components/videogenerationresponsestatus.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: VideoGenerationResponseStatus - Python SDK -sidebarTitle: VideoGenerationResponseStatus -description: VideoGenerationResponseStatus method reference -seoTitle: VideoGenerationResponseStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videogenerationresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponseStatus | OpenRouter Python SDK -'og:description': >- - VideoGenerationResponseStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponseStatus%20-%20Python%20SDK&description=VideoGenerationResponseStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `PENDING` | pending | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `FAILED` | failed | -| `CANCELLED` | cancelled | -| `EXPIRED` | expired | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/videogenerationusage.mdx b/client-sdks/python/api-reference/components/videogenerationusage.mdx deleted file mode 100644 index 6c7341d3..00000000 --- a/client-sdks/python/api-reference/components/videogenerationusage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: VideoGenerationUsage - Python SDK -sidebarTitle: VideoGenerationUsage -description: VideoGenerationUsage method reference -seoTitle: VideoGenerationUsage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videogenerationusage -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationUsage | OpenRouter Python SDK -'og:description': >- - VideoGenerationUsage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationUsage%20-%20Python%20SDK&description=VideoGenerationUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Usage and cost information for the video generation. Available once the job has completed. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | The cost of the video generation in USD. | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/videomodel.mdx b/client-sdks/python/api-reference/components/videomodel.mdx deleted file mode 100644 index 55074380..00000000 --- a/client-sdks/python/api-reference/components/videomodel.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: VideoModel - Python SDK -sidebarTitle: VideoModel -description: VideoModel method reference -seoTitle: VideoModel | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/videomodel' -'og:site_name': OpenRouter Documentation -'og:title': VideoModel | OpenRouter Python SDK -'og:description': >- - VideoModel method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModel%20-%20Python%20SDK&description=VideoModel%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowed_passthrough_parameters` | List[*str*] | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `created` | *int* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `generate_audio` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `pricing_skus` | Dict[str, *str*] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | -| `seed` | *Nullable[bool]* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `supported_aspect_ratios` | List[[components.SupportedAspectRatio](/client-sdks/python/api-reference/components/supportedaspectratio)] | :heavy_check_mark: | Supported output aspect ratios | | -| `supported_durations` | List[*int*] | :heavy_check_mark: | Supported video durations in seconds | | -| `supported_frame_images` | List[[components.SupportedFrameImage](/client-sdks/python/api-reference/components/supportedframeimage)] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `supported_resolutions` | List[[components.SupportedResolution](/client-sdks/python/api-reference/components/supportedresolution)] | :heavy_check_mark: | Supported output resolutions | | -| `supported_sizes` | List[[components.SupportedSize](/client-sdks/python/api-reference/components/supportedsize)] | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/videomodelslistresponse.mdx b/client-sdks/python/api-reference/components/videomodelslistresponse.mdx deleted file mode 100644 index 441926ac..00000000 --- a/client-sdks/python/api-reference/components/videomodelslistresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: VideoModelsListResponse - Python SDK -sidebarTitle: VideoModelsListResponse -description: VideoModelsListResponse method reference -seoTitle: VideoModelsListResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/videomodelslistresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoModelsListResponse | OpenRouter Python SDK -'og:description': >- - VideoModelsListResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModelsListResponse%20-%20Python%20SDK&description=VideoModelsListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | List[[components.VideoModel](/client-sdks/python/api-reference/components/videomodel)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/webfetchengineenum.mdx b/client-sdks/python/api-reference/components/webfetchengineenum.mdx deleted file mode 100644 index 2830cdc5..00000000 --- a/client-sdks/python/api-reference/components/webfetchengineenum.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: WebFetchEngineEnum - Python SDK -sidebarTitle: WebFetchEngineEnum -description: WebFetchEngineEnum method reference -seoTitle: WebFetchEngineEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/webfetchengineenum -'og:site_name': OpenRouter Documentation -'og:title': WebFetchEngineEnum | OpenRouter Python SDK -'og:description': >- - WebFetchEngineEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchEngineEnum%20-%20Python%20SDK&description=WebFetchEngineEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| ------------ | ------------ | -| `AUTO` | auto | -| `NATIVE` | native | -| `OPENROUTER` | openrouter | -| `EXA` | exa | -| `PARALLEL` | parallel | -| `FIRECRAWL` | firecrawl | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/webfetchplugin.mdx b/client-sdks/python/api-reference/components/webfetchplugin.mdx deleted file mode 100644 index 84b686f1..00000000 --- a/client-sdks/python/api-reference/components/webfetchplugin.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebFetchPlugin - Python SDK -sidebarTitle: WebFetchPlugin -description: WebFetchPlugin method reference -seoTitle: WebFetchPlugin | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/webfetchplugin' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchPlugin | OpenRouter Python SDK -'og:description': >- - WebFetchPlugin method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchPlugin%20-%20Python%20SDK&description=WebFetchPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | -| `id` | [components.WebFetchPluginID](/client-sdks/python/api-reference/components/webfetchpluginid) | :heavy_check_mark: | N/A | -| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `max_uses` | *Optional[int]* | :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/client-sdks/python/api-reference/components/webfetchpluginid.mdx b/client-sdks/python/api-reference/components/webfetchpluginid.mdx deleted file mode 100644 index b2e87aca..00000000 --- a/client-sdks/python/api-reference/components/webfetchpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebFetchPluginID - Python SDK -sidebarTitle: WebFetchPluginID -description: WebFetchPluginID method reference -seoTitle: WebFetchPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/webfetchpluginid -'og:site_name': OpenRouter Documentation -'og:title': WebFetchPluginID | OpenRouter Python SDK -'og:description': >- - WebFetchPluginID method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchPluginID%20-%20Python%20SDK&description=WebFetchPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `WEB_FETCH` | web-fetch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/webfetchservertool.mdx b/client-sdks/python/api-reference/components/webfetchservertool.mdx deleted file mode 100644 index 80f33ae2..00000000 --- a/client-sdks/python/api-reference/components/webfetchservertool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebFetchServerTool - Python SDK -sidebarTitle: WebFetchServerTool -description: WebFetchServerTool method reference -seoTitle: WebFetchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/webfetchservertool -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerTool | OpenRouter Python SDK -'og:description': >- - WebFetchServerTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerTool%20-%20Python%20SDK&description=WebFetchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fetches full content from a URL (web page or PDF) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [Optional[components.WebFetchServerToolConfig]](../components/webfetchservertoolconfig.md) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | `{"max_content_tokens": 100000,"max_uses": 10}` | -| `type` | [components.WebFetchServerToolType](/client-sdks/python/api-reference/components/webfetchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/webfetchservertoolconfig.mdx b/client-sdks/python/api-reference/components/webfetchservertoolconfig.mdx deleted file mode 100644 index 394d7332..00000000 --- a/client-sdks/python/api-reference/components/webfetchservertoolconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebFetchServerToolConfig - Python SDK -sidebarTitle: WebFetchServerToolConfig -description: WebFetchServerToolConfig method reference -seoTitle: WebFetchServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/webfetchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolConfig | OpenRouter Python SDK -'og:description': >- - WebFetchServerToolConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolConfig%20-%20Python%20SDK&description=WebFetchServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_fetch server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Only fetch from these domains. | | -| `blocked_domains` | List[*str*] | :heavy_minus_sign: | Never fetch from these domains. | | -| `engine` | [Optional[components.WebFetchEngineEnum]](../components/webfetchengineenum.md) | :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 | -| `max_content_tokens` | *Optional[int]* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `max_uses` | *Optional[int]* | :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/client-sdks/python/api-reference/components/webfetchservertooltype.mdx b/client-sdks/python/api-reference/components/webfetchservertooltype.mdx deleted file mode 100644 index 4ae57101..00000000 --- a/client-sdks/python/api-reference/components/webfetchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebFetchServerToolType - Python SDK -sidebarTitle: WebFetchServerToolType -description: WebFetchServerToolType method reference -seoTitle: WebFetchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/webfetchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolType | OpenRouter Python SDK -'og:description': >- - WebFetchServerToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolType%20-%20Python%20SDK&description=WebFetchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `OPENROUTER_WEB_FETCH` | openrouter:web_fetch | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallcompletedevent.mdx b/client-sdks/python/api-reference/components/websearchcallcompletedevent.mdx deleted file mode 100644 index 593714f2..00000000 --- a/client-sdks/python/api-reference/components/websearchcallcompletedevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallCompletedEvent - Python SDK -sidebarTitle: WebSearchCallCompletedEvent -description: WebSearchCallCompletedEvent method reference -seoTitle: WebSearchCallCompletedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallCompletedEvent | OpenRouter Python SDK -'og:description': >- - WebSearchCallCompletedEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallCompletedEvent%20-%20Python%20SDK&description=WebSearchCallCompletedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search call completed - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallCompletedEventType](/client-sdks/python/api-reference/components/websearchcallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallcompletedeventtype.mdx b/client-sdks/python/api-reference/components/websearchcallcompletedeventtype.mdx deleted file mode 100644 index f3af8e89..00000000 --- a/client-sdks/python/api-reference/components/websearchcallcompletedeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchCallCompletedEventType - Python SDK -sidebarTitle: WebSearchCallCompletedEventType -description: WebSearchCallCompletedEventType method reference -seoTitle: WebSearchCallCompletedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallcompletedeventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallCompletedEventType | OpenRouter Python SDK -'og:description': >- - WebSearchCallCompletedEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallCompletedEventType%20-%20Python%20SDK&description=WebSearchCallCompletedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `RESPONSE_WEB_SEARCH_CALL_COMPLETED` | response.web_search_call.completed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallinprogressevent.mdx b/client-sdks/python/api-reference/components/websearchcallinprogressevent.mdx deleted file mode 100644 index b10e9e24..00000000 --- a/client-sdks/python/api-reference/components/websearchcallinprogressevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallInProgressEvent - Python SDK -sidebarTitle: WebSearchCallInProgressEvent -description: WebSearchCallInProgressEvent method reference -seoTitle: WebSearchCallInProgressEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallInProgressEvent | OpenRouter Python SDK -'og:description': >- - WebSearchCallInProgressEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallInProgressEvent%20-%20Python%20SDK&description=WebSearchCallInProgressEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search call in progress - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallInProgressEventType](/client-sdks/python/api-reference/components/websearchcallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallinprogresseventtype.mdx b/client-sdks/python/api-reference/components/websearchcallinprogresseventtype.mdx deleted file mode 100644 index 0e949f32..00000000 --- a/client-sdks/python/api-reference/components/websearchcallinprogresseventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchCallInProgressEventType - Python SDK -sidebarTitle: WebSearchCallInProgressEventType -description: WebSearchCallInProgressEventType method reference -seoTitle: WebSearchCallInProgressEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallinprogresseventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallInProgressEventType | OpenRouter Python SDK -'og:description': >- - WebSearchCallInProgressEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallInProgressEventType%20-%20Python%20SDK&description=WebSearchCallInProgressEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS` | response.web_search_call.in_progress | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallsearchingevent.mdx b/client-sdks/python/api-reference/components/websearchcallsearchingevent.mdx deleted file mode 100644 index 37b65743..00000000 --- a/client-sdks/python/api-reference/components/websearchcallsearchingevent.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchCallSearchingEvent - Python SDK -sidebarTitle: WebSearchCallSearchingEvent -description: WebSearchCallSearchingEvent method reference -seoTitle: WebSearchCallSearchingEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallsearchingevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallSearchingEvent | OpenRouter Python SDK -'og:description': >- - WebSearchCallSearchingEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallSearchingEvent%20-%20Python%20SDK&description=WebSearchCallSearchingEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search call is searching - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *int* | :heavy_check_mark: | N/A | -| `sequence_number` | *int* | :heavy_check_mark: | N/A | -| `type` | [components.WebSearchCallSearchingEventType](/client-sdks/python/api-reference/components/websearchcallsearchingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchcallsearchingeventtype.mdx b/client-sdks/python/api-reference/components/websearchcallsearchingeventtype.mdx deleted file mode 100644 index ef2653ee..00000000 --- a/client-sdks/python/api-reference/components/websearchcallsearchingeventtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchCallSearchingEventType - Python SDK -sidebarTitle: WebSearchCallSearchingEventType -description: WebSearchCallSearchingEventType method reference -seoTitle: WebSearchCallSearchingEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchcallsearchingeventtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallSearchingEventType | OpenRouter Python SDK -'og:description': >- - WebSearchCallSearchingEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallSearchingEventType%20-%20Python%20SDK&description=WebSearchCallSearchingEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------ | ------------------------------------ | -| `RESPONSE_WEB_SEARCH_CALL_SEARCHING` | response.web_search_call.searching | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchconfig.mdx b/client-sdks/python/api-reference/components/websearchconfig.mdx deleted file mode 100644 index 82b4bf79..00000000 --- a/client-sdks/python/api-reference/components/websearchconfig.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchConfig - Python SDK -sidebarTitle: WebSearchConfig -description: WebSearchConfig method reference -seoTitle: WebSearchConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchconfig -'og:site_name': OpenRouter Documentation -'og:title': WebSearchConfig | OpenRouter Python SDK -'og:description': >- - WebSearchConfig method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchConfig%20-%20Python%20SDK&description=WebSearchConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `excluded_domains` | List[*str*] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `max_total_results` | *Optional[int]* | :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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../components/searchqualitylevel.md) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.md) | :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/client-sdks/python/api-reference/components/websearchdomainfilter.mdx b/client-sdks/python/api-reference/components/websearchdomainfilter.mdx deleted file mode 100644 index 1028ca22..00000000 --- a/client-sdks/python/api-reference/components/websearchdomainfilter.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: WebSearchDomainFilter - Python SDK -sidebarTitle: WebSearchDomainFilter -description: WebSearchDomainFilter method reference -seoTitle: WebSearchDomainFilter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchdomainfilter -'og:site_name': OpenRouter Documentation -'og:title': WebSearchDomainFilter | OpenRouter Python SDK -'og:description': >- - WebSearchDomainFilter method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchDomainFilter%20-%20Python%20SDK&description=WebSearchDomainFilter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | -| `excluded_domains` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchengine.mdx b/client-sdks/python/api-reference/components/websearchengine.mdx deleted file mode 100644 index 705518fb..00000000 --- a/client-sdks/python/api-reference/components/websearchengine.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: WebSearchEngine - Python SDK -sidebarTitle: WebSearchEngine -description: WebSearchEngine method reference -seoTitle: WebSearchEngine | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchengine -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngine | OpenRouter Python SDK -'og:description': >- - WebSearchEngine method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngine%20-%20Python%20SDK&description=WebSearchEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The search engine to use for web search. - -## Values - -| Name | Value | -| ----------- | ----------- | -| `NATIVE` | native | -| `EXA` | exa | -| `FIRECRAWL` | firecrawl | -| `PARALLEL` | parallel | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchengineenum.mdx b/client-sdks/python/api-reference/components/websearchengineenum.mdx deleted file mode 100644 index fc8f36f8..00000000 --- a/client-sdks/python/api-reference/components/websearchengineenum.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchEngineEnum - Python SDK -sidebarTitle: WebSearchEngineEnum -description: WebSearchEngineEnum method reference -seoTitle: WebSearchEngineEnum | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchengineenum -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngineEnum | OpenRouter Python SDK -'og:description': >- - WebSearchEngineEnum method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngineEnum%20-%20Python%20SDK&description=WebSearchEngineEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| ----------- | ----------- | -| `AUTO` | auto | -| `NATIVE` | native | -| `EXA` | exa | -| `PARALLEL` | parallel | -| `FIRECRAWL` | firecrawl | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchplugin.mdx b/client-sdks/python/api-reference/components/websearchplugin.mdx deleted file mode 100644 index 9e19c448..00000000 --- a/client-sdks/python/api-reference/components/websearchplugin.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchPlugin - Python SDK -sidebarTitle: WebSearchPlugin -description: WebSearchPlugin method reference -seoTitle: WebSearchPlugin | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchplugin -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPlugin | OpenRouter Python SDK -'og:description': >- - WebSearchPlugin method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPlugin%20-%20Python%20SDK&description=WebSearchPlugin%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | exa | -| `exclude_domains` | List[*str*] | :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](/client-sdks/python/api-reference/components/websearchpluginid) | :heavy_check_mark: | N/A | | -| `include_domains` | List[*str*] | :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"
] | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `max_uses` | *Optional[int]* | :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). | | -| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `user_location` | [OptionalNullable[components.UserLocation]](../components/userlocation.md) | :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/client-sdks/python/api-reference/components/websearchpluginid.mdx b/client-sdks/python/api-reference/components/websearchpluginid.mdx deleted file mode 100644 index 537cc130..00000000 --- a/client-sdks/python/api-reference/components/websearchpluginid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchPluginID - Python SDK -sidebarTitle: WebSearchPluginID -description: WebSearchPluginID method reference -seoTitle: WebSearchPluginID | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchpluginid -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPluginID | OpenRouter Python SDK -'og:description': >- - WebSearchPluginID method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPluginID%20-%20Python%20SDK&description=WebSearchPluginID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `WEB` | web | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchplugintype.mdx b/client-sdks/python/api-reference/components/websearchplugintype.mdx deleted file mode 100644 index 434fdb97..00000000 --- a/client-sdks/python/api-reference/components/websearchplugintype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchPluginType - Python SDK -sidebarTitle: WebSearchPluginType -description: WebSearchPluginType method reference -seoTitle: WebSearchPluginType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchplugintype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPluginType | OpenRouter Python SDK -'og:description': >- - WebSearchPluginType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPluginType%20-%20Python%20SDK&description=WebSearchPluginType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchservertool.mdx b/client-sdks/python/api-reference/components/websearchservertool.mdx deleted file mode 100644 index 13249c55..00000000 --- a/client-sdks/python/api-reference/components/websearchservertool.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: WebSearchServerTool - Python SDK -sidebarTitle: WebSearchServerTool -description: WebSearchServerTool method reference -seoTitle: WebSearchServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchservertool -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerTool | OpenRouter Python SDK -'og:description': >- - WebSearchServerTool method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerTool%20-%20Python%20SDK&description=WebSearchServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search tool configuration (2025-08-26 version) - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `filters` | [OptionalNullable[components.WebSearchDomainFilter]](../components/websearchdomainfilter.md) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `search_context_size` | [Optional[components.SearchContextSizeEnum]](../components/searchcontextsizeenum.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [components.WebSearchServerToolType](/client-sdks/python/api-reference/components/websearchservertooltype) | :heavy_check_mark: | N/A | | -| `user_location` | [OptionalNullable[components.WebSearchUserLocation]](../components/websearchuserlocation.md) | :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/client-sdks/python/api-reference/components/websearchservertoolconfig.mdx b/client-sdks/python/api-reference/components/websearchservertoolconfig.mdx deleted file mode 100644 index 13890a06..00000000 --- a/client-sdks/python/api-reference/components/websearchservertoolconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchServerToolConfig - Python SDK -sidebarTitle: WebSearchServerToolConfig -description: WebSearchServerToolConfig method reference -seoTitle: WebSearchServerToolConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolConfig | OpenRouter Python SDK -'og:description': >- - WebSearchServerToolConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolConfig%20-%20Python%20SDK&description=WebSearchServerToolConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_search server tool - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [Optional[components.WebSearchEngineEnum]](../components/websearchengineenum.md) | :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. | auto | -| `excluded_domains` | List[*str*] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `max_results` | *Optional[int]* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `max_total_results` | *Optional[int]* | :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 | -| `search_context_size` | [Optional[components.SearchQualityLevel]](../components/searchqualitylevel.md) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `user_location` | [Optional[components.WebSearchUserLocationServerTool]](../components/websearchuserlocationservertool.md) | :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/client-sdks/python/api-reference/components/websearchservertoolopenrouter.mdx b/client-sdks/python/api-reference/components/websearchservertoolopenrouter.mdx deleted file mode 100644 index 317c33aa..00000000 --- a/client-sdks/python/api-reference/components/websearchservertoolopenrouter.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebSearchServerToolOpenRouter - Python SDK -sidebarTitle: WebSearchServerToolOpenRouter -description: WebSearchServerToolOpenRouter method reference -seoTitle: WebSearchServerToolOpenRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolOpenRouter | OpenRouter Python SDK -'og:description': >- - WebSearchServerToolOpenRouter method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolOpenRouter%20-%20Python%20SDK&description=WebSearchServerToolOpenRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `parameters` | [Optional[components.WebSearchServerToolConfig]](../components/websearchservertoolconfig.md) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | `{"max_results": 5,"search_context_size": "medium"}` | -| `type` | [components.WebSearchServerToolOpenRouterType](/client-sdks/python/api-reference/components/websearchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchservertoolopenroutertype.mdx b/client-sdks/python/api-reference/components/websearchservertoolopenroutertype.mdx deleted file mode 100644 index 3dc13af0..00000000 --- a/client-sdks/python/api-reference/components/websearchservertoolopenroutertype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchServerToolOpenRouterType - Python SDK -sidebarTitle: WebSearchServerToolOpenRouterType -description: WebSearchServerToolOpenRouterType method reference -seoTitle: WebSearchServerToolOpenRouterType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolOpenRouterType | OpenRouter Python SDK -'og:description': >- - WebSearchServerToolOpenRouterType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolOpenRouterType%20-%20Python%20SDK&description=WebSearchServerToolOpenRouterType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `OPENROUTER_WEB_SEARCH` | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchservertooltype.mdx b/client-sdks/python/api-reference/components/websearchservertooltype.mdx deleted file mode 100644 index d8594ad2..00000000 --- a/client-sdks/python/api-reference/components/websearchservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchServerToolType - Python SDK -sidebarTitle: WebSearchServerToolType -description: WebSearchServerToolType method reference -seoTitle: WebSearchServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolType | OpenRouter Python SDK -'og:description': >- - WebSearchServerToolType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolType%20-%20Python%20SDK&description=WebSearchServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `WEB_SEARCH_2025_08_26` | web_search_2025_08_26 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchsource.mdx b/client-sdks/python/api-reference/components/websearchsource.mdx deleted file mode 100644 index b45f57ce..00000000 --- a/client-sdks/python/api-reference/components/websearchsource.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: WebSearchSource - Python SDK -sidebarTitle: WebSearchSource -description: WebSearchSource method reference -seoTitle: WebSearchSource | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchsource -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSource | OpenRouter Python SDK -'og:description': >- - WebSearchSource method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSource%20-%20Python%20SDK&description=WebSearchSource%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [components.WebSearchSourceType](/client-sdks/python/api-reference/components/websearchsourcetype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchsourcetype.mdx b/client-sdks/python/api-reference/components/websearchsourcetype.mdx deleted file mode 100644 index ac2ae8ac..00000000 --- a/client-sdks/python/api-reference/components/websearchsourcetype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchSourceType - Python SDK -sidebarTitle: WebSearchSourceType -description: WebSearchSourceType method reference -seoTitle: WebSearchSourceType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchsourcetype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSourceType | OpenRouter Python SDK -'og:description': >- - WebSearchSourceType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSourceType%20-%20Python%20SDK&description=WebSearchSourceType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `URL` | url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchstatus.mdx b/client-sdks/python/api-reference/components/websearchstatus.mdx deleted file mode 100644 index 41195615..00000000 --- a/client-sdks/python/api-reference/components/websearchstatus.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebSearchStatus - Python SDK -sidebarTitle: WebSearchStatus -description: WebSearchStatus method reference -seoTitle: WebSearchStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchstatus -'og:site_name': OpenRouter Documentation -'og:title': WebSearchStatus | OpenRouter Python SDK -'og:description': >- - WebSearchStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchStatus%20-%20Python%20SDK&description=WebSearchStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETED` | completed | -| `SEARCHING` | searching | -| `IN_PROGRESS` | in_progress | -| `FAILED` | failed | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchuserlocation.mdx b/client-sdks/python/api-reference/components/websearchuserlocation.mdx deleted file mode 100644 index 106fc492..00000000 --- a/client-sdks/python/api-reference/components/websearchuserlocation.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchUserLocation - Python SDK -sidebarTitle: WebSearchUserLocation -description: WebSearchUserLocation method reference -seoTitle: WebSearchUserLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocation | OpenRouter Python SDK -'og:description': >- - WebSearchUserLocation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocation%20-%20Python%20SDK&description=WebSearchUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -User location information for web search - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.WebSearchUserLocationType]](../components/websearchuserlocationtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchuserlocationservertool.mdx b/client-sdks/python/api-reference/components/websearchuserlocationservertool.mdx deleted file mode 100644 index f70b264b..00000000 --- a/client-sdks/python/api-reference/components/websearchuserlocationservertool.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: WebSearchUserLocationServerTool - Python SDK -sidebarTitle: WebSearchUserLocationServerTool -description: WebSearchUserLocationServerTool method reference -seoTitle: WebSearchUserLocationServerTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchuserlocationservertool -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerTool | OpenRouter Python SDK -'og:description': >- - WebSearchUserLocationServerTool method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerTool%20-%20Python%20SDK&description=WebSearchUserLocationServerTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased results. - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.WebSearchUserLocationServerToolType]](../components/websearchuserlocationservertooltype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchuserlocationservertooltype.mdx b/client-sdks/python/api-reference/components/websearchuserlocationservertooltype.mdx deleted file mode 100644 index 53a33e01..00000000 --- a/client-sdks/python/api-reference/components/websearchuserlocationservertooltype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchUserLocationServerToolType - Python SDK -sidebarTitle: WebSearchUserLocationServerToolType -description: WebSearchUserLocationServerToolType method reference -seoTitle: WebSearchUserLocationServerToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchuserlocationservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerToolType | OpenRouter Python SDK -'og:description': >- - WebSearchUserLocationServerToolType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerToolType%20-%20Python%20SDK&description=WebSearchUserLocationServerToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/websearchuserlocationtype.mdx b/client-sdks/python/api-reference/components/websearchuserlocationtype.mdx deleted file mode 100644 index 7b98e18b..00000000 --- a/client-sdks/python/api-reference/components/websearchuserlocationtype.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: WebSearchUserLocationType - Python SDK -sidebarTitle: WebSearchUserLocationType -description: WebSearchUserLocationType method reference -seoTitle: WebSearchUserLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/websearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationType | OpenRouter Python SDK -'og:description': >- - WebSearchUserLocationType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationType%20-%20Python%20SDK&description=WebSearchUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/workspace.mdx b/client-sdks/python/api-reference/components/workspace.mdx deleted file mode 100644 index cde6dc3c..00000000 --- a/client-sdks/python/api-reference/components/workspace.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Workspace - Python SDK -sidebarTitle: Workspace -description: Workspace method reference -seoTitle: Workspace | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/components/workspace' -'og:site_name': OpenRouter Documentation -'og:title': Workspace | OpenRouter Python SDK -'og:description': >- - Workspace method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspace%20-%20Python%20SDK&description=Workspace%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `created_by` | *Nullable[str]* | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `default_image_model` | *Nullable[str]* | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *Nullable[str]* | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *Nullable[str]* | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `description` | *Nullable[str]* | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `io_logging_api_key_ids` | List[*int*] | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | `` | -| `io_logging_sampling_rate` | *float* | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `is_data_discount_logging_enabled` | *bool* | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `is_observability_broadcast_enabled` | *bool* | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `is_observability_io_logging_enabled` | *bool* | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `name` | *str* | :heavy_check_mark: | Name of the workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/workspacemember.mdx b/client-sdks/python/api-reference/components/workspacemember.mdx deleted file mode 100644 index 93ce470f..00000000 --- a/client-sdks/python/api-reference/components/workspacemember.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: WorkspaceMember - Python SDK -sidebarTitle: WorkspaceMember -description: WorkspaceMember method reference -seoTitle: WorkspaceMember | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/workspacemember -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMember | OpenRouter Python SDK -'og:description': >- - WorkspaceMember method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMember%20-%20Python%20SDK&description=WorkspaceMember%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [components.WorkspaceMemberRole](/client-sdks/python/api-reference/components/workspacememberrole) | :heavy_check_mark: | Role of the member in the workspace | member | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | -| `workspace_id` | *str* | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/components/workspacememberrole.mdx b/client-sdks/python/api-reference/components/workspacememberrole.mdx deleted file mode 100644 index 849336dc..00000000 --- a/client-sdks/python/api-reference/components/workspacememberrole.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WorkspaceMemberRole - Python SDK -sidebarTitle: WorkspaceMemberRole -description: WorkspaceMemberRole method reference -seoTitle: WorkspaceMemberRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/components/workspacememberrole -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMemberRole | OpenRouter Python SDK -'og:description': >- - WorkspaceMemberRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMemberRole%20-%20Python%20SDK&description=WorkspaceMemberRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Role of the member in the workspace - -## Values - -| Name | Value | -| -------- | -------- | -| `ADMIN` | admin | -| `MEMBER` | member | \ No newline at end of file diff --git a/client-sdks/python/api-reference/credits.mdx b/client-sdks/python/api-reference/credits.mdx deleted file mode 100644 index ec36050c..00000000 --- a/client-sdks/python/api-reference/credits.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Credits - Python SDK -sidebarTitle: Credits -description: Credits method reference -seoTitle: Credits | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/credits' -'og:site_name': OpenRouter Documentation -'og:title': Credits | OpenRouter Python SDK -'og:description': >- - Credits method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Credits%20-%20Python%20SDK&description=Credits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: coins ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Credit management endpoints - -### Available Operations - -* [get_credits](#get_credits) - Get remaining credits - -## get_credits - -Get total credits purchased and used for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getCredits" method="get" path="/credits" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.credits.get_credits() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[operations.GetCreditsResponse](/client-sdks/python/api-reference/operations/getcreditsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/datasets.mdx b/client-sdks/python/api-reference/datasets.mdx deleted file mode 100644 index 5864925f..00000000 --- a/client-sdks/python/api-reference/datasets.mdx +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Datasets - Python SDK -sidebarTitle: Datasets -description: Datasets method reference -seoTitle: Datasets | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/datasets' -'og:site_name': OpenRouter Documentation -'og:title': Datasets | OpenRouter Python SDK -'og:description': >- - Datasets method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datasets%20-%20Python%20SDK&description=Datasets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Datasets endpoints - -### Available Operations - -* [get_rankings_daily](#get_rankings_daily) - Daily token totals for top 50 models - -## get_rankings_daily - -Returns the top 50 public models per day by total token usage on OpenRouter, plus a -single aggregated `other` row per day that sums every model outside that top 50. -Token totals are `prompt_tokens + completion_tokens`, matching the public rankings -chart on openrouter.ai/rankings. - -Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the -reserved permaslug `other` and is always returned last within its date, so callers -can compute `top-50 traffic / total daily traffic` without a second request. - -Authenticate with any valid OpenRouter API key (same key used for inference). -Rate-limited to 30 requests/minute per key and 500 requests/day per account. - -When republishing or quoting this dataset, OpenRouter must be cited as: -"Source: OpenRouter (openrouter.ai/rankings), as of \{as_of\}." - -Token counts come from each upstream provider's own tokenizer (Anthropic counts -are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so -a token in one row is not directly comparable to a token in another row from a -different provider. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getRankingsDaily" method="get" path="/datasets/rankings-daily" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.datasets.get_rankings_daily() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.RankingsDailyResponse](/client-sdks/python/api-reference/components/rankingsdailyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/embeddings.mdx b/client-sdks/python/api-reference/embeddings.mdx deleted file mode 100644 index f87de3f8..00000000 --- a/client-sdks/python/api-reference/embeddings.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: Embeddings - Python SDK -sidebarTitle: Embeddings -description: Embeddings method reference -seoTitle: Embeddings | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/embeddings' -'og:site_name': OpenRouter Documentation -'og:title': Embeddings | OpenRouter Python SDK -'og:description': >- - Embeddings method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embeddings%20-%20Python%20SDK&description=Embeddings%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Text embedding endpoints - -### Available Operations - -* [generate](#generate) - Submit an embedding request -* [list_models](#list_models) - List all embeddings models - -## generate - -Submits an embedding request to the embeddings router - -### Example Usage - -{/* UsageSnippet language="python" operationID="createEmbeddings" method="post" path="/embeddings" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.embeddings.generate(input="The quick brown fox jumps over the lazy dog", model="openai/text-embedding-3-small") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | [operations.InputUnion](/client-sdks/python/api-reference/operations/inputunion) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](/client-sdks/python/api-reference/operations/encodingformat) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | N/A | `{"allow_fallbacks": true}` | -| `user` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.CreateEmbeddingsResponse](/client-sdks/python/api-reference/operations/createembeddingsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_models - -Returns a list of all available embeddings models and their properties - -### Example Usage - -{/* UsageSnippet language="python" operationID="listEmbeddingsModels" method="get" path="/embeddings/models" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.embeddings.list_models() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[components.ModelsListResponse](/client-sdks/python/api-reference/components/modelslistresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/endpoints.mdx b/client-sdks/python/api-reference/endpoints.mdx deleted file mode 100644 index 586cedeb..00000000 --- a/client-sdks/python/api-reference/endpoints.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: Endpoints - Python SDK -sidebarTitle: Endpoints -description: Endpoints method reference -seoTitle: Endpoints | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/endpoints' -'og:site_name': OpenRouter Documentation -'og:title': Endpoints | OpenRouter Python SDK -'og:description': >- - Endpoints method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Endpoints%20-%20Python%20SDK&description=Endpoints%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: network-wired ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Endpoint information - -### Available Operations - -* [list_zdr_endpoints](#list_zdr_endpoints) - Preview the impact of ZDR on the available endpoints -* [list](#list) - List all endpoints for a model - -## list_zdr_endpoints - -Preview the impact of ZDR on the available endpoints - -### Example Usage - -{/* UsageSnippet language="python" operationID="listEndpointsZdr" method="get" path="/endpoints/zdr" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.endpoints.list_zdr_endpoints() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[operations.ListEndpointsZdrResponse](/client-sdks/python/api-reference/operations/listendpointszdrresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list - -List all endpoints for a model - -### Example Usage - -{/* UsageSnippet language="python" operationID="listEndpoints" method="get" path="/models/{author}/{slug}/endpoints" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.endpoints.list(author="openai", slug="gpt-4") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListEndpointsResponse](/client-sdks/python/api-reference/operations/listendpointsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/badgatewayresponseerror.mdx b/client-sdks/python/api-reference/errors/badgatewayresponseerror.mdx deleted file mode 100644 index 3dfe7cdb..00000000 --- a/client-sdks/python/api-reference/errors/badgatewayresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadGatewayResponseError - Python SDK -sidebarTitle: BadGatewayResponseError -description: BadGatewayResponseError error handling -seoTitle: BadGatewayResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/badgatewayresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseError Error | OpenRouter Python SDK -'og:description': >- - BadGatewayResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseError%20-%20Python%20SDK&description=BadGatewayResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Bad Gateway - Provider/upstream API failure - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadGatewayResponseErrorData](/client-sdks/python/api-reference/components/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | `{"code": 502,"message": "Provider returned error"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/badrequestresponseerror.mdx b/client-sdks/python/api-reference/errors/badrequestresponseerror.mdx deleted file mode 100644 index 3c9aa498..00000000 --- a/client-sdks/python/api-reference/errors/badrequestresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BadRequestResponseError - Python SDK -sidebarTitle: BadRequestResponseError -description: BadRequestResponseError error handling -seoTitle: BadRequestResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/badrequestresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseError Error | OpenRouter Python SDK -'og:description': >- - BadRequestResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseError%20-%20Python%20SDK&description=BadRequestResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Bad Request - Invalid request parameters or malformed input - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadRequestResponseErrorData](/client-sdks/python/api-reference/components/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | `{"code": 400,"message": "Invalid request parameters"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/conflictresponseerror.mdx b/client-sdks/python/api-reference/errors/conflictresponseerror.mdx deleted file mode 100644 index 9bd60439..00000000 --- a/client-sdks/python/api-reference/errors/conflictresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ConflictResponseError - Python SDK -sidebarTitle: ConflictResponseError -description: ConflictResponseError error handling -seoTitle: ConflictResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/conflictresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseError Error | OpenRouter Python SDK -'og:description': >- - ConflictResponseError error documentation for the OpenRouter Python SDK. Learn - how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseError%20-%20Python%20SDK&description=ConflictResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Conflict - Resource conflict or concurrent modification - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.ConflictResponseErrorData](/client-sdks/python/api-reference/components/conflictresponseerrordata) | :heavy_check_mark: | Error data for ConflictResponse | `{"code": 409,"message": "Resource conflict. Please try again later."}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/edgenetworktimeoutresponseerror.mdx b/client-sdks/python/api-reference/errors/edgenetworktimeoutresponseerror.mdx deleted file mode 100644 index 8ced2a1f..00000000 --- a/client-sdks/python/api-reference/errors/edgenetworktimeoutresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseError - Python SDK -sidebarTitle: EdgeNetworkTimeoutResponseError -description: EdgeNetworkTimeoutResponseError error handling -seoTitle: EdgeNetworkTimeoutResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/edgenetworktimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseError Error | OpenRouter Python SDK -'og:description': >- - EdgeNetworkTimeoutResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseError%20-%20Python%20SDK&description=EdgeNetworkTimeoutResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Infrastructure Timeout - Provider request timed out at edge network - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.EdgeNetworkTimeoutResponseErrorData](/client-sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | `{"code": 524,"message": "Request timed out. Please try again later."}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/forbiddenresponseerror.mdx b/client-sdks/python/api-reference/errors/forbiddenresponseerror.mdx deleted file mode 100644 index 4830ac56..00000000 --- a/client-sdks/python/api-reference/errors/forbiddenresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ForbiddenResponseError - Python SDK -sidebarTitle: ForbiddenResponseError -description: ForbiddenResponseError error handling -seoTitle: ForbiddenResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/forbiddenresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseError Error | OpenRouter Python SDK -'og:description': >- - ForbiddenResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseError%20-%20Python%20SDK&description=ForbiddenResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Forbidden - Authentication successful but insufficient permissions - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `error` | [components.ForbiddenResponseErrorData](/client-sdks/python/api-reference/components/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | `{"code": 403,"message": "Only management keys can perform this operation"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/internalserverresponseerror.mdx b/client-sdks/python/api-reference/errors/internalserverresponseerror.mdx deleted file mode 100644 index 3f8f9b8b..00000000 --- a/client-sdks/python/api-reference/errors/internalserverresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: InternalServerResponseError - Python SDK -sidebarTitle: InternalServerResponseError -description: InternalServerResponseError error handling -seoTitle: InternalServerResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/internalserverresponseerror -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseError Error | OpenRouter Python SDK -'og:description': >- - InternalServerResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseError%20-%20Python%20SDK&description=InternalServerResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Internal Server Error - Unexpected server error - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.InternalServerResponseErrorData](/client-sdks/python/api-reference/components/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | `{"code": 500,"message": "Internal Server Error"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/notfoundresponseerror.mdx b/client-sdks/python/api-reference/errors/notfoundresponseerror.mdx deleted file mode 100644 index 88a6a537..00000000 --- a/client-sdks/python/api-reference/errors/notfoundresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: NotFoundResponseError - Python SDK -sidebarTitle: NotFoundResponseError -description: NotFoundResponseError error handling -seoTitle: NotFoundResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/notfoundresponseerror -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseError Error | OpenRouter Python SDK -'og:description': >- - NotFoundResponseError error documentation for the OpenRouter Python SDK. Learn - how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseError%20-%20Python%20SDK&description=NotFoundResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Not Found - Resource does not exist - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.NotFoundResponseErrorData](/client-sdks/python/api-reference/components/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | `{"code": 404,"message": "Resource not found"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/payloadtoolargeresponseerror.mdx b/client-sdks/python/api-reference/errors/payloadtoolargeresponseerror.mdx deleted file mode 100644 index 4b438ae6..00000000 --- a/client-sdks/python/api-reference/errors/payloadtoolargeresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PayloadTooLargeResponseError - Python SDK -sidebarTitle: PayloadTooLargeResponseError -description: PayloadTooLargeResponseError error handling -seoTitle: PayloadTooLargeResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/payloadtoolargeresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseError Error | OpenRouter Python SDK -'og:description': >- - PayloadTooLargeResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseError%20-%20Python%20SDK&description=PayloadTooLargeResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Payload Too Large - Request payload exceeds size limits - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PayloadTooLargeResponseErrorData](/client-sdks/python/api-reference/components/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | `{"code": 413,"message": "Request payload too large"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/paymentrequiredresponseerror.mdx b/client-sdks/python/api-reference/errors/paymentrequiredresponseerror.mdx deleted file mode 100644 index b0361f1e..00000000 --- a/client-sdks/python/api-reference/errors/paymentrequiredresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: PaymentRequiredResponseError - Python SDK -sidebarTitle: PaymentRequiredResponseError -description: PaymentRequiredResponseError error handling -seoTitle: PaymentRequiredResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/paymentrequiredresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseError Error | OpenRouter Python SDK -'og:description': >- - PaymentRequiredResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseError%20-%20Python%20SDK&description=PaymentRequiredResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Payment Required - Insufficient credits or quota to complete request - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PaymentRequiredResponseErrorData](/client-sdks/python/api-reference/components/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | `{"code": 402,"message": "Insufficient credits. Add more using https://openrouter.ai/credits"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/provideroverloadedresponseerror.mdx b/client-sdks/python/api-reference/errors/provideroverloadedresponseerror.mdx deleted file mode 100644 index 8cd9fbe8..00000000 --- a/client-sdks/python/api-reference/errors/provideroverloadedresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderOverloadedResponseError - Python SDK -sidebarTitle: ProviderOverloadedResponseError -description: ProviderOverloadedResponseError error handling -seoTitle: ProviderOverloadedResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/provideroverloadedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseError Error | OpenRouter Python SDK -'og:description': >- - ProviderOverloadedResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseError%20-%20Python%20SDK&description=ProviderOverloadedResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider Overloaded - Provider is temporarily overloaded - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ProviderOverloadedResponseErrorData](/client-sdks/python/api-reference/components/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | `{"code": 529,"message": "Provider returned error"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/requesttimeoutresponseerror.mdx b/client-sdks/python/api-reference/errors/requesttimeoutresponseerror.mdx deleted file mode 100644 index c007e8e1..00000000 --- a/client-sdks/python/api-reference/errors/requesttimeoutresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: RequestTimeoutResponseError - Python SDK -sidebarTitle: RequestTimeoutResponseError -description: RequestTimeoutResponseError error handling -seoTitle: RequestTimeoutResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/requesttimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseError Error | OpenRouter Python SDK -'og:description': >- - RequestTimeoutResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseError%20-%20Python%20SDK&description=RequestTimeoutResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request Timeout - Operation exceeded time limit - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.RequestTimeoutResponseErrorData](/client-sdks/python/api-reference/components/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | `{"code": 408,"message": "Operation timed out. Please try again later."}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/serviceunavailableresponseerror.mdx b/client-sdks/python/api-reference/errors/serviceunavailableresponseerror.mdx deleted file mode 100644 index a0db0436..00000000 --- a/client-sdks/python/api-reference/errors/serviceunavailableresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ServiceUnavailableResponseError - Python SDK -sidebarTitle: ServiceUnavailableResponseError -description: ServiceUnavailableResponseError error handling -seoTitle: ServiceUnavailableResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/serviceunavailableresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseError Error | OpenRouter Python SDK -'og:description': >- - ServiceUnavailableResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseError%20-%20Python%20SDK&description=ServiceUnavailableResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Service Unavailable - Service temporarily unavailable - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ServiceUnavailableResponseErrorData](/client-sdks/python/api-reference/components/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | `{"code": 503,"message": "Service temporarily unavailable"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/toomanyrequestsresponseerror.mdx b/client-sdks/python/api-reference/errors/toomanyrequestsresponseerror.mdx deleted file mode 100644 index 6c8647ea..00000000 --- a/client-sdks/python/api-reference/errors/toomanyrequestsresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: TooManyRequestsResponseError - Python SDK -sidebarTitle: TooManyRequestsResponseError -description: TooManyRequestsResponseError error handling -seoTitle: TooManyRequestsResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/toomanyrequestsresponseerror -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseError Error | OpenRouter Python SDK -'og:description': >- - TooManyRequestsResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseError%20-%20Python%20SDK&description=TooManyRequestsResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Too Many Requests - Rate limit exceeded - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.TooManyRequestsResponseErrorData](/client-sdks/python/api-reference/components/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | `{"code": 429,"message": "Rate limit exceeded"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/unauthorizedresponseerror.mdx b/client-sdks/python/api-reference/errors/unauthorizedresponseerror.mdx deleted file mode 100644 index 443fae8c..00000000 --- a/client-sdks/python/api-reference/errors/unauthorizedresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnauthorizedResponseError - Python SDK -sidebarTitle: UnauthorizedResponseError -description: UnauthorizedResponseError error handling -seoTitle: UnauthorizedResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/unauthorizedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseError Error | OpenRouter Python SDK -'og:description': >- - UnauthorizedResponseError error documentation for the OpenRouter Python SDK. - Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseError%20-%20Python%20SDK&description=UnauthorizedResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unauthorized - Authentication required or invalid credentials - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.UnauthorizedResponseErrorData](/client-sdks/python/api-reference/components/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | `{"code": 401,"message": "Missing Authentication header"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/errors/unprocessableentityresponseerror.mdx b/client-sdks/python/api-reference/errors/unprocessableentityresponseerror.mdx deleted file mode 100644 index 082ef195..00000000 --- a/client-sdks/python/api-reference/errors/unprocessableentityresponseerror.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UnprocessableEntityResponseError - Python SDK -sidebarTitle: UnprocessableEntityResponseError -description: UnprocessableEntityResponseError error handling -seoTitle: UnprocessableEntityResponseError Error | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/errors/unprocessableentityresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseError Error | OpenRouter Python SDK -'og:description': >- - UnprocessableEntityResponseError error documentation for the OpenRouter Python - SDK. Learn how to handle this error type. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseError%20-%20Python%20SDK&description=UnprocessableEntityResponseError%20error%20handling -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unprocessable Entity - Semantic validation failure - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `error` | [components.UnprocessableEntityResponseErrorData](/client-sdks/python/api-reference/components/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | `{"code": 422,"message": "Invalid argument"}` | -| `openrouter_metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/generations.mdx b/client-sdks/python/api-reference/generations.mdx deleted file mode 100644 index a7e221d5..00000000 --- a/client-sdks/python/api-reference/generations.mdx +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: Generations - Python SDK -sidebarTitle: Generations -description: Generations method reference -seoTitle: Generations | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/generations' -'og:site_name': OpenRouter Documentation -'og:title': Generations | OpenRouter Python SDK -'og:description': >- - Generations method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Generations%20-%20Python%20SDK&description=Generations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: diagram-project ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Generation history endpoints - -### Available Operations - -* [get_generation](#get_generation) - Get request & usage metadata for a generation -* [list_generation_content](#list_generation_content) - Get stored prompt and completion content for a generation - -## get_generation - -Get request & usage metadata for a generation - -### Example Usage - -{/* UsageSnippet language="python" operationID="getGeneration" method="get" path="/generation" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.generations.get_generation(id="gen-1234567890") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GenerationResponse](/client-sdks/python/api-reference/components/generationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_generation_content - -Get stored prompt and completion content for a generation - -### Example Usage - -{/* UsageSnippet language="python" operationID="listGenerationContent" method="get" path="/generation/content" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.generations.list_generation_content(id="gen-1234567890") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GenerationContentResponse](/client-sdks/python/api-reference/components/generationcontentresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/guardrails.mdx b/client-sdks/python/api-reference/guardrails.mdx deleted file mode 100644 index df9d3012..00000000 --- a/client-sdks/python/api-reference/guardrails.mdx +++ /dev/null @@ -1,741 +0,0 @@ ---- -title: Guardrails - Python SDK -sidebarTitle: Guardrails -description: Guardrails method reference -seoTitle: Guardrails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/guardrails' -'og:site_name': OpenRouter Documentation -'og:title': Guardrails | OpenRouter Python SDK -'og:description': >- - Guardrails method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrails%20-%20Python%20SDK&description=Guardrails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Guardrails endpoints - -### Available Operations - -* [list](#list) - List guardrails -* [create](#create) - Create a guardrail -* [delete](#delete) - Delete a guardrail -* [get](#get) - Get a guardrail -* [update](#update) - Update a guardrail -* [list_guardrail_key_assignments](#list_guardrail_key_assignments) - List key assignments for a guardrail -* [bulk_assign_keys](#bulk_assign_keys) - Bulk assign keys to a guardrail -* [bulk_unassign_keys](#bulk_unassign_keys) - Bulk unassign keys from a guardrail -* [list_guardrail_member_assignments](#list_guardrail_member_assignments) - List member assignments for a guardrail -* [bulk_assign_members](#bulk_assign_members) - Bulk assign members to a guardrail -* [bulk_unassign_members](#bulk_unassign_members) - Bulk unassign members from a guardrail -* [list_key_assignments](#list_key_assignments) - List all key assignments -* [list_member_assignments](#list_member_assignments) - List all member assignments - -## list - -List all guardrails for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listGuardrails" method="get" path="/guardrails" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.list() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListGuardrailsResponse](/client-sdks/python/api-reference/operations/listguardrailsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new guardrail for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createGuardrail" method="post" path="/guardrails" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.create(name="My New Guardrail", allowed_models=None, allowed_providers=[ - "openai", - "anthropic", - "deepseek", - ], description="A guardrail for limiting API usage", enforce_zdr_anthropic=True, enforce_zdr_google=False, enforce_zdr_openai=True, enforce_zdr_other=False, ignored_models=None, ignored_providers=None, limit_usd=50, reset_interval="monthly") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_models` | List[*str*] | :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"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `content_filters` | List[[components.ContentFilterEntry](/client-sdks/python/api-reference/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[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforce_zdr_other` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 50 | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](/client-sdks/python/api-reference/components/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | The workspace to create the guardrail in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreateGuardrailResponse](/client-sdks/python/api-reference/components/createguardrailresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="deleteGuardrail" method="delete" path="/guardrails/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.delete(id="550e8400-e29b-41d4-a716-446655440000") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.DeleteGuardrailResponse](/client-sdks/python/api-reference/components/deleteguardrailresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single guardrail by ID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getGuardrail" method="get" path="/guardrails/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.get(id="550e8400-e29b-41d4-a716-446655440000") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GetGuardrailResponse](/client-sdks/python/api-reference/components/getguardrailresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="updateGuardrail" method="patch" path="/guardrails/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.update(id="550e8400-e29b-41d4-a716-446655440000", description="Updated description", limit_usd=75, name="Updated Guardrail Name", reset_interval="weekly") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `content_filter_builtins` | List[[components.ContentFilterBuiltinEntryInput](/client-sdks/python/api-reference/components/contentfilterbuiltinentryinput)] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `content_filters` | List[[components.ContentFilterEntry](/client-sdks/python/api-reference/components/contentfilterentry)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | `` | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `enforce_zdr_anthropic` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_google` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_openai` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforce_zdr_other` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | true | -| `ignored_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignored_providers` | List[*str*] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `reset_interval` | [OptionalNullable[components.GuardrailInterval]](/client-sdks/python/api-reference/components/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.UpdateGuardrailResponse](/client-sdks/python/api-reference/components/updateguardrailresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_guardrail_key_assignments - -List all API key assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listGuardrailKeyAssignments" method="get" path="/guardrails/{id}/assignments/keys" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.list_guardrail_key_assignments(id="550e8400-e29b-41d4-a716-446655440000") - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListGuardrailKeyAssignmentsResponse](/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_assign_keys - -Assign multiple API keys to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkAssignKeysToGuardrail" method="post" path="/guardrails/{id}/assignments/keys" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.bulk_assign_keys(id="550e8400-e29b-41d4-a716-446655440000", key_hashes=[ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkAssignKeysResponse](/client-sdks/python/api-reference/components/bulkassignkeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_unassign_keys - -Unassign multiple API keys from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkUnassignKeysFromGuardrail" method="post" path="/guardrails/{id}/assignments/keys/remove" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.bulk_unassign_keys(id="550e8400-e29b-41d4-a716-446655440000", key_hashes=[ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkUnassignKeysResponse](/client-sdks/python/api-reference/components/bulkunassignkeysresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_guardrail_member_assignments - -List all organization member assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listGuardrailMemberAssignments" method="get" path="/guardrails/{id}/assignments/members" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.list_guardrail_member_assignments(id="550e8400-e29b-41d4-a716-446655440000") - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListGuardrailMemberAssignmentsResponse](/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_assign_members - -Assign multiple organization members to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkAssignMembersToGuardrail" method="post" path="/guardrails/{id}/assignments/members" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.bulk_assign_members(id="550e8400-e29b-41d4-a716-446655440000", member_user_ids=[ - "user_abc123", - "user_def456", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkAssignMembersResponse](/client-sdks/python/api-reference/components/bulkassignmembersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_unassign_members - -Unassign multiple organization members from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkUnassignMembersFromGuardrail" method="post" path="/guardrails/{id}/assignments/members/remove" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.bulk_unassign_members(id="550e8400-e29b-41d4-a716-446655440000", member_user_ids=[ - "user_abc123", - "user_def456", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkUnassignMembersResponse](/client-sdks/python/api-reference/components/bulkunassignmembersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_key_assignments - -List all API key guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listKeyAssignments" method="get" path="/guardrails/assignments/keys" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.list_key_assignments() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListKeyAssignmentsResponse](/client-sdks/python/api-reference/operations/listkeyassignmentsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_member_assignments - -List all organization member guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listMemberAssignments" method="get" path="/guardrails/assignments/members" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.guardrails.list_member_assignments() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListMemberAssignmentsResponse](/client-sdks/python/api-reference/operations/listmemberassignmentsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/models.mdx b/client-sdks/python/api-reference/models.mdx deleted file mode 100644 index 1f43ae58..00000000 --- a/client-sdks/python/api-reference/models.mdx +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: Models - Python SDK -sidebarTitle: Models -description: Models method reference -seoTitle: Models | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/models' -'og:site_name': OpenRouter Documentation -'og:title': Models | OpenRouter Python SDK -'og:description': >- - Models method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Models%20-%20Python%20SDK&description=Models%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Model information endpoints - -### Available Operations - -* [list](#list) - List all models and their properties -* [count](#count) - Get total count of available models -* [list_for_user](#list_for_user) - List models filtered by user provider preferences, privacy settings, and guardrails - -## list - -List all models and their properties - -### Example Usage - -{/* UsageSnippet language="python" operationID="getModels" method="get" path="/models" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.models.list() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.Category]](/client-sdks/python/api-reference/operations/category) | :heavy_minus_sign: | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.ModelsListResponse](/client-sdks/python/api-reference/components/modelslistresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## count - -Get total count of available models - -### Example Usage - -{/* UsageSnippet language="python" operationID="listModelsCount" method="get" path="/models/count" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.models.count() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | :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 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.ModelsCountResponse](/client-sdks/python/api-reference/components/modelscountresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_for_user - -List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing). - -### Example Usage - -{/* UsageSnippet language="python" operationID="listModelsUser" method="get" path="/models/user" */} -```python lines -from openrouter import OpenRouter, operations -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", -) as open_router: - - res = open_router.models.list_for_user(security=operations.ListModelsUserSecurity( - bearer=os.getenv("OPENROUTER_BEARER", ""), - )) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `security` | [operations.ListModelsUserSecurity](/client-sdks/python/api-reference/operations/listmodelsusersecurity) | :heavy_check_mark: | N/A | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[components.ModelsListResponse](/client-sdks/python/api-reference/components/modelslistresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/models/globals.mdx b/client-sdks/python/api-reference/models/globals.mdx deleted file mode 100644 index d1eafea4..00000000 --- a/client-sdks/python/api-reference/models/globals.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Globals - Python SDK -sidebarTitle: Globals -description: Globals type definition -seoTitle: Globals Type | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/models/globals' -'og:site_name': OpenRouter Documentation -'og:title': Globals Type | OpenRouter Python SDK -'og:description': >- - Globals type reference for the OpenRouter Python SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Globals%20-%20Python%20SDK&description=Globals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/models/retryconfig.mdx b/client-sdks/python/api-reference/models/retryconfig.mdx deleted file mode 100644 index 5f2c0db7..00000000 --- a/client-sdks/python/api-reference/models/retryconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: RetryConfig - Python SDK -sidebarTitle: RetryConfig -description: RetryConfig type definition -seoTitle: RetryConfig Type | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/models/retryconfig' -'og:site_name': OpenRouter Documentation -'og:title': RetryConfig Type | OpenRouter Python SDK -'og:description': >- - RetryConfig type reference for the OpenRouter Python SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RetryConfig%20-%20Python%20SDK&description=RetryConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Allows customizing the default retry configuration. Only usable with methods that mention they support retries. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | --------------------------------------- | --------- | -| `strategy` | `*str*` | The retry strategy to use. | `backoff` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | Configuration for the backoff strategy. | | -| `retry_connection_errors` | `*bool*` | Whether to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | --------- | ----------------------------------------- | -------- | -| `initial_interval` | `*int*` | The initial interval in milliseconds. | `500` | -| `max_interval` | `*int*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*float*` | The exponent to use for the backoff. | `1.5` | -| `max_elapsed_time` | `*int*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/oauth.mdx b/client-sdks/python/api-reference/oauth.mdx deleted file mode 100644 index fb5f64cd..00000000 --- a/client-sdks/python/api-reference/oauth.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: OAuth - Python SDK -sidebarTitle: OAuth -description: OAuth method reference -seoTitle: OAuth | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/oauth' -'og:site_name': OpenRouter Documentation -'og:title': OAuth | OpenRouter Python SDK -'og:description': >- - OAuth method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OAuth%20-%20Python%20SDK&description=OAuth%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: shield-check ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -OAuth authentication endpoints - -### Available Operations - -* [exchange_auth_code_for_api_key](#exchange_auth_code_for_api_key) - Exchange authorization code for API key -* [create_auth_code](#create_auth_code) - Create authorization code - -## exchange_auth_code_for_api_key - -Exchange an authorization code from the PKCE flow for a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="python" operationID="exchangeAuthCodeForAPIKey" method="post" path="/auth/keys" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.o_auth.exchange_auth_code_for_api_key(code="auth_code_abc123def456", code_challenge_method="S256", code_verifier="dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ExchangeAuthCodeForAPIKeyResponse](/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create_auth_code - -Create an authorization code for the PKCE flow to generate a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="python" operationID="createAuthKeysCode" method="post" path="/auth/keys/code" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.o_auth.create_auth_code(callback_url="https://myapp.com/auth/callback", code_challenge="E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", code_challenge_method="S256", limit=100) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](/client-sdks/python/api-reference/operations/createauthkeyscodecodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional expiration time for the API key to be created | 2027-12-31T23:59:59Z | -| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](/client-sdks/python/api-reference/operations/usagelimittype) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.CreateAuthKeysCodeResponse](/client-sdks/python/api-reference/operations/createauthkeyscoderesponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/observability.mdx b/client-sdks/python/api-reference/observability.mdx deleted file mode 100644 index 96c18670..00000000 --- a/client-sdks/python/api-reference/observability.mdx +++ /dev/null @@ -1,306 +0,0 @@ ---- -title: Observability - Python SDK -sidebarTitle: Observability -description: Observability method reference -seoTitle: Observability | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/observability' -'og:site_name': OpenRouter Documentation -'og:title': Observability | OpenRouter Python SDK -'og:description': >- - Observability method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Observability%20-%20Python%20SDK&description=Observability%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Observability endpoints - -### Available Operations - -* [list](#list) - List observability destinations -* [create](#create) - Create an observability destination -* [delete](#delete) - Delete an observability destination -* [get](#get) - Get an observability destination -* [update](#update) - Update an observability destination - -## list - -List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listObservabilityDestinations" method="get" path="/observability/destinations" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.observability.list() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListObservabilityDestinationsResponse](/client-sdks/python/api-reference/operations/listobservabilitydestinationsresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createObservabilityDestination" method="post" path="/observability/destinations" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.observability.create(config={ - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, name="Production Langfuse", type_="langfuse", enabled=True, privacy_mode=False) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `config` | Dict[str, *Nullable[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"}` | -| `name` | *str* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `type` | [components.CreateObservabilityDestinationRequestType](/client-sdks/python/api-reference/components/createobservabilitydestinationrequesttype) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | :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. | `` | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfig]](/client-sdks/python/api-reference/components/observabilityfilterrulesconfig) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | `` | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreateObservabilityDestinationResponse](/client-sdks/python/api-reference/components/createobservabilitydestinationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing observability destination. This performs a soft delete. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="deleteObservabilityDestination" method="delete" path="/observability/destinations/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.observability.delete(id="99999999-aaaa-bbbb-cccc-dddddddddddd") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.DeleteObservabilityDestinationResponse](/client-sdks/python/api-reference/components/deleteobservabilitydestinationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Fetch a single observability destination by its UUID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getObservabilityDestination" method="get" path="/observability/destinations/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.observability.get(id="99999999-aaaa-bbbb-cccc-dddddddddddd") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GetObservabilityDestinationResponse](/client-sdks/python/api-reference/components/getobservabilitydestinationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="updateObservabilityDestination" method="patch" path="/observability/destinations/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.observability.update(id="99999999-aaaa-bbbb-cccc-dddddddddddd", enabled=False, name="Updated Langfuse") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `api_key_hashes` | List[*str*] | :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. | `` | -| `config` | Dict[str, *Nullable[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` | *Optional[bool]* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filter_rules` | [OptionalNullable[components.ObservabilityFilterRulesConfig]](/client-sdks/python/api-reference/components/observabilityfilterrulesconfig) | :heavy_minus_sign: | N/A | `` | -| `name` | *Optional[str]* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacy_mode` | *Optional[bool]* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.UpdateObservabilityDestinationResponse](/client-sdks/python/api-reference/components/updateobservabilitydestinationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkaddworkspacemembersglobals.mdx b/client-sdks/python/api-reference/operations/bulkaddworkspacemembersglobals.mdx deleted file mode 100644 index 0a85c485..00000000 --- a/client-sdks/python/api-reference/operations/bulkaddworkspacemembersglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkAddWorkspaceMembersGlobals - Python SDK -sidebarTitle: BulkAddWorkspaceMembersGlobals -description: BulkAddWorkspaceMembersGlobals method reference -seoTitle: BulkAddWorkspaceMembersGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkaddworkspacemembersglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersGlobals | OpenRouter Python SDK -'og:description': >- - BulkAddWorkspaceMembersGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersGlobals%20-%20Python%20SDK&description=BulkAddWorkspaceMembersGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkaddworkspacemembersrequest.mdx b/client-sdks/python/api-reference/operations/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index cf2dcbdb..00000000 --- a/client-sdks/python/api-reference/operations/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - Python SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest method reference -seoTitle: BulkAddWorkspaceMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkAddWorkspaceMembersRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20Python%20SDK&description=BulkAddWorkspaceMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulk_add_workspace_members_request` | [components.BulkAddWorkspaceMembersRequest](/client-sdks/python/api-reference/components/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailglobals.mdx b/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailglobals.mdx deleted file mode 100644 index eb401693..00000000 --- a/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailGlobals - Python SDK -sidebarTitle: BulkAssignKeysToGuardrailGlobals -description: BulkAssignKeysToGuardrailGlobals method reference -seoTitle: BulkAssignKeysToGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkassignkeystoguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysToGuardrailGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailGlobals%20-%20Python%20SDK&description=BulkAssignKeysToGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailrequest.mdx b/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailrequest.mdx deleted file mode 100644 index 62e212e1..00000000 --- a/client-sdks/python/api-reference/operations/bulkassignkeystoguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequest - Python SDK -sidebarTitle: BulkAssignKeysToGuardrailRequest -description: BulkAssignKeysToGuardrailRequest method reference -seoTitle: BulkAssignKeysToGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkassignkeystoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysToGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequest%20-%20Python%20SDK&description=BulkAssignKeysToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_keys_request` | [components.BulkAssignKeysRequest](/client-sdks/python/api-reference/components/bulkassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx b/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx deleted file mode 100644 index 6969b33c..00000000 --- a/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailGlobals - Python SDK -sidebarTitle: BulkAssignMembersToGuardrailGlobals -description: BulkAssignMembersToGuardrailGlobals method reference -seoTitle: BulkAssignMembersToGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkassignmemberstoguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersToGuardrailGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailGlobals%20-%20Python%20SDK&description=BulkAssignMembersToGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx b/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx deleted file mode 100644 index 7474e299..00000000 --- a/client-sdks/python/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequest - Python SDK -sidebarTitle: BulkAssignMembersToGuardrailRequest -description: BulkAssignMembersToGuardrailRequest method reference -seoTitle: BulkAssignMembersToGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkassignmemberstoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersToGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequest%20-%20Python%20SDK&description=BulkAssignMembersToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_assign_members_request` | [components.BulkAssignMembersRequest](/client-sdks/python/api-reference/components/bulkassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersglobals.mdx b/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersglobals.mdx deleted file mode 100644 index 4bce35bb..00000000 --- a/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersGlobals - Python SDK -sidebarTitle: BulkRemoveWorkspaceMembersGlobals -description: BulkRemoveWorkspaceMembersGlobals method reference -seoTitle: BulkRemoveWorkspaceMembersGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkremoveworkspacemembersglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersGlobals | OpenRouter Python SDK -'og:description': >- - BulkRemoveWorkspaceMembersGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersGlobals%20-%20Python%20SDK&description=BulkRemoveWorkspaceMembersGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersrequest.mdx b/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index 67d279a9..00000000 --- a/client-sdks/python/api-reference/operations/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - Python SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest method reference -seoTitle: BulkRemoveWorkspaceMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest | OpenRouter Python SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20Python%20SDK&description=BulkRemoveWorkspaceMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulk_remove_workspace_members_request` | [components.BulkRemoveWorkspaceMembersRequest](/client-sdks/python/api-reference/components/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx b/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx deleted file mode 100644 index 4b530024..00000000 --- a/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailGlobals - Python SDK -sidebarTitle: BulkUnassignKeysFromGuardrailGlobals -description: BulkUnassignKeysFromGuardrailGlobals method reference -seoTitle: BulkUnassignKeysFromGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkunassignkeysfromguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysFromGuardrailGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailGlobals%20-%20Python%20SDK&description=BulkUnassignKeysFromGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx b/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx deleted file mode 100644 index fd849596..00000000 --- a/client-sdks/python/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequest - Python SDK -sidebarTitle: BulkUnassignKeysFromGuardrailRequest -description: BulkUnassignKeysFromGuardrailRequest method reference -seoTitle: BulkUnassignKeysFromGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkunassignkeysfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequest%20-%20Python%20SDK&description=BulkUnassignKeysFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_keys_request` | [components.BulkUnassignKeysRequest](/client-sdks/python/api-reference/components/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx b/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx deleted file mode 100644 index 3b83bc10..00000000 --- a/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailGlobals - Python SDK -sidebarTitle: BulkUnassignMembersFromGuardrailGlobals -description: BulkUnassignMembersFromGuardrailGlobals method reference -seoTitle: BulkUnassignMembersFromGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkunassignmembersfromguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersFromGuardrailGlobals method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailGlobals%20-%20Python%20SDK&description=BulkUnassignMembersFromGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx b/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx deleted file mode 100644 index 99d76281..00000000 --- a/client-sdks/python/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequest - Python SDK -sidebarTitle: BulkUnassignMembersFromGuardrailRequest -description: BulkUnassignMembersFromGuardrailRequest method reference -seoTitle: BulkUnassignMembersFromGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/bulkunassignmembersfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequest method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequest%20-%20Python%20SDK&description=BulkUnassignMembersFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulk_unassign_members_request` | [components.BulkUnassignMembersRequest](/client-sdks/python/api-reference/components/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/category.mdx b/client-sdks/python/api-reference/operations/category.mdx deleted file mode 100644 index 4daa16e3..00000000 --- a/client-sdks/python/api-reference/operations/category.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Category - Python SDK -sidebarTitle: Category -description: Category method reference -seoTitle: Category | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/category' -'og:site_name': OpenRouter Documentation -'og:title': Category | OpenRouter Python SDK -'og:description': >- - Category method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Category%20-%20Python%20SDK&description=Category%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Filter models by use case category - -## Values - -| Name | Value | -| --------------- | --------------- | -| `PROGRAMMING` | programming | -| `ROLEPLAY` | roleplay | -| `MARKETING` | marketing | -| `MARKETING_SEO` | marketing/seo | -| `TECHNOLOGY` | technology | -| `SCIENCE` | science | -| `TRANSLATION` | translation | -| `LEGAL` | legal | -| `FINANCE` | finance | -| `HEALTH` | health | -| `TRIVIA` | trivia | -| `ACADEMIA` | academia | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/content.mdx b/client-sdks/python/api-reference/operations/content.mdx deleted file mode 100644 index 6c2bd5f8..00000000 --- a/client-sdks/python/api-reference/operations/content.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Content - Python SDK -sidebarTitle: Content -description: Content method reference -seoTitle: Content | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/content' -'og:site_name': OpenRouter Documentation -'og:title': Content | OpenRouter Python SDK -'og:description': >- - Content method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Content%20-%20Python%20SDK&description=Content%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.ContentText` - -```python lines -value: operations.ContentText = /* values here */ -``` - -### `operations.ContentImageURL` - -```python lines -value: operations.ContentImageURL = /* values here */ -``` - -### `components.ContentPartInputAudio` - -```python lines -value: components.ContentPartInputAudio = /* values here */ -``` - -### `components.ContentPartInputVideo` - -```python lines -value: components.ContentPartInputVideo = /* values here */ -``` - -### `components.ContentPartInputFile` - -```python lines -value: components.ContentPartInputFile = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/contentimageurl.mdx b/client-sdks/python/api-reference/operations/contentimageurl.mdx deleted file mode 100644 index d8dfd76f..00000000 --- a/client-sdks/python/api-reference/operations/contentimageurl.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ContentImageURL - Python SDK -sidebarTitle: ContentImageURL -description: ContentImageURL method reference -seoTitle: ContentImageURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/contentimageurl -'og:site_name': OpenRouter Documentation -'og:title': ContentImageURL | OpenRouter Python SDK -'og:description': >- - ContentImageURL method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentImageURL%20-%20Python%20SDK&description=ContentImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `image_url` | [operations.ImageURL](/client-sdks/python/api-reference/operations/imageurl) | :heavy_check_mark: | N/A | -| `type` | [operations.TypeImageURL](/client-sdks/python/api-reference/operations/typeimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/contenttext.mdx b/client-sdks/python/api-reference/operations/contenttext.mdx deleted file mode 100644 index 948d7630..00000000 --- a/client-sdks/python/api-reference/operations/contenttext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ContentText - Python SDK -sidebarTitle: ContentText -description: ContentText method reference -seoTitle: ContentText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/contenttext' -'og:site_name': OpenRouter Documentation -'og:title': ContentText | OpenRouter Python SDK -'og:description': >- - ContentText method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentText%20-%20Python%20SDK&description=ContentText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `text` | *str* | :heavy_check_mark: | N/A | -| `type` | [operations.TypeText](/client-sdks/python/api-reference/operations/typetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createaudiospeechglobals.mdx b/client-sdks/python/api-reference/operations/createaudiospeechglobals.mdx deleted file mode 100644 index 7449d401..00000000 --- a/client-sdks/python/api-reference/operations/createaudiospeechglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAudioSpeechGlobals - Python SDK -sidebarTitle: CreateAudioSpeechGlobals -description: CreateAudioSpeechGlobals method reference -seoTitle: CreateAudioSpeechGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createaudiospeechglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioSpeechGlobals | OpenRouter Python SDK -'og:description': >- - CreateAudioSpeechGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioSpeechGlobals%20-%20Python%20SDK&description=CreateAudioSpeechGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createaudiospeechrequest.mdx b/client-sdks/python/api-reference/operations/createaudiospeechrequest.mdx deleted file mode 100644 index 1001d67d..00000000 --- a/client-sdks/python/api-reference/operations/createaudiospeechrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateAudioSpeechRequest - Python SDK -sidebarTitle: CreateAudioSpeechRequest -description: CreateAudioSpeechRequest method reference -seoTitle: CreateAudioSpeechRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createaudiospeechrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioSpeechRequest | OpenRouter Python SDK -'og:description': >- - CreateAudioSpeechRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioSpeechRequest%20-%20Python%20SDK&description=CreateAudioSpeechRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speech_request` | [components.SpeechRequest](/client-sdks/python/api-reference/components/speechrequest) | :heavy_check_mark: | N/A | `{"input": "Hello world","model": "elevenlabs/eleven-turbo-v2","response_format": "pcm","speed": 1,"voice": "alloy"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createaudiotranscriptionsglobals.mdx b/client-sdks/python/api-reference/operations/createaudiotranscriptionsglobals.mdx deleted file mode 100644 index e0688c61..00000000 --- a/client-sdks/python/api-reference/operations/createaudiotranscriptionsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAudioTranscriptionsGlobals - Python SDK -sidebarTitle: CreateAudioTranscriptionsGlobals -description: CreateAudioTranscriptionsGlobals method reference -seoTitle: CreateAudioTranscriptionsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createaudiotranscriptionsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioTranscriptionsGlobals | OpenRouter Python SDK -'og:description': >- - CreateAudioTranscriptionsGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioTranscriptionsGlobals%20-%20Python%20SDK&description=CreateAudioTranscriptionsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createaudiotranscriptionsrequest.mdx b/client-sdks/python/api-reference/operations/createaudiotranscriptionsrequest.mdx deleted file mode 100644 index 7312c3d8..00000000 --- a/client-sdks/python/api-reference/operations/createaudiotranscriptionsrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateAudioTranscriptionsRequest - Python SDK -sidebarTitle: CreateAudioTranscriptionsRequest -description: CreateAudioTranscriptionsRequest method reference -seoTitle: CreateAudioTranscriptionsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createaudiotranscriptionsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioTranscriptionsRequest | OpenRouter Python SDK -'og:description': >- - CreateAudioTranscriptionsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioTranscriptionsRequest%20-%20Python%20SDK&description=CreateAudioTranscriptionsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `stt_request` | [components.STTRequest](/client-sdks/python/api-reference/components/sttrequest) | :heavy_check_mark: | N/A | `{"input_audio": {"data": "UklGRiQA...","format": "wav"}`,
"language": "en",
"model": "openai/whisper-large-v3"
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscodecodechallengemethod.mdx b/client-sdks/python/api-reference/operations/createauthkeyscodecodechallengemethod.mdx deleted file mode 100644 index fe4a8f94..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscodecodechallengemethod.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateAuthKeysCodeCodeChallengeMethod - Python SDK -sidebarTitle: CreateAuthKeysCodeCodeChallengeMethod -description: CreateAuthKeysCodeCodeChallengeMethod method reference -seoTitle: CreateAuthKeysCodeCodeChallengeMethod | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscodecodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeCodeChallengeMethod | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeCodeChallengeMethod method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeCodeChallengeMethod%20-%20Python%20SDK&description=CreateAuthKeysCodeCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Values - -| Name | Value | -| ------- | ------- | -| `S256` | S256 | -| `PLAIN` | plain | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscodedata.mdx b/client-sdks/python/api-reference/operations/createauthkeyscodedata.mdx deleted file mode 100644 index 8ae99c37..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscodedata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateAuthKeysCodeData - Python SDK -sidebarTitle: CreateAuthKeysCodeData -description: CreateAuthKeysCodeData method reference -seoTitle: CreateAuthKeysCodeData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscodedata -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeData | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeData%20-%20Python%20SDK&description=CreateAuthKeysCodeData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Auth code data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `app_id` | *int* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `id` | *str* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscodeglobals.mdx b/client-sdks/python/api-reference/operations/createauthkeyscodeglobals.mdx deleted file mode 100644 index 76132a30..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscodeglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeGlobals - Python SDK -sidebarTitle: CreateAuthKeysCodeGlobals -description: CreateAuthKeysCodeGlobals method reference -seoTitle: CreateAuthKeysCodeGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscodeglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeGlobals | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeGlobals%20-%20Python%20SDK&description=CreateAuthKeysCodeGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscoderequest.mdx b/client-sdks/python/api-reference/operations/createauthkeyscoderequest.mdx deleted file mode 100644 index 394cfda1..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscoderequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateAuthKeysCodeRequest - Python SDK -sidebarTitle: CreateAuthKeysCodeRequest -description: CreateAuthKeysCodeRequest method reference -seoTitle: CreateAuthKeysCodeRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscoderequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequest | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequest%20-%20Python%20SDK&description=CreateAuthKeysCodeRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateAuthKeysCodeRequestBody](/client-sdks/python/api-reference/operations/createauthkeyscoderequestbody) | :heavy_check_mark: | N/A | `{"callback_url": "https://myapp.com/auth/callback","code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM","code_challenge_method": "S256","limit": 100}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscoderequestbody.mdx b/client-sdks/python/api-reference/operations/createauthkeyscoderequestbody.mdx deleted file mode 100644 index 9e5c3dbe..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscoderequestbody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateAuthKeysCodeRequestBody - Python SDK -sidebarTitle: CreateAuthKeysCodeRequestBody -description: CreateAuthKeysCodeRequestBody method reference -seoTitle: CreateAuthKeysCodeRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscoderequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequestBody | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeRequestBody method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequestBody%20-%20Python%20SDK&description=CreateAuthKeysCodeRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional expiration time for the API key to be created | 2027-12-31T23:59:59Z | -| `key_label` | *Optional[str]* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usage_limit_type` | [Optional[operations.UsageLimitType]](../operations/usagelimittype.md) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createauthkeyscoderesponse.mdx b/client-sdks/python/api-reference/operations/createauthkeyscoderesponse.mdx deleted file mode 100644 index 94429f93..00000000 --- a/client-sdks/python/api-reference/operations/createauthkeyscoderesponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeResponse - Python SDK -sidebarTitle: CreateAuthKeysCodeResponse -description: CreateAuthKeysCodeResponse method reference -seoTitle: CreateAuthKeysCodeResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createauthkeyscoderesponse -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeResponse | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeResponse%20-%20Python%20SDK&description=CreateAuthKeysCodeResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Successfully created authorization code - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/createbyokkeyglobals.mdx b/client-sdks/python/api-reference/operations/createbyokkeyglobals.mdx deleted file mode 100644 index 37be67e1..00000000 --- a/client-sdks/python/api-reference/operations/createbyokkeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateBYOKKeyGlobals - Python SDK -sidebarTitle: CreateBYOKKeyGlobals -description: CreateBYOKKeyGlobals method reference -seoTitle: CreateBYOKKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createbyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyGlobals | OpenRouter Python SDK -'og:description': >- - CreateBYOKKeyGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyGlobals%20-%20Python%20SDK&description=CreateBYOKKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createbyokkeyrequest.mdx b/client-sdks/python/api-reference/operations/createbyokkeyrequest.mdx deleted file mode 100644 index aa38bb1e..00000000 --- a/client-sdks/python/api-reference/operations/createbyokkeyrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateBYOKKeyRequest - Python SDK -sidebarTitle: CreateBYOKKeyRequest -description: CreateBYOKKeyRequest method reference -seoTitle: CreateBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - CreateBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyRequest%20-%20Python%20SDK&description=CreateBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_byok_key_request` | [components.CreateBYOKKeyRequest](/client-sdks/python/api-reference/components/createbyokkeyrequest) | :heavy_check_mark: | N/A | `{"key": "sk-proj-abc123...","name": "Production OpenAI Key","provider": "openai"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsdata.mdx b/client-sdks/python/api-reference/operations/createembeddingsdata.mdx deleted file mode 100644 index 355241f5..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateEmbeddingsData - Python SDK -sidebarTitle: CreateEmbeddingsData -description: CreateEmbeddingsData method reference -seoTitle: CreateEmbeddingsData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsdata -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsData | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsData%20-%20Python%20SDK&description=CreateEmbeddingsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A single embedding object - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `embedding` | [operations.Embedding](/client-sdks/python/api-reference/operations/embedding) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](/client-sdks/python/api-reference/operations/objectembedding) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsglobals.mdx b/client-sdks/python/api-reference/operations/createembeddingsglobals.mdx deleted file mode 100644 index fb9dc29a..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateEmbeddingsGlobals - Python SDK -sidebarTitle: CreateEmbeddingsGlobals -description: CreateEmbeddingsGlobals method reference -seoTitle: CreateEmbeddingsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsGlobals | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsGlobals%20-%20Python%20SDK&description=CreateEmbeddingsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsrequest.mdx b/client-sdks/python/api-reference/operations/createembeddingsrequest.mdx deleted file mode 100644 index 3ac1a6c2..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateEmbeddingsRequest - Python SDK -sidebarTitle: CreateEmbeddingsRequest -description: CreateEmbeddingsRequest method reference -seoTitle: CreateEmbeddingsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequest | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequest%20-%20Python%20SDK&description=CreateEmbeddingsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateEmbeddingsRequestBody](/client-sdks/python/api-reference/operations/createembeddingsrequestbody) | :heavy_check_mark: | N/A | `{"dimensions": 1536,"input": "The quick brown fox jumps over the lazy dog","model": "openai/text-embedding-3-small"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsrequestbody.mdx b/client-sdks/python/api-reference/operations/createembeddingsrequestbody.mdx deleted file mode 100644 index 26a504b6..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsrequestbody.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateEmbeddingsRequestBody - Python SDK -sidebarTitle: CreateEmbeddingsRequestBody -description: CreateEmbeddingsRequestBody method reference -seoTitle: CreateEmbeddingsRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequestBody | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsRequestBody method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequestBody%20-%20Python%20SDK&description=CreateEmbeddingsRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Embeddings request input - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `dimensions` | *Optional[int]* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.md) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input` | [operations.InputUnion](/client-sdks/python/api-reference/operations/inputunion) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `input_type` | *Optional[str]* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `model` | *str* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | N/A | `{"allow_fallbacks": true}` | -| `user` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsresponse.mdx b/client-sdks/python/api-reference/operations/createembeddingsresponse.mdx deleted file mode 100644 index e328aff5..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsresponse.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateEmbeddingsResponse - Python SDK -sidebarTitle: CreateEmbeddingsResponse -description: CreateEmbeddingsResponse method reference -seoTitle: CreateEmbeddingsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponse | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponse%20-%20Python%20SDK&description=CreateEmbeddingsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateEmbeddingsResponseBody` - -```python lines -value: operations.CreateEmbeddingsResponseBody = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsresponsebody.mdx b/client-sdks/python/api-reference/operations/createembeddingsresponsebody.mdx deleted file mode 100644 index c1b0a3c0..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsresponsebody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateEmbeddingsResponseBody - Python SDK -sidebarTitle: CreateEmbeddingsResponseBody -description: CreateEmbeddingsResponseBody method reference -seoTitle: CreateEmbeddingsResponseBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponseBody | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsResponseBody method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponseBody%20-%20Python%20SDK&description=CreateEmbeddingsResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Embeddings response containing embedding vectors - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | List[[operations.CreateEmbeddingsData](/client-sdks/python/api-reference/operations/createembeddingsdata)] | :heavy_check_mark: | List of embedding objects | [
`{"embedding": [0.0023064255,-0.009327292,0.015797347],"index": 0,"object": "embedding"}`
] | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *str* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [operations.Object](/client-sdks/python/api-reference/operations/object) | :heavy_check_mark: | N/A | | -| `usage` | [Optional[operations.CreateEmbeddingsUsage]](../operations/createembeddingsusage.md) | :heavy_minus_sign: | Token usage statistics | `{"prompt_tokens": 8,"total_tokens": 8}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createembeddingsusage.mdx b/client-sdks/python/api-reference/operations/createembeddingsusage.mdx deleted file mode 100644 index e5baadd8..00000000 --- a/client-sdks/python/api-reference/operations/createembeddingsusage.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CreateEmbeddingsUsage - Python SDK -sidebarTitle: CreateEmbeddingsUsage -description: CreateEmbeddingsUsage method reference -seoTitle: CreateEmbeddingsUsage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createembeddingsusage -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsUsage | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsUsage method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsUsage%20-%20Python%20SDK&description=CreateEmbeddingsUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `prompt_tokens_details` | [Optional[operations.PromptTokensDetails]](../operations/prompttokensdetails.md) | :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. | | -| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createguardrailglobals.mdx b/client-sdks/python/api-reference/operations/createguardrailglobals.mdx deleted file mode 100644 index 816d359b..00000000 --- a/client-sdks/python/api-reference/operations/createguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateGuardrailGlobals - Python SDK -sidebarTitle: CreateGuardrailGlobals -description: CreateGuardrailGlobals method reference -seoTitle: CreateGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - CreateGuardrailGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailGlobals%20-%20Python%20SDK&description=CreateGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createguardrailrequest.mdx b/client-sdks/python/api-reference/operations/createguardrailrequest.mdx deleted file mode 100644 index d2406bc4..00000000 --- a/client-sdks/python/api-reference/operations/createguardrailrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateGuardrailRequest - Python SDK -sidebarTitle: CreateGuardrailRequest -description: CreateGuardrailRequest method reference -seoTitle: CreateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - CreateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20Python%20SDK&description=CreateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_guardrail_request` | [components.CreateGuardrailRequest](/client-sdks/python/api-reference/components/createguardrailrequest) | :heavy_check_mark: | N/A | `{"allowed_models": null,"allowed_providers": ["openai","anthropic","deepseek"],"content_filter_builtins": [{"action": "block","slug": "regex-prompt-injection"}`
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createkeysdata.mdx b/client-sdks/python/api-reference/operations/createkeysdata.mdx deleted file mode 100644 index 4b50c35c..00000000 --- a/client-sdks/python/api-reference/operations/createkeysdata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateKeysData - Python SDK -sidebarTitle: CreateKeysData -description: CreateKeysData method reference -seoTitle: CreateKeysData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/createkeysdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysData | OpenRouter Python SDK -'og:description': >- - CreateKeysData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysData%20-%20Python%20SDK&description=CreateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The created API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createkeysglobals.mdx b/client-sdks/python/api-reference/operations/createkeysglobals.mdx deleted file mode 100644 index 2149795f..00000000 --- a/client-sdks/python/api-reference/operations/createkeysglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateKeysGlobals - Python SDK -sidebarTitle: CreateKeysGlobals -description: CreateKeysGlobals method reference -seoTitle: CreateKeysGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createkeysglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysGlobals | OpenRouter Python SDK -'og:description': >- - CreateKeysGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysGlobals%20-%20Python%20SDK&description=CreateKeysGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createkeyslimitreset.mdx b/client-sdks/python/api-reference/operations/createkeyslimitreset.mdx deleted file mode 100644 index 8023c2fb..00000000 --- a/client-sdks/python/api-reference/operations/createkeyslimitreset.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateKeysLimitReset - Python SDK -sidebarTitle: CreateKeysLimitReset -description: CreateKeysLimitReset method reference -seoTitle: CreateKeysLimitReset | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createkeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysLimitReset | OpenRouter Python SDK -'og:description': >- - CreateKeysLimitReset method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysLimitReset%20-%20Python%20SDK&description=CreateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createkeysrequest.mdx b/client-sdks/python/api-reference/operations/createkeysrequest.mdx deleted file mode 100644 index 5892b44f..00000000 --- a/client-sdks/python/api-reference/operations/createkeysrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateKeysRequest - Python SDK -sidebarTitle: CreateKeysRequest -description: CreateKeysRequest method reference -seoTitle: CreateKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequest | OpenRouter Python SDK -'og:description': >- - CreateKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequest%20-%20Python%20SDK&description=CreateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateKeysRequestBody](/client-sdks/python/api-reference/operations/createkeysrequestbody) | :heavy_check_mark: | N/A | `{"expires_at": "2027-12-31T23:59:59Z","include_byok_in_limit": true,"limit": 50,"limit_reset": "monthly","name": "My New API Key"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createkeysrequestbody.mdx b/client-sdks/python/api-reference/operations/createkeysrequestbody.mdx deleted file mode 100644 index 2f97c09d..00000000 --- a/client-sdks/python/api-reference/operations/createkeysrequestbody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateKeysRequestBody - Python SDK -sidebarTitle: CreateKeysRequestBody -description: CreateKeysRequestBody method reference -seoTitle: CreateKeysRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createkeysrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequestBody | OpenRouter Python SDK -'og:description': >- - CreateKeysRequestBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequestBody%20-%20Python%20SDK&description=CreateKeysRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `creator_user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../operations/createkeyslimitreset.md) | :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` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `workspace_id` | *Optional[str]* | :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/client-sdks/python/api-reference/operations/createkeysresponse.mdx b/client-sdks/python/api-reference/operations/createkeysresponse.mdx deleted file mode 100644 index e7b0ff24..00000000 --- a/client-sdks/python/api-reference/operations/createkeysresponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateKeysResponse - Python SDK -sidebarTitle: CreateKeysResponse -description: CreateKeysResponse method reference -seoTitle: CreateKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysResponse | OpenRouter Python SDK -'og:description': >- - CreateKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysResponse%20-%20Python%20SDK&description=CreateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key created successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.CreateKeysData](/client-sdks/python/api-reference/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` | *str* | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createobservabilitydestinationglobals.mdx b/client-sdks/python/api-reference/operations/createobservabilitydestinationglobals.mdx deleted file mode 100644 index 0755ce1a..00000000 --- a/client-sdks/python/api-reference/operations/createobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateObservabilityDestinationGlobals - Python SDK -sidebarTitle: CreateObservabilityDestinationGlobals -description: CreateObservabilityDestinationGlobals method reference -seoTitle: CreateObservabilityDestinationGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationGlobals | OpenRouter Python SDK -'og:description': >- - CreateObservabilityDestinationGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationGlobals%20-%20Python%20SDK&description=CreateObservabilityDestinationGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/operations/createobservabilitydestinationrequest.mdx deleted file mode 100644 index 11a9b62d..00000000 --- a/client-sdks/python/api-reference/operations/createobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateObservabilityDestinationRequest - Python SDK -sidebarTitle: CreateObservabilityDestinationRequest -description: CreateObservabilityDestinationRequest method reference -seoTitle: CreateObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - CreateObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequest%20-%20Python%20SDK&description=CreateObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_observability_destination_request` | [components.CreateObservabilityDestinationRequest](/client-sdks/python/api-reference/components/createobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"config": {"baseUrl": "https://us.cloud.langfuse.com","publicKey": "pk-l...EfGh","secretKey": "sk-l...AbCd"}`,
"name": "Production Langfuse",
"type": "langfuse"
\} | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createpresetschatcompletionsglobals.mdx b/client-sdks/python/api-reference/operations/createpresetschatcompletionsglobals.mdx deleted file mode 100644 index 5999d0ed..00000000 --- a/client-sdks/python/api-reference/operations/createpresetschatcompletionsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreatePresetsChatCompletionsGlobals - Python SDK -sidebarTitle: CreatePresetsChatCompletionsGlobals -description: CreatePresetsChatCompletionsGlobals method reference -seoTitle: CreatePresetsChatCompletionsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetschatcompletionsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsChatCompletionsGlobals | OpenRouter Python SDK -'og:description': >- - CreatePresetsChatCompletionsGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsChatCompletionsGlobals%20-%20Python%20SDK&description=CreatePresetsChatCompletionsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createpresetschatcompletionsrequest.mdx b/client-sdks/python/api-reference/operations/createpresetschatcompletionsrequest.mdx deleted file mode 100644 index 9d27e5c4..00000000 --- a/client-sdks/python/api-reference/operations/createpresetschatcompletionsrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreatePresetsChatCompletionsRequest - Python SDK -sidebarTitle: CreatePresetsChatCompletionsRequest -description: CreatePresetsChatCompletionsRequest method reference -seoTitle: CreatePresetsChatCompletionsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetschatcompletionsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsChatCompletionsRequest | OpenRouter Python SDK -'og:description': >- - CreatePresetsChatCompletionsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsChatCompletionsRequest%20-%20Python%20SDK&description=CreatePresetsChatCompletionsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chat_request` | [components.ChatRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/createpresetsmessagesglobals.mdx b/client-sdks/python/api-reference/operations/createpresetsmessagesglobals.mdx deleted file mode 100644 index 2a9b79d9..00000000 --- a/client-sdks/python/api-reference/operations/createpresetsmessagesglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreatePresetsMessagesGlobals - Python SDK -sidebarTitle: CreatePresetsMessagesGlobals -description: CreatePresetsMessagesGlobals method reference -seoTitle: CreatePresetsMessagesGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetsmessagesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsMessagesGlobals | OpenRouter Python SDK -'og:description': >- - CreatePresetsMessagesGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsMessagesGlobals%20-%20Python%20SDK&description=CreatePresetsMessagesGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createpresetsmessagesrequest.mdx b/client-sdks/python/api-reference/operations/createpresetsmessagesrequest.mdx deleted file mode 100644 index 5fbe9443..00000000 --- a/client-sdks/python/api-reference/operations/createpresetsmessagesrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreatePresetsMessagesRequest - Python SDK -sidebarTitle: CreatePresetsMessagesRequest -description: CreatePresetsMessagesRequest method reference -seoTitle: CreatePresetsMessagesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetsmessagesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsMessagesRequest | OpenRouter Python SDK -'og:description': >- - CreatePresetsMessagesRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsMessagesRequest%20-%20Python%20SDK&description=CreatePresetsMessagesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages_request` | [components.MessagesRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/createpresetsresponsesglobals.mdx b/client-sdks/python/api-reference/operations/createpresetsresponsesglobals.mdx deleted file mode 100644 index eb5e89b7..00000000 --- a/client-sdks/python/api-reference/operations/createpresetsresponsesglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreatePresetsResponsesGlobals - Python SDK -sidebarTitle: CreatePresetsResponsesGlobals -description: CreatePresetsResponsesGlobals method reference -seoTitle: CreatePresetsResponsesGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetsresponsesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsResponsesGlobals | OpenRouter Python SDK -'og:description': >- - CreatePresetsResponsesGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsResponsesGlobals%20-%20Python%20SDK&description=CreatePresetsResponsesGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createpresetsresponsesrequest.mdx b/client-sdks/python/api-reference/operations/createpresetsresponsesrequest.mdx deleted file mode 100644 index dc0fd11e..00000000 --- a/client-sdks/python/api-reference/operations/createpresetsresponsesrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreatePresetsResponsesRequest - Python SDK -sidebarTitle: CreatePresetsResponsesRequest -description: CreatePresetsResponsesRequest method reference -seoTitle: CreatePresetsResponsesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createpresetsresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsResponsesRequest | OpenRouter Python SDK -'og:description': >- - CreatePresetsResponsesRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsResponsesRequest%20-%20Python%20SDK&description=CreatePresetsResponsesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responses_request` | [components.ResponsesRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/creatererankglobals.mdx b/client-sdks/python/api-reference/operations/creatererankglobals.mdx deleted file mode 100644 index adb29b50..00000000 --- a/client-sdks/python/api-reference/operations/creatererankglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateRerankGlobals - Python SDK -sidebarTitle: CreateRerankGlobals -description: CreateRerankGlobals method reference -seoTitle: CreateRerankGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankGlobals | OpenRouter Python SDK -'og:description': >- - CreateRerankGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankGlobals%20-%20Python%20SDK&description=CreateRerankGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/creatererankrequest.mdx b/client-sdks/python/api-reference/operations/creatererankrequest.mdx deleted file mode 100644 index ce52b293..00000000 --- a/client-sdks/python/api-reference/operations/creatererankrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateRerankRequest - Python SDK -sidebarTitle: CreateRerankRequest -description: CreateRerankRequest method reference -seoTitle: CreateRerankRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankRequest | OpenRouter Python SDK -'og:description': >- - CreateRerankRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankRequest%20-%20Python%20SDK&description=CreateRerankRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.CreateRerankRequestBody](/client-sdks/python/api-reference/operations/creatererankrequestbody) | :heavy_check_mark: | N/A | `{"documents": ["Paris is the capital of France.","Berlin is the capital of Germany."],"model": "cohere/rerank-v3.5","query": "What is the capital of France?","top_n": 3}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/creatererankrequestbody.mdx b/client-sdks/python/api-reference/operations/creatererankrequestbody.mdx deleted file mode 100644 index 54ff7188..00000000 --- a/client-sdks/python/api-reference/operations/creatererankrequestbody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateRerankRequestBody - Python SDK -sidebarTitle: CreateRerankRequestBody -description: CreateRerankRequestBody method reference -seoTitle: CreateRerankRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankRequestBody | OpenRouter Python SDK -'og:description': >- - CreateRerankRequestBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankRequestBody%20-%20Python%20SDK&description=CreateRerankRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Rerank request input - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `documents` | List[*str*] | :heavy_check_mark: | The list of documents to rerank | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `model` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | N/A | `{"allow_fallbacks": true}` | -| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/creatererankresponse.mdx b/client-sdks/python/api-reference/operations/creatererankresponse.mdx deleted file mode 100644 index f00e62f6..00000000 --- a/client-sdks/python/api-reference/operations/creatererankresponse.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateRerankResponse - Python SDK -sidebarTitle: CreateRerankResponse -description: CreateRerankResponse method reference -seoTitle: CreateRerankResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponse | OpenRouter Python SDK -'og:description': >- - CreateRerankResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponse%20-%20Python%20SDK&description=CreateRerankResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateRerankResponseBody` - -```python lines -value: operations.CreateRerankResponseBody = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/creatererankresponsebody.mdx b/client-sdks/python/api-reference/operations/creatererankresponsebody.mdx deleted file mode 100644 index efe6421f..00000000 --- a/client-sdks/python/api-reference/operations/creatererankresponsebody.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateRerankResponseBody - Python SDK -sidebarTitle: CreateRerankResponseBody -description: CreateRerankResponseBody method reference -seoTitle: CreateRerankResponseBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponseBody | OpenRouter Python SDK -'og:description': >- - CreateRerankResponseBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponseBody%20-%20Python%20SDK&description=CreateRerankResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Rerank response containing ranked results - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `model` | *str* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `provider` | *Optional[str]* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `results` | List[[operations.Result](/client-sdks/python/api-reference/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` | [Optional[operations.CreateRerankUsage]](../operations/creatererankusage.md) | :heavy_minus_sign: | Usage statistics | `{"search_units": 1,"total_tokens": 150}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/creatererankusage.mdx b/client-sdks/python/api-reference/operations/creatererankusage.mdx deleted file mode 100644 index d3e25a1a..00000000 --- a/client-sdks/python/api-reference/operations/creatererankusage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateRerankUsage - Python SDK -sidebarTitle: CreateRerankUsage -description: CreateRerankUsage method reference -seoTitle: CreateRerankUsage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/creatererankusage -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankUsage | OpenRouter Python SDK -'og:description': >- - CreateRerankUsage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankUsage%20-%20Python%20SDK&description=CreateRerankUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Usage statistics - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `cost` | *Optional[float]* | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `search_units` | *Optional[int]* | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `total_tokens` | *Optional[int]* | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createresponsesglobals.mdx b/client-sdks/python/api-reference/operations/createresponsesglobals.mdx deleted file mode 100644 index 2f7f0e36..00000000 --- a/client-sdks/python/api-reference/operations/createresponsesglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateResponsesGlobals - Python SDK -sidebarTitle: CreateResponsesGlobals -description: CreateResponsesGlobals method reference -seoTitle: CreateResponsesGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createresponsesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesGlobals | OpenRouter Python SDK -'og:description': >- - CreateResponsesGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesGlobals%20-%20Python%20SDK&description=CreateResponsesGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createresponsesrequest.mdx b/client-sdks/python/api-reference/operations/createresponsesrequest.mdx deleted file mode 100644 index 07737102..00000000 --- a/client-sdks/python/api-reference/operations/createresponsesrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateResponsesRequest - Python SDK -sidebarTitle: CreateResponsesRequest -description: CreateResponsesRequest method reference -seoTitle: CreateResponsesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesRequest | OpenRouter Python SDK -'og:description': >- - CreateResponsesRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesRequest%20-%20Python%20SDK&description=CreateResponsesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_experimental_metadata` | [Optional[components.MetadataLevel]](../components/metadatalevel.md) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `responses_request` | [components.ResponsesRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/createresponsesresponse.mdx b/client-sdks/python/api-reference/operations/createresponsesresponse.mdx deleted file mode 100644 index d035e74b..00000000 --- a/client-sdks/python/api-reference/operations/createresponsesresponse.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CreateResponsesResponse - Python SDK -sidebarTitle: CreateResponsesResponse -description: CreateResponsesResponse method reference -seoTitle: CreateResponsesResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createresponsesresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponse | OpenRouter Python SDK -'og:description': >- - CreateResponsesResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponse%20-%20Python%20SDK&description=CreateResponsesResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesResult` - -```python lines -value: components.OpenResponsesResult = /* values here */ -``` - -### `Union[eventstreaming.EventStream[components.StreamEvents], eventstreaming.EventStreamAsync[components.StreamEvents]]` - -```python lines -value: Union[eventstreaming.EventStream[components.StreamEvents], eventstreaming.EventStreamAsync[components.StreamEvents]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createvideosglobals.mdx b/client-sdks/python/api-reference/operations/createvideosglobals.mdx deleted file mode 100644 index 79259e44..00000000 --- a/client-sdks/python/api-reference/operations/createvideosglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateVideosGlobals - Python SDK -sidebarTitle: CreateVideosGlobals -description: CreateVideosGlobals method reference -seoTitle: CreateVideosGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createvideosglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateVideosGlobals | OpenRouter Python SDK -'og:description': >- - CreateVideosGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateVideosGlobals%20-%20Python%20SDK&description=CreateVideosGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createvideosrequest.mdx b/client-sdks/python/api-reference/operations/createvideosrequest.mdx deleted file mode 100644 index ea9388fa..00000000 --- a/client-sdks/python/api-reference/operations/createvideosrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateVideosRequest - Python SDK -sidebarTitle: CreateVideosRequest -description: CreateVideosRequest method reference -seoTitle: CreateVideosRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createvideosrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateVideosRequest | OpenRouter Python SDK -'og:description': >- - CreateVideosRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateVideosRequest%20-%20Python%20SDK&description=CreateVideosRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `video_generation_request` | [components.VideoGenerationRequest](/client-sdks/python/api-reference/components/videogenerationrequest) | :heavy_check_mark: | N/A | `{"aspect_ratio": "16:9","duration": 8,"model": "google/veo-3.1","prompt": "A serene mountain landscape at sunset","resolution": "720p"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createworkspaceglobals.mdx b/client-sdks/python/api-reference/operations/createworkspaceglobals.mdx deleted file mode 100644 index 0e762906..00000000 --- a/client-sdks/python/api-reference/operations/createworkspaceglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateWorkspaceGlobals - Python SDK -sidebarTitle: CreateWorkspaceGlobals -description: CreateWorkspaceGlobals method reference -seoTitle: CreateWorkspaceGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceGlobals | OpenRouter Python SDK -'og:description': >- - CreateWorkspaceGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceGlobals%20-%20Python%20SDK&description=CreateWorkspaceGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/createworkspacerequest.mdx b/client-sdks/python/api-reference/operations/createworkspacerequest.mdx deleted file mode 100644 index 09dceb8b..00000000 --- a/client-sdks/python/api-reference/operations/createworkspacerequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateWorkspaceRequest - Python SDK -sidebarTitle: CreateWorkspaceRequest -description: CreateWorkspaceRequest method reference -seoTitle: CreateWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/createworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - CreateWorkspaceRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceRequest%20-%20Python%20SDK&description=CreateWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `create_workspace_request` | [components.CreateWorkspaceRequest](/client-sdks/python/api-reference/components/createworkspacerequest) | :heavy_check_mark: | N/A | `{"default_image_model": "openai/dall-e-3","default_provider_sort": "price","default_text_model": "openai/gpt-4o","description": "Production environment workspace","name": "Production","slug": "production"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/datacenter.mdx b/client-sdks/python/api-reference/operations/datacenter.mdx deleted file mode 100644 index 961d4473..00000000 --- a/client-sdks/python/api-reference/operations/datacenter.mdx +++ /dev/null @@ -1,281 +0,0 @@ ---- -title: Datacenter - Python SDK -sidebarTitle: Datacenter -description: Datacenter method reference -seoTitle: Datacenter | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/datacenter' -'og:site_name': OpenRouter Documentation -'og:title': Datacenter | OpenRouter Python SDK -'og:description': >- - Datacenter method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datacenter%20-%20Python%20SDK&description=Datacenter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `AD` | AD | -| `AE` | AE | -| `AF` | AF | -| `AG` | AG | -| `AI` | AI | -| `AL` | AL | -| `AM` | AM | -| `AO` | AO | -| `AQ` | AQ | -| `AR` | AR | -| `AS` | AS | -| `AT` | AT | -| `AU` | AU | -| `AW` | AW | -| `AX` | AX | -| `AZ` | AZ | -| `BA` | BA | -| `BB` | BB | -| `BD` | BD | -| `BE` | BE | -| `BF` | BF | -| `BG` | BG | -| `BH` | BH | -| `BI` | BI | -| `BJ` | BJ | -| `BL` | BL | -| `BM` | BM | -| `BN` | BN | -| `BO` | BO | -| `BQ` | BQ | -| `BR` | BR | -| `BS` | BS | -| `BT` | BT | -| `BV` | BV | -| `BW` | BW | -| `BY` | BY | -| `BZ` | BZ | -| `CA` | CA | -| `CC` | CC | -| `CD` | CD | -| `CF` | CF | -| `CG` | CG | -| `CH` | CH | -| `CI` | CI | -| `CK` | CK | -| `CL` | CL | -| `CM` | CM | -| `CN` | CN | -| `CO` | CO | -| `CR` | CR | -| `CU` | CU | -| `CV` | CV | -| `CW` | CW | -| `CX` | CX | -| `CY` | CY | -| `CZ` | CZ | -| `DE` | DE | -| `DJ` | DJ | -| `DK` | DK | -| `DM` | DM | -| `DO` | DO | -| `DZ` | DZ | -| `EC` | EC | -| `EE` | EE | -| `EG` | EG | -| `EH` | EH | -| `ER` | ER | -| `ES` | ES | -| `ET` | ET | -| `FI` | FI | -| `FJ` | FJ | -| `FK` | FK | -| `FM` | FM | -| `FO` | FO | -| `FR` | FR | -| `GA` | GA | -| `GB` | GB | -| `GD` | GD | -| `GE` | GE | -| `GF` | GF | -| `GG` | GG | -| `GH` | GH | -| `GI` | GI | -| `GL` | GL | -| `GM` | GM | -| `GN` | GN | -| `GP` | GP | -| `GQ` | GQ | -| `GR` | GR | -| `GS` | GS | -| `GT` | GT | -| `GU` | GU | -| `GW` | GW | -| `GY` | GY | -| `HK` | HK | -| `HM` | HM | -| `HN` | HN | -| `HR` | HR | -| `HT` | HT | -| `HU` | HU | -| `ID` | ID | -| `IE` | IE | -| `IL` | IL | -| `IM` | IM | -| `IN` | IN | -| `IO` | IO | -| `IQ` | IQ | -| `IR` | IR | -| `IS` | IS | -| `IT` | IT | -| `JE` | JE | -| `JM` | JM | -| `JO` | JO | -| `JP` | JP | -| `KE` | KE | -| `KG` | KG | -| `KH` | KH | -| `KI` | KI | -| `KM` | KM | -| `KN` | KN | -| `KP` | KP | -| `KR` | KR | -| `KW` | KW | -| `KY` | KY | -| `KZ` | KZ | -| `LA` | LA | -| `LB` | LB | -| `LC` | LC | -| `LI` | LI | -| `LK` | LK | -| `LR` | LR | -| `LS` | LS | -| `LT` | LT | -| `LU` | LU | -| `LV` | LV | -| `LY` | LY | -| `MA` | MA | -| `MC` | MC | -| `MD` | MD | -| `ME` | ME | -| `MF` | MF | -| `MG` | MG | -| `MH` | MH | -| `MK` | MK | -| `ML` | ML | -| `MM` | MM | -| `MN` | MN | -| `MO` | MO | -| `MP` | MP | -| `MQ` | MQ | -| `MR` | MR | -| `MS` | MS | -| `MT` | MT | -| `MU` | MU | -| `MV` | MV | -| `MW` | MW | -| `MX` | MX | -| `MY` | MY | -| `MZ` | MZ | -| `NA` | NA | -| `NC` | NC | -| `NE` | NE | -| `NF` | NF | -| `NG` | NG | -| `NI` | NI | -| `NL` | NL | -| `NO` | NO | -| `NP` | NP | -| `NR` | NR | -| `NU` | NU | -| `NZ` | NZ | -| `OM` | OM | -| `PA` | PA | -| `PE` | PE | -| `PF` | PF | -| `PG` | PG | -| `PH` | PH | -| `PK` | PK | -| `PL` | PL | -| `PM` | PM | -| `PN` | PN | -| `PR` | PR | -| `PS` | PS | -| `PT` | PT | -| `PW` | PW | -| `PY` | PY | -| `QA` | QA | -| `RE` | RE | -| `RO` | RO | -| `RS` | RS | -| `RU` | RU | -| `RW` | RW | -| `SA` | SA | -| `SB` | SB | -| `SC` | SC | -| `SD` | SD | -| `SE` | SE | -| `SG` | SG | -| `SH` | SH | -| `SI` | SI | -| `SJ` | SJ | -| `SK` | SK | -| `SL` | SL | -| `SM` | SM | -| `SN` | SN | -| `SO` | SO | -| `SR` | SR | -| `SS` | SS | -| `ST` | ST | -| `SV` | SV | -| `SX` | SX | -| `SY` | SY | -| `SZ` | SZ | -| `TC` | TC | -| `TD` | TD | -| `TF` | TF | -| `TG` | TG | -| `TH` | TH | -| `TJ` | TJ | -| `TK` | TK | -| `TL` | TL | -| `TM` | TM | -| `TN` | TN | -| `TO` | TO | -| `TR` | TR | -| `TT` | TT | -| `TV` | TV | -| `TW` | TW | -| `TZ` | TZ | -| `UA` | UA | -| `UG` | UG | -| `UM` | UM | -| `US` | US | -| `UY` | UY | -| `UZ` | UZ | -| `VA` | VA | -| `VC` | VC | -| `VE` | VE | -| `VG` | VG | -| `VI` | VI | -| `VN` | VN | -| `VU` | VU | -| `WF` | WF | -| `WS` | WS | -| `YE` | YE | -| `YT` | YT | -| `ZA` | ZA | -| `ZM` | ZM | -| `ZW` | ZW | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deletebyokkeyglobals.mdx b/client-sdks/python/api-reference/operations/deletebyokkeyglobals.mdx deleted file mode 100644 index 660081ea..00000000 --- a/client-sdks/python/api-reference/operations/deletebyokkeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteBYOKKeyGlobals - Python SDK -sidebarTitle: DeleteBYOKKeyGlobals -description: DeleteBYOKKeyGlobals method reference -seoTitle: DeleteBYOKKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deletebyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyGlobals | OpenRouter Python SDK -'og:description': >- - DeleteBYOKKeyGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyGlobals%20-%20Python%20SDK&description=DeleteBYOKKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deletebyokkeyrequest.mdx b/client-sdks/python/api-reference/operations/deletebyokkeyrequest.mdx deleted file mode 100644 index c1ee942b..00000000 --- a/client-sdks/python/api-reference/operations/deletebyokkeyrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteBYOKKeyRequest - Python SDK -sidebarTitle: DeleteBYOKKeyRequest -description: DeleteBYOKKeyRequest method reference -seoTitle: DeleteBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deletebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - DeleteBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyRequest%20-%20Python%20SDK&description=DeleteBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteguardrailglobals.mdx b/client-sdks/python/api-reference/operations/deleteguardrailglobals.mdx deleted file mode 100644 index f28d428e..00000000 --- a/client-sdks/python/api-reference/operations/deleteguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteGuardrailGlobals - Python SDK -sidebarTitle: DeleteGuardrailGlobals -description: DeleteGuardrailGlobals method reference -seoTitle: DeleteGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - DeleteGuardrailGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailGlobals%20-%20Python%20SDK&description=DeleteGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteguardrailrequest.mdx b/client-sdks/python/api-reference/operations/deleteguardrailrequest.mdx deleted file mode 100644 index 859becf0..00000000 --- a/client-sdks/python/api-reference/operations/deleteguardrailrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteGuardrailRequest - Python SDK -sidebarTitle: DeleteGuardrailRequest -description: DeleteGuardrailRequest method reference -seoTitle: DeleteGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailRequest | OpenRouter Python SDK -'og:description': >- - DeleteGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailRequest%20-%20Python%20SDK&description=DeleteGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deletekeysglobals.mdx b/client-sdks/python/api-reference/operations/deletekeysglobals.mdx deleted file mode 100644 index 14c35256..00000000 --- a/client-sdks/python/api-reference/operations/deletekeysglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteKeysGlobals - Python SDK -sidebarTitle: DeleteKeysGlobals -description: DeleteKeysGlobals method reference -seoTitle: DeleteKeysGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deletekeysglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysGlobals | OpenRouter Python SDK -'og:description': >- - DeleteKeysGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysGlobals%20-%20Python%20SDK&description=DeleteKeysGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deletekeysrequest.mdx b/client-sdks/python/api-reference/operations/deletekeysrequest.mdx deleted file mode 100644 index b43c8b87..00000000 --- a/client-sdks/python/api-reference/operations/deletekeysrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteKeysRequest - Python SDK -sidebarTitle: DeleteKeysRequest -description: DeleteKeysRequest method reference -seoTitle: DeleteKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deletekeysrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysRequest | OpenRouter Python SDK -'og:description': >- - DeleteKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysRequest%20-%20Python%20SDK&description=DeleteKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deletekeysresponse.mdx b/client-sdks/python/api-reference/operations/deletekeysresponse.mdx deleted file mode 100644 index 89af4a3d..00000000 --- a/client-sdks/python/api-reference/operations/deletekeysresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteKeysResponse - Python SDK -sidebarTitle: DeleteKeysResponse -description: DeleteKeysResponse method reference -seoTitle: DeleteKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deletekeysresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysResponse | OpenRouter Python SDK -'og:description': >- - DeleteKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysResponse%20-%20Python%20SDK&description=DeleteKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key deleted successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteobservabilitydestinationglobals.mdx b/client-sdks/python/api-reference/operations/deleteobservabilitydestinationglobals.mdx deleted file mode 100644 index a974abae..00000000 --- a/client-sdks/python/api-reference/operations/deleteobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteObservabilityDestinationGlobals - Python SDK -sidebarTitle: DeleteObservabilityDestinationGlobals -description: DeleteObservabilityDestinationGlobals method reference -seoTitle: DeleteObservabilityDestinationGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationGlobals | OpenRouter Python SDK -'og:description': >- - DeleteObservabilityDestinationGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationGlobals%20-%20Python%20SDK&description=DeleteObservabilityDestinationGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/operations/deleteobservabilitydestinationrequest.mdx deleted file mode 100644 index 74663cb4..00000000 --- a/client-sdks/python/api-reference/operations/deleteobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteObservabilityDestinationRequest - Python SDK -sidebarTitle: DeleteObservabilityDestinationRequest -description: DeleteObservabilityDestinationRequest method reference -seoTitle: DeleteObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - DeleteObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationRequest%20-%20Python%20SDK&description=DeleteObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteworkspaceglobals.mdx b/client-sdks/python/api-reference/operations/deleteworkspaceglobals.mdx deleted file mode 100644 index 98b1b895..00000000 --- a/client-sdks/python/api-reference/operations/deleteworkspaceglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DeleteWorkspaceGlobals - Python SDK -sidebarTitle: DeleteWorkspaceGlobals -description: DeleteWorkspaceGlobals method reference -seoTitle: DeleteWorkspaceGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceGlobals | OpenRouter Python SDK -'og:description': >- - DeleteWorkspaceGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceGlobals%20-%20Python%20SDK&description=DeleteWorkspaceGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/deleteworkspacerequest.mdx b/client-sdks/python/api-reference/operations/deleteworkspacerequest.mdx deleted file mode 100644 index 6e6a5b67..00000000 --- a/client-sdks/python/api-reference/operations/deleteworkspacerequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: DeleteWorkspaceRequest - Python SDK -sidebarTitle: DeleteWorkspaceRequest -description: DeleteWorkspaceRequest method reference -seoTitle: DeleteWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/deleteworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - DeleteWorkspaceRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceRequest%20-%20Python%20SDK&description=DeleteWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/document.mdx b/client-sdks/python/api-reference/operations/document.mdx deleted file mode 100644 index 45de4b40..00000000 --- a/client-sdks/python/api-reference/operations/document.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Document - Python SDK -sidebarTitle: Document -description: Document method reference -seoTitle: Document | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/document' -'og:site_name': OpenRouter Documentation -'og:title': Document | OpenRouter Python SDK -'og:description': >- - Document method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Document%20-%20Python%20SDK&description=Document%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The document object containing the original text - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `text` | *str* | :heavy_check_mark: | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/embedding.mdx b/client-sdks/python/api-reference/operations/embedding.mdx deleted file mode 100644 index 08166fbe..00000000 --- a/client-sdks/python/api-reference/operations/embedding.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Embedding - Python SDK -sidebarTitle: Embedding -description: Embedding method reference -seoTitle: Embedding | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/embedding' -'og:site_name': OpenRouter Documentation -'og:title': Embedding | OpenRouter Python SDK -'og:description': >- - Embedding method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embedding%20-%20Python%20SDK&description=Embedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Embedding vector as an array of floats or a base64 string - -## Supported Types - -### `List[float]` - -```python lines -value: List[float] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/encodingformat.mdx b/client-sdks/python/api-reference/operations/encodingformat.mdx deleted file mode 100644 index 353c8ef5..00000000 --- a/client-sdks/python/api-reference/operations/encodingformat.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: EncodingFormat - Python SDK -sidebarTitle: EncodingFormat -description: EncodingFormat method reference -seoTitle: EncodingFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/encodingformat' -'og:site_name': OpenRouter Documentation -'og:title': EncodingFormat | OpenRouter Python SDK -'og:description': >- - EncodingFormat method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EncodingFormat%20-%20Python%20SDK&description=EncodingFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The format of the output embeddings - -## Values - -| Name | Value | -| -------- | -------- | -| `FLOAT` | float | -| `BASE64` | base64 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx b/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx deleted file mode 100644 index 2a77d740..00000000 --- a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyCodeChallengeMethod - Python SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod -description: ExchangeAuthCodeForAPIKeyCodeChallengeMethod method reference -seoTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyCodeChallengeMethod method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Values - -| Name | Value | -| ------- | ------- | -| `S256` | S256 | -| `PLAIN` | plain | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx b/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx deleted file mode 100644 index dd510642..00000000 --- a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyGlobals - Python SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyGlobals -description: ExchangeAuthCodeForAPIKeyGlobals method reference -seoTitle: ExchangeAuthCodeForAPIKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/exchangeauthcodeforapikeyglobals -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyGlobals | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyGlobals%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx b/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx deleted file mode 100644 index a63e32bf..00000000 --- a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequest - Python SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyRequest -description: ExchangeAuthCodeForAPIKeyRequest method reference -seoTitle: ExchangeAuthCodeForAPIKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequest -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequest | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequest%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `request_body` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequestbody) | :heavy_check_mark: | N/A | `{"code": "auth_code_abc123def456","code_challenge_method": "S256","code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx b/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx deleted file mode 100644 index 1edc0037..00000000 --- a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequestBody - Python SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyRequestBody -description: ExchangeAuthCodeForAPIKeyRequestBody method reference -seoTitle: ExchangeAuthCodeForAPIKeyRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/exchangeauthcodeforapikeyrequestbody -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequestBody | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequestBody method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequestBody%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `code_verifier` | *Optional[str]* | :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/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx b/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx deleted file mode 100644 index 2ad03260..00000000 --- a/client-sdks/python/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyResponse - Python SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyResponse -description: ExchangeAuthCodeForAPIKeyResponse method reference -seoTitle: ExchangeAuthCodeForAPIKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/exchangeauthcodeforapikeyresponse -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyResponse | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyResponse%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Successfully exchanged code for an API key - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `user_id` | *Nullable[str]* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getbyokkeyglobals.mdx b/client-sdks/python/api-reference/operations/getbyokkeyglobals.mdx deleted file mode 100644 index 17a3e7c9..00000000 --- a/client-sdks/python/api-reference/operations/getbyokkeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetBYOKKeyGlobals - Python SDK -sidebarTitle: GetBYOKKeyGlobals -description: GetBYOKKeyGlobals method reference -seoTitle: GetBYOKKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getbyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyGlobals | OpenRouter Python SDK -'og:description': >- - GetBYOKKeyGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyGlobals%20-%20Python%20SDK&description=GetBYOKKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getbyokkeyrequest.mdx b/client-sdks/python/api-reference/operations/getbyokkeyrequest.mdx deleted file mode 100644 index 7931a283..00000000 --- a/client-sdks/python/api-reference/operations/getbyokkeyrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetBYOKKeyRequest - Python SDK -sidebarTitle: GetBYOKKeyRequest -description: GetBYOKKeyRequest method reference -seoTitle: GetBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - GetBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyRequest%20-%20Python%20SDK&description=GetBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcreditsdata.mdx b/client-sdks/python/api-reference/operations/getcreditsdata.mdx deleted file mode 100644 index f7fb37ce..00000000 --- a/client-sdks/python/api-reference/operations/getcreditsdata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetCreditsData - Python SDK -sidebarTitle: GetCreditsData -description: GetCreditsData method reference -seoTitle: GetCreditsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/getcreditsdata' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsData | OpenRouter Python SDK -'og:description': >- - GetCreditsData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsData%20-%20Python%20SDK&description=GetCreditsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `total_credits` | *float* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `total_usage` | *float* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcreditsglobals.mdx b/client-sdks/python/api-reference/operations/getcreditsglobals.mdx deleted file mode 100644 index 8bfd69e3..00000000 --- a/client-sdks/python/api-reference/operations/getcreditsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCreditsGlobals - Python SDK -sidebarTitle: GetCreditsGlobals -description: GetCreditsGlobals method reference -seoTitle: GetCreditsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcreditsglobals -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsGlobals | OpenRouter Python SDK -'og:description': >- - GetCreditsGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsGlobals%20-%20Python%20SDK&description=GetCreditsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcreditsrequest.mdx b/client-sdks/python/api-reference/operations/getcreditsrequest.mdx deleted file mode 100644 index 52f1b031..00000000 --- a/client-sdks/python/api-reference/operations/getcreditsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCreditsRequest - Python SDK -sidebarTitle: GetCreditsRequest -description: GetCreditsRequest method reference -seoTitle: GetCreditsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcreditsrequest -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsRequest | OpenRouter Python SDK -'og:description': >- - GetCreditsRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsRequest%20-%20Python%20SDK&description=GetCreditsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcreditsresponse.mdx b/client-sdks/python/api-reference/operations/getcreditsresponse.mdx deleted file mode 100644 index 25580bee..00000000 --- a/client-sdks/python/api-reference/operations/getcreditsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCreditsResponse - Python SDK -sidebarTitle: GetCreditsResponse -description: GetCreditsResponse method reference -seoTitle: GetCreditsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcreditsresponse -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsResponse | OpenRouter Python SDK -'og:description': >- - GetCreditsResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsResponse%20-%20Python%20SDK&description=GetCreditsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Total credits purchased and used - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.GetCreditsData](/client-sdks/python/api-reference/operations/getcreditsdata) | :heavy_check_mark: | N/A | `{"total_credits": 100.5,"total_usage": 25.75}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcurrentkeydata.mdx b/client-sdks/python/api-reference/operations/getcurrentkeydata.mdx deleted file mode 100644 index 15e1ab08..00000000 --- a/client-sdks/python/api-reference/operations/getcurrentkeydata.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: GetCurrentKeyData - Python SDK -sidebarTitle: GetCurrentKeyData -description: GetCurrentKeyData method reference -seoTitle: GetCurrentKeyData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcurrentkeydata -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyData | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyData%20-%20Python%20SDK&description=GetCurrentKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Current API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `is_management_key` | *bool* | :heavy_check_mark: | Whether this is a management key | false | -| ~~`is_provisioning_key`~~ | *bool* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| ~~`rate_limit`~~ | [operations.RateLimit](/client-sdks/python/api-reference/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` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcurrentkeyglobals.mdx b/client-sdks/python/api-reference/operations/getcurrentkeyglobals.mdx deleted file mode 100644 index 3fd20ff0..00000000 --- a/client-sdks/python/api-reference/operations/getcurrentkeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCurrentKeyGlobals - Python SDK -sidebarTitle: GetCurrentKeyGlobals -description: GetCurrentKeyGlobals method reference -seoTitle: GetCurrentKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcurrentkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyGlobals | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyGlobals%20-%20Python%20SDK&description=GetCurrentKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcurrentkeyrequest.mdx b/client-sdks/python/api-reference/operations/getcurrentkeyrequest.mdx deleted file mode 100644 index e0f91400..00000000 --- a/client-sdks/python/api-reference/operations/getcurrentkeyrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCurrentKeyRequest - Python SDK -sidebarTitle: GetCurrentKeyRequest -description: GetCurrentKeyRequest method reference -seoTitle: GetCurrentKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcurrentkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyRequest | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyRequest%20-%20Python%20SDK&description=GetCurrentKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getcurrentkeyresponse.mdx b/client-sdks/python/api-reference/operations/getcurrentkeyresponse.mdx deleted file mode 100644 index fffbb5f2..00000000 --- a/client-sdks/python/api-reference/operations/getcurrentkeyresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetCurrentKeyResponse - Python SDK -sidebarTitle: GetCurrentKeyResponse -description: GetCurrentKeyResponse method reference -seoTitle: GetCurrentKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getcurrentkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyResponse | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyResponse%20-%20Python%20SDK&description=GetCurrentKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetCurrentKeyData](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/getgenerationglobals.mdx b/client-sdks/python/api-reference/operations/getgenerationglobals.mdx deleted file mode 100644 index 389b176b..00000000 --- a/client-sdks/python/api-reference/operations/getgenerationglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetGenerationGlobals - Python SDK -sidebarTitle: GetGenerationGlobals -description: GetGenerationGlobals method reference -seoTitle: GetGenerationGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getgenerationglobals -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationGlobals | OpenRouter Python SDK -'og:description': >- - GetGenerationGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationGlobals%20-%20Python%20SDK&description=GetGenerationGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getgenerationrequest.mdx b/client-sdks/python/api-reference/operations/getgenerationrequest.mdx deleted file mode 100644 index 7479bc85..00000000 --- a/client-sdks/python/api-reference/operations/getgenerationrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetGenerationRequest - Python SDK -sidebarTitle: GetGenerationRequest -description: GetGenerationRequest method reference -seoTitle: GetGenerationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getgenerationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationRequest | OpenRouter Python SDK -'og:description': >- - GetGenerationRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationRequest%20-%20Python%20SDK&description=GetGenerationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getguardrailglobals.mdx b/client-sdks/python/api-reference/operations/getguardrailglobals.mdx deleted file mode 100644 index f3895c0e..00000000 --- a/client-sdks/python/api-reference/operations/getguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetGuardrailGlobals - Python SDK -sidebarTitle: GetGuardrailGlobals -description: GetGuardrailGlobals method reference -seoTitle: GetGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - GetGuardrailGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailGlobals%20-%20Python%20SDK&description=GetGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getguardrailrequest.mdx b/client-sdks/python/api-reference/operations/getguardrailrequest.mdx deleted file mode 100644 index 13e0f0ab..00000000 --- a/client-sdks/python/api-reference/operations/getguardrailrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetGuardrailRequest - Python SDK -sidebarTitle: GetGuardrailRequest -description: GetGuardrailRequest method reference -seoTitle: GetGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailRequest | OpenRouter Python SDK -'og:description': >- - GetGuardrailRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailRequest%20-%20Python%20SDK&description=GetGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getkeydata.mdx b/client-sdks/python/api-reference/operations/getkeydata.mdx deleted file mode 100644 index a3cc61cc..00000000 --- a/client-sdks/python/api-reference/operations/getkeydata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: GetKeyData - Python SDK -sidebarTitle: GetKeyData -description: GetKeyData method reference -seoTitle: GetKeyData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/getkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyData | OpenRouter Python SDK -'og:description': >- - GetKeyData method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyData%20-%20Python%20SDK&description=GetKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getkeyglobals.mdx b/client-sdks/python/api-reference/operations/getkeyglobals.mdx deleted file mode 100644 index c28ffb9e..00000000 --- a/client-sdks/python/api-reference/operations/getkeyglobals.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetKeyGlobals - Python SDK -sidebarTitle: GetKeyGlobals -description: GetKeyGlobals method reference -seoTitle: GetKeyGlobals | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/getkeyglobals' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyGlobals | OpenRouter Python SDK -'og:description': >- - GetKeyGlobals method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyGlobals%20-%20Python%20SDK&description=GetKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getkeyrequest.mdx b/client-sdks/python/api-reference/operations/getkeyrequest.mdx deleted file mode 100644 index 73c4fac4..00000000 --- a/client-sdks/python/api-reference/operations/getkeyrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetKeyRequest - Python SDK -sidebarTitle: GetKeyRequest -description: GetKeyRequest method reference -seoTitle: GetKeyRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/getkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyRequest | OpenRouter Python SDK -'og:description': >- - GetKeyRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyRequest%20-%20Python%20SDK&description=GetKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getkeyresponse.mdx b/client-sdks/python/api-reference/operations/getkeyresponse.mdx deleted file mode 100644 index 5febbc27..00000000 --- a/client-sdks/python/api-reference/operations/getkeyresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GetKeyResponse - Python SDK -sidebarTitle: GetKeyResponse -description: GetKeyResponse method reference -seoTitle: GetKeyResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/getkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyResponse | OpenRouter Python SDK -'og:description': >- - GetKeyResponse method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyResponse%20-%20Python%20SDK&description=GetKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetKeyData](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/getmodelsglobals.mdx b/client-sdks/python/api-reference/operations/getmodelsglobals.mdx deleted file mode 100644 index 0331f824..00000000 --- a/client-sdks/python/api-reference/operations/getmodelsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetModelsGlobals - Python SDK -sidebarTitle: GetModelsGlobals -description: GetModelsGlobals method reference -seoTitle: GetModelsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': GetModelsGlobals | OpenRouter Python SDK -'og:description': >- - GetModelsGlobals method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsGlobals%20-%20Python%20SDK&description=GetModelsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getmodelsrequest.mdx b/client-sdks/python/api-reference/operations/getmodelsrequest.mdx deleted file mode 100644 index c3c1a0d3..00000000 --- a/client-sdks/python/api-reference/operations/getmodelsrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: GetModelsRequest - Python SDK -sidebarTitle: GetModelsRequest -description: GetModelsRequest method reference -seoTitle: GetModelsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': GetModelsRequest | OpenRouter Python SDK -'og:description': >- - GetModelsRequest method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsRequest%20-%20Python%20SDK&description=GetModelsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [Optional[operations.Category]](../operations/category.md) | :heavy_minus_sign: | Filter models by use case category | programming | -| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `output_modalities` | *Optional[str]* | :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 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getobservabilitydestinationglobals.mdx b/client-sdks/python/api-reference/operations/getobservabilitydestinationglobals.mdx deleted file mode 100644 index 626dbca7..00000000 --- a/client-sdks/python/api-reference/operations/getobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetObservabilityDestinationGlobals - Python SDK -sidebarTitle: GetObservabilityDestinationGlobals -description: GetObservabilityDestinationGlobals method reference -seoTitle: GetObservabilityDestinationGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationGlobals | OpenRouter Python SDK -'og:description': >- - GetObservabilityDestinationGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationGlobals%20-%20Python%20SDK&description=GetObservabilityDestinationGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/operations/getobservabilitydestinationrequest.mdx deleted file mode 100644 index 0dc7eb00..00000000 --- a/client-sdks/python/api-reference/operations/getobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetObservabilityDestinationRequest - Python SDK -sidebarTitle: GetObservabilityDestinationRequest -description: GetObservabilityDestinationRequest method reference -seoTitle: GetObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - GetObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationRequest%20-%20Python%20SDK&description=GetObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getrankingsdailyglobals.mdx b/client-sdks/python/api-reference/operations/getrankingsdailyglobals.mdx deleted file mode 100644 index ade8d725..00000000 --- a/client-sdks/python/api-reference/operations/getrankingsdailyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetRankingsDailyGlobals - Python SDK -sidebarTitle: GetRankingsDailyGlobals -description: GetRankingsDailyGlobals method reference -seoTitle: GetRankingsDailyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getrankingsdailyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetRankingsDailyGlobals | OpenRouter Python SDK -'og:description': >- - GetRankingsDailyGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetRankingsDailyGlobals%20-%20Python%20SDK&description=GetRankingsDailyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getrankingsdailyrequest.mdx b/client-sdks/python/api-reference/operations/getrankingsdailyrequest.mdx deleted file mode 100644 index 715e7ee1..00000000 --- a/client-sdks/python/api-reference/operations/getrankingsdailyrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: GetRankingsDailyRequest - Python SDK -sidebarTitle: GetRankingsDailyRequest -description: GetRankingsDailyRequest method reference -seoTitle: GetRankingsDailyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getrankingsdailyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetRankingsDailyRequest | OpenRouter Python SDK -'og:description': >- - GetRankingsDailyRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetRankingsDailyRequest%20-%20Python%20SDK&description=GetRankingsDailyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `start_date` | *Optional[str]* | :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 | -| `end_date` | *Optional[str]* | :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 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getuseractivityglobals.mdx b/client-sdks/python/api-reference/operations/getuseractivityglobals.mdx deleted file mode 100644 index 2a934d74..00000000 --- a/client-sdks/python/api-reference/operations/getuseractivityglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetUserActivityGlobals - Python SDK -sidebarTitle: GetUserActivityGlobals -description: GetUserActivityGlobals method reference -seoTitle: GetUserActivityGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getuseractivityglobals -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityGlobals | OpenRouter Python SDK -'og:description': >- - GetUserActivityGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityGlobals%20-%20Python%20SDK&description=GetUserActivityGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getuseractivityrequest.mdx b/client-sdks/python/api-reference/operations/getuseractivityrequest.mdx deleted file mode 100644 index c17d30f1..00000000 --- a/client-sdks/python/api-reference/operations/getuseractivityrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: GetUserActivityRequest - Python SDK -sidebarTitle: GetUserActivityRequest -description: GetUserActivityRequest method reference -seoTitle: GetUserActivityRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getuseractivityrequest -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityRequest | OpenRouter Python SDK -'og:description': >- - GetUserActivityRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityRequest%20-%20Python%20SDK&description=GetUserActivityRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `api_key_hash` | *Optional[str]* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `user_id` | *Optional[str]* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getvideosglobals.mdx b/client-sdks/python/api-reference/operations/getvideosglobals.mdx deleted file mode 100644 index d6444b50..00000000 --- a/client-sdks/python/api-reference/operations/getvideosglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetVideosGlobals - Python SDK -sidebarTitle: GetVideosGlobals -description: GetVideosGlobals method reference -seoTitle: GetVideosGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getvideosglobals -'og:site_name': OpenRouter Documentation -'og:title': GetVideosGlobals | OpenRouter Python SDK -'og:description': >- - GetVideosGlobals method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetVideosGlobals%20-%20Python%20SDK&description=GetVideosGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getvideosrequest.mdx b/client-sdks/python/api-reference/operations/getvideosrequest.mdx deleted file mode 100644 index 5fa4a5eb..00000000 --- a/client-sdks/python/api-reference/operations/getvideosrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetVideosRequest - Python SDK -sidebarTitle: GetVideosRequest -description: GetVideosRequest method reference -seoTitle: GetVideosRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getvideosrequest -'og:site_name': OpenRouter Documentation -'og:title': GetVideosRequest | OpenRouter Python SDK -'og:description': >- - GetVideosRequest method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetVideosRequest%20-%20Python%20SDK&description=GetVideosRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getworkspaceglobals.mdx b/client-sdks/python/api-reference/operations/getworkspaceglobals.mdx deleted file mode 100644 index 2ac2fb4a..00000000 --- a/client-sdks/python/api-reference/operations/getworkspaceglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetWorkspaceGlobals - Python SDK -sidebarTitle: GetWorkspaceGlobals -description: GetWorkspaceGlobals method reference -seoTitle: GetWorkspaceGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceGlobals | OpenRouter Python SDK -'og:description': >- - GetWorkspaceGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceGlobals%20-%20Python%20SDK&description=GetWorkspaceGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/getworkspacerequest.mdx b/client-sdks/python/api-reference/operations/getworkspacerequest.mdx deleted file mode 100644 index f1c623b2..00000000 --- a/client-sdks/python/api-reference/operations/getworkspacerequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: GetWorkspaceRequest - Python SDK -sidebarTitle: GetWorkspaceRequest -description: GetWorkspaceRequest method reference -seoTitle: GetWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/getworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - GetWorkspaceRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceRequest%20-%20Python%20SDK&description=GetWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/headquarters.mdx b/client-sdks/python/api-reference/operations/headquarters.mdx deleted file mode 100644 index c298d2aa..00000000 --- a/client-sdks/python/api-reference/operations/headquarters.mdx +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: Headquarters - Python SDK -sidebarTitle: Headquarters -description: Headquarters method reference -seoTitle: Headquarters | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/headquarters' -'og:site_name': OpenRouter Documentation -'og:title': Headquarters | OpenRouter Python SDK -'og:description': >- - Headquarters method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Headquarters%20-%20Python%20SDK&description=Headquarters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -ISO 3166-1 Alpha-2 country code of the provider headquarters - -## Values - -| Name | Value | -| ----- | ----- | -| `AD` | AD | -| `AE` | AE | -| `AF` | AF | -| `AG` | AG | -| `AI` | AI | -| `AL` | AL | -| `AM` | AM | -| `AO` | AO | -| `AQ` | AQ | -| `AR` | AR | -| `AS` | AS | -| `AT` | AT | -| `AU` | AU | -| `AW` | AW | -| `AX` | AX | -| `AZ` | AZ | -| `BA` | BA | -| `BB` | BB | -| `BD` | BD | -| `BE` | BE | -| `BF` | BF | -| `BG` | BG | -| `BH` | BH | -| `BI` | BI | -| `BJ` | BJ | -| `BL` | BL | -| `BM` | BM | -| `BN` | BN | -| `BO` | BO | -| `BQ` | BQ | -| `BR` | BR | -| `BS` | BS | -| `BT` | BT | -| `BV` | BV | -| `BW` | BW | -| `BY` | BY | -| `BZ` | BZ | -| `CA` | CA | -| `CC` | CC | -| `CD` | CD | -| `CF` | CF | -| `CG` | CG | -| `CH` | CH | -| `CI` | CI | -| `CK` | CK | -| `CL` | CL | -| `CM` | CM | -| `CN` | CN | -| `CO` | CO | -| `CR` | CR | -| `CU` | CU | -| `CV` | CV | -| `CW` | CW | -| `CX` | CX | -| `CY` | CY | -| `CZ` | CZ | -| `DE` | DE | -| `DJ` | DJ | -| `DK` | DK | -| `DM` | DM | -| `DO` | DO | -| `DZ` | DZ | -| `EC` | EC | -| `EE` | EE | -| `EG` | EG | -| `EH` | EH | -| `ER` | ER | -| `ES` | ES | -| `ET` | ET | -| `FI` | FI | -| `FJ` | FJ | -| `FK` | FK | -| `FM` | FM | -| `FO` | FO | -| `FR` | FR | -| `GA` | GA | -| `GB` | GB | -| `GD` | GD | -| `GE` | GE | -| `GF` | GF | -| `GG` | GG | -| `GH` | GH | -| `GI` | GI | -| `GL` | GL | -| `GM` | GM | -| `GN` | GN | -| `GP` | GP | -| `GQ` | GQ | -| `GR` | GR | -| `GS` | GS | -| `GT` | GT | -| `GU` | GU | -| `GW` | GW | -| `GY` | GY | -| `HK` | HK | -| `HM` | HM | -| `HN` | HN | -| `HR` | HR | -| `HT` | HT | -| `HU` | HU | -| `ID` | ID | -| `IE` | IE | -| `IL` | IL | -| `IM` | IM | -| `IN` | IN | -| `IO` | IO | -| `IQ` | IQ | -| `IR` | IR | -| `IS` | IS | -| `IT` | IT | -| `JE` | JE | -| `JM` | JM | -| `JO` | JO | -| `JP` | JP | -| `KE` | KE | -| `KG` | KG | -| `KH` | KH | -| `KI` | KI | -| `KM` | KM | -| `KN` | KN | -| `KP` | KP | -| `KR` | KR | -| `KW` | KW | -| `KY` | KY | -| `KZ` | KZ | -| `LA` | LA | -| `LB` | LB | -| `LC` | LC | -| `LI` | LI | -| `LK` | LK | -| `LR` | LR | -| `LS` | LS | -| `LT` | LT | -| `LU` | LU | -| `LV` | LV | -| `LY` | LY | -| `MA` | MA | -| `MC` | MC | -| `MD` | MD | -| `ME` | ME | -| `MF` | MF | -| `MG` | MG | -| `MH` | MH | -| `MK` | MK | -| `ML` | ML | -| `MM` | MM | -| `MN` | MN | -| `MO` | MO | -| `MP` | MP | -| `MQ` | MQ | -| `MR` | MR | -| `MS` | MS | -| `MT` | MT | -| `MU` | MU | -| `MV` | MV | -| `MW` | MW | -| `MX` | MX | -| `MY` | MY | -| `MZ` | MZ | -| `NA` | NA | -| `NC` | NC | -| `NE` | NE | -| `NF` | NF | -| `NG` | NG | -| `NI` | NI | -| `NL` | NL | -| `NO` | NO | -| `NP` | NP | -| `NR` | NR | -| `NU` | NU | -| `NZ` | NZ | -| `OM` | OM | -| `PA` | PA | -| `PE` | PE | -| `PF` | PF | -| `PG` | PG | -| `PH` | PH | -| `PK` | PK | -| `PL` | PL | -| `PM` | PM | -| `PN` | PN | -| `PR` | PR | -| `PS` | PS | -| `PT` | PT | -| `PW` | PW | -| `PY` | PY | -| `QA` | QA | -| `RE` | RE | -| `RO` | RO | -| `RS` | RS | -| `RU` | RU | -| `RW` | RW | -| `SA` | SA | -| `SB` | SB | -| `SC` | SC | -| `SD` | SD | -| `SE` | SE | -| `SG` | SG | -| `SH` | SH | -| `SI` | SI | -| `SJ` | SJ | -| `SK` | SK | -| `SL` | SL | -| `SM` | SM | -| `SN` | SN | -| `SO` | SO | -| `SR` | SR | -| `SS` | SS | -| `ST` | ST | -| `SV` | SV | -| `SX` | SX | -| `SY` | SY | -| `SZ` | SZ | -| `TC` | TC | -| `TD` | TD | -| `TF` | TF | -| `TG` | TG | -| `TH` | TH | -| `TJ` | TJ | -| `TK` | TK | -| `TL` | TL | -| `TM` | TM | -| `TN` | TN | -| `TO` | TO | -| `TR` | TR | -| `TT` | TT | -| `TV` | TV | -| `TW` | TW | -| `TZ` | TZ | -| `UA` | UA | -| `UG` | UG | -| `UM` | UM | -| `US` | US | -| `UY` | UY | -| `UZ` | UZ | -| `VA` | VA | -| `VC` | VC | -| `VE` | VE | -| `VG` | VG | -| `VI` | VI | -| `VN` | VN | -| `VU` | VU | -| `WF` | WF | -| `WS` | WS | -| `YE` | YE | -| `YT` | YT | -| `ZA` | ZA | -| `ZM` | ZM | -| `ZW` | ZW | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/imageurl.mdx b/client-sdks/python/api-reference/operations/imageurl.mdx deleted file mode 100644 index 26dbfc77..00000000 --- a/client-sdks/python/api-reference/operations/imageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ImageURL - Python SDK -sidebarTitle: ImageURL -description: ImageURL method reference -seoTitle: ImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageURL | OpenRouter Python SDK -'og:description': >- - ImageURL method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageURL%20-%20Python%20SDK&description=ImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/input.mdx b/client-sdks/python/api-reference/operations/input.mdx deleted file mode 100644 index febbf7fb..00000000 --- a/client-sdks/python/api-reference/operations/input.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Input - Python SDK -sidebarTitle: Input -description: Input method reference -seoTitle: Input | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/input' -'og:site_name': OpenRouter Documentation -'og:title': Input | OpenRouter Python SDK -'og:description': >- - Input method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input%20-%20Python%20SDK&description=Input%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | List[[operations.Content](/client-sdks/python/api-reference/operations/content)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/inputunion.mdx b/client-sdks/python/api-reference/operations/inputunion.mdx deleted file mode 100644 index 34c59c10..00000000 --- a/client-sdks/python/api-reference/operations/inputunion.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: InputUnion - Python SDK -sidebarTitle: InputUnion -description: InputUnion method reference -seoTitle: InputUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion | OpenRouter Python SDK -'og:description': >- - InputUnion method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20Python%20SDK&description=InputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text, token, or multimodal input(s) to embed - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `List[float]` - -```python lines -value: List[float] = /* values here */ -``` - -### `List[List[float]]` - -```python lines -value: List[List[float]] = /* values here */ -``` - -### `List[operations.Input]` - -```python lines -value: List[operations.Input] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listbyokkeysglobals.mdx b/client-sdks/python/api-reference/operations/listbyokkeysglobals.mdx deleted file mode 100644 index 4067474e..00000000 --- a/client-sdks/python/api-reference/operations/listbyokkeysglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListBYOKKeysGlobals - Python SDK -sidebarTitle: ListBYOKKeysGlobals -description: ListBYOKKeysGlobals method reference -seoTitle: ListBYOKKeysGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listbyokkeysglobals -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysGlobals | OpenRouter Python SDK -'og:description': >- - ListBYOKKeysGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysGlobals%20-%20Python%20SDK&description=ListBYOKKeysGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listbyokkeysrequest.mdx b/client-sdks/python/api-reference/operations/listbyokkeysrequest.mdx deleted file mode 100644 index 7990d996..00000000 --- a/client-sdks/python/api-reference/operations/listbyokkeysrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ListBYOKKeysRequest - Python SDK -sidebarTitle: ListBYOKKeysRequest -description: ListBYOKKeysRequest method reference -seoTitle: ListBYOKKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listbyokkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysRequest | OpenRouter Python SDK -'og:description': >- - ListBYOKKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysRequest%20-%20Python%20SDK&description=ListBYOKKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [Optional[operations.Provider]](../operations/provider.md) | :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/client-sdks/python/api-reference/operations/listbyokkeysresponse.mdx b/client-sdks/python/api-reference/operations/listbyokkeysresponse.mdx deleted file mode 100644 index 58adc1db..00000000 --- a/client-sdks/python/api-reference/operations/listbyokkeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListBYOKKeysResponse - Python SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse method reference -seoTitle: ListBYOKKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listbyokkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse | OpenRouter Python SDK -'og:description': >- - ListBYOKKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20Python%20SDK&description=ListBYOKKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListBYOKKeysResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listdata.mdx b/client-sdks/python/api-reference/operations/listdata.mdx deleted file mode 100644 index 8d537cd4..00000000 --- a/client-sdks/python/api-reference/operations/listdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListData - Python SDK -sidebarTitle: ListData -description: ListData method reference -seoTitle: ListData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/listdata' -'og:site_name': OpenRouter Documentation -'og:title': ListData | OpenRouter Python SDK -'og:description': >- - ListData method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListData%20-%20Python%20SDK&description=ListData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listembeddingsmodelsglobals.mdx b/client-sdks/python/api-reference/operations/listembeddingsmodelsglobals.mdx deleted file mode 100644 index 0b2c36e0..00000000 --- a/client-sdks/python/api-reference/operations/listembeddingsmodelsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEmbeddingsModelsGlobals - Python SDK -sidebarTitle: ListEmbeddingsModelsGlobals -description: ListEmbeddingsModelsGlobals method reference -seoTitle: ListEmbeddingsModelsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listembeddingsmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEmbeddingsModelsGlobals | OpenRouter Python SDK -'og:description': >- - ListEmbeddingsModelsGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEmbeddingsModelsGlobals%20-%20Python%20SDK&description=ListEmbeddingsModelsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listembeddingsmodelsrequest.mdx b/client-sdks/python/api-reference/operations/listembeddingsmodelsrequest.mdx deleted file mode 100644 index c854e629..00000000 --- a/client-sdks/python/api-reference/operations/listembeddingsmodelsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEmbeddingsModelsRequest - Python SDK -sidebarTitle: ListEmbeddingsModelsRequest -description: ListEmbeddingsModelsRequest method reference -seoTitle: ListEmbeddingsModelsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listembeddingsmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEmbeddingsModelsRequest | OpenRouter Python SDK -'og:description': >- - ListEmbeddingsModelsRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEmbeddingsModelsRequest%20-%20Python%20SDK&description=ListEmbeddingsModelsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listendpointsglobals.mdx b/client-sdks/python/api-reference/operations/listendpointsglobals.mdx deleted file mode 100644 index 1eaa4c1b..00000000 --- a/client-sdks/python/api-reference/operations/listendpointsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsGlobals - Python SDK -sidebarTitle: ListEndpointsGlobals -description: ListEndpointsGlobals method reference -seoTitle: ListEndpointsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsGlobals | OpenRouter Python SDK -'og:description': >- - ListEndpointsGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsGlobals%20-%20Python%20SDK&description=ListEndpointsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listendpointsrequest.mdx b/client-sdks/python/api-reference/operations/listendpointsrequest.mdx deleted file mode 100644 index 4b04f104..00000000 --- a/client-sdks/python/api-reference/operations/listendpointsrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListEndpointsRequest - Python SDK -sidebarTitle: ListEndpointsRequest -description: ListEndpointsRequest method reference -seoTitle: ListEndpointsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsRequest | OpenRouter Python SDK -'og:description': >- - ListEndpointsRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsRequest%20-%20Python%20SDK&description=ListEndpointsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *str* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *str* | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listendpointsresponse.mdx b/client-sdks/python/api-reference/operations/listendpointsresponse.mdx deleted file mode 100644 index 57f647cf..00000000 --- a/client-sdks/python/api-reference/operations/listendpointsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsResponse - Python SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Python%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ListEndpointsResponse](/client-sdks/python/api-reference/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_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}`,
"provider_name": "OpenAI",
"quantization": "fp16",
"status": "default",
"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/client-sdks/python/api-reference/operations/listendpointszdrglobals.mdx b/client-sdks/python/api-reference/operations/listendpointszdrglobals.mdx deleted file mode 100644 index c5a6f9d4..00000000 --- a/client-sdks/python/api-reference/operations/listendpointszdrglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsZdrGlobals - Python SDK -sidebarTitle: ListEndpointsZdrGlobals -description: ListEndpointsZdrGlobals method reference -seoTitle: ListEndpointsZdrGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointszdrglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrGlobals | OpenRouter Python SDK -'og:description': >- - ListEndpointsZdrGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrGlobals%20-%20Python%20SDK&description=ListEndpointsZdrGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listendpointszdrrequest.mdx b/client-sdks/python/api-reference/operations/listendpointszdrrequest.mdx deleted file mode 100644 index c05f86ad..00000000 --- a/client-sdks/python/api-reference/operations/listendpointszdrrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsZdrRequest - Python SDK -sidebarTitle: ListEndpointsZdrRequest -description: ListEndpointsZdrRequest method reference -seoTitle: ListEndpointsZdrRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointszdrrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrRequest | OpenRouter Python SDK -'og:description': >- - ListEndpointsZdrRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrRequest%20-%20Python%20SDK&description=ListEndpointsZdrRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listendpointszdrresponse.mdx b/client-sdks/python/api-reference/operations/listendpointszdrresponse.mdx deleted file mode 100644 index 76ca5af0..00000000 --- a/client-sdks/python/api-reference/operations/listendpointszdrresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListEndpointsZdrResponse - Python SDK -sidebarTitle: ListEndpointsZdrResponse -description: ListEndpointsZdrResponse method reference -seoTitle: ListEndpointsZdrResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listendpointszdrresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsZdrResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrResponse%20-%20Python%20SDK&description=ListEndpointsZdrResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | List[[components.PublicEndpoint](/client-sdks/python/api-reference/components/publicendpoint)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listgenerationcontentglobals.mdx b/client-sdks/python/api-reference/operations/listgenerationcontentglobals.mdx deleted file mode 100644 index 754a72ae..00000000 --- a/client-sdks/python/api-reference/operations/listgenerationcontentglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGenerationContentGlobals - Python SDK -sidebarTitle: ListGenerationContentGlobals -description: ListGenerationContentGlobals method reference -seoTitle: ListGenerationContentGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listgenerationcontentglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGenerationContentGlobals | OpenRouter Python SDK -'og:description': >- - ListGenerationContentGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGenerationContentGlobals%20-%20Python%20SDK&description=ListGenerationContentGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listgenerationcontentrequest.mdx b/client-sdks/python/api-reference/operations/listgenerationcontentrequest.mdx deleted file mode 100644 index a94be789..00000000 --- a/client-sdks/python/api-reference/operations/listgenerationcontentrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListGenerationContentRequest - Python SDK -sidebarTitle: ListGenerationContentRequest -description: ListGenerationContentRequest method reference -seoTitle: ListGenerationContentRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listgenerationcontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGenerationContentRequest | OpenRouter Python SDK -'og:description': >- - ListGenerationContentRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGenerationContentRequest%20-%20Python%20SDK&description=ListGenerationContentRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listglobals.mdx b/client-sdks/python/api-reference/operations/listglobals.mdx deleted file mode 100644 index 4a3bcab9..00000000 --- a/client-sdks/python/api-reference/operations/listglobals.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListGlobals - Python SDK -sidebarTitle: ListGlobals -description: ListGlobals method reference -seoTitle: ListGlobals | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/listglobals' -'og:site_name': OpenRouter Documentation -'og:title': ListGlobals | OpenRouter Python SDK -'og:description': >- - ListGlobals method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGlobals%20-%20Python%20SDK&description=ListGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsglobals.mdx b/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsglobals.mdx deleted file mode 100644 index a6edc21c..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsGlobals - Python SDK -sidebarTitle: ListGuardrailKeyAssignmentsGlobals -description: ListGuardrailKeyAssignmentsGlobals method reference -seoTitle: ListGuardrailKeyAssignmentsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailkeyassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsGlobals | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsGlobals%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsrequest.mdx b/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsrequest.mdx deleted file mode 100644 index 0851d073..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsRequest - Python SDK -sidebarTitle: ListGuardrailKeyAssignmentsRequest -description: ListGuardrailKeyAssignmentsRequest method reference -seoTitle: ListGuardrailKeyAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsRequest%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsresponse.mdx b/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsresponse.mdx deleted file mode 100644 index 2e7e9d77..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailkeyassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsResponse - Python SDK -sidebarTitle: ListGuardrailKeyAssignmentsResponse -description: ListGuardrailKeyAssignmentsResponse method reference -seoTitle: ListGuardrailKeyAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsResponse%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsglobals.mdx b/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsglobals.mdx deleted file mode 100644 index f461aed7..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsGlobals - Python SDK -sidebarTitle: ListGuardrailMemberAssignmentsGlobals -description: ListGuardrailMemberAssignmentsGlobals method reference -seoTitle: ListGuardrailMemberAssignmentsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailmemberassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsGlobals | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsGlobals%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsrequest.mdx b/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsrequest.mdx deleted file mode 100644 index dd1eb5cb..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsRequest - Python SDK -sidebarTitle: ListGuardrailMemberAssignmentsRequest -description: ListGuardrailMemberAssignmentsRequest method reference -seoTitle: ListGuardrailMemberAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsRequest%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsresponse.mdx b/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsresponse.mdx deleted file mode 100644 index ffd3487e..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailmemberassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsResponse - Python SDK -sidebarTitle: ListGuardrailMemberAssignmentsResponse -description: ListGuardrailMemberAssignmentsResponse method reference -seoTitle: ListGuardrailMemberAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsResponse%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listguardrailsglobals.mdx b/client-sdks/python/api-reference/operations/listguardrailsglobals.mdx deleted file mode 100644 index 4ae7e1c2..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailsGlobals - Python SDK -sidebarTitle: ListGuardrailsGlobals -description: ListGuardrailsGlobals method reference -seoTitle: ListGuardrailsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsGlobals | OpenRouter Python SDK -'og:description': >- - ListGuardrailsGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsGlobals%20-%20Python%20SDK&description=ListGuardrailsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailsrequest.mdx b/client-sdks/python/api-reference/operations/listguardrailsrequest.mdx deleted file mode 100644 index c3bb4cbc..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailsrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListGuardrailsRequest - Python SDK -sidebarTitle: ListGuardrailsRequest -description: ListGuardrailsRequest method reference -seoTitle: ListGuardrailsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsRequest%20-%20Python%20SDK&description=ListGuardrailsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listguardrailsresponse.mdx b/client-sdks/python/api-reference/operations/listguardrailsresponse.mdx deleted file mode 100644 index c73750cd..00000000 --- a/client-sdks/python/api-reference/operations/listguardrailsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListGuardrailsResponse - Python SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse method reference -seoTitle: ListGuardrailsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listguardrailsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20Python%20SDK&description=ListGuardrailsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListGuardrailsResponse](/client-sdks/python/api-reference/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,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/python/api-reference/operations/listkeyassignmentsglobals.mdx b/client-sdks/python/api-reference/operations/listkeyassignmentsglobals.mdx deleted file mode 100644 index f886548e..00000000 --- a/client-sdks/python/api-reference/operations/listkeyassignmentsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListKeyAssignmentsGlobals - Python SDK -sidebarTitle: ListKeyAssignmentsGlobals -description: ListKeyAssignmentsGlobals method reference -seoTitle: ListKeyAssignmentsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listkeyassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsGlobals | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsGlobals%20-%20Python%20SDK&description=ListKeyAssignmentsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listkeyassignmentsrequest.mdx b/client-sdks/python/api-reference/operations/listkeyassignmentsrequest.mdx deleted file mode 100644 index 3ebe7570..00000000 --- a/client-sdks/python/api-reference/operations/listkeyassignmentsrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListKeyAssignmentsRequest - Python SDK -sidebarTitle: ListKeyAssignmentsRequest -description: ListKeyAssignmentsRequest method reference -seoTitle: ListKeyAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsRequest%20-%20Python%20SDK&description=ListKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listkeyassignmentsresponse.mdx b/client-sdks/python/api-reference/operations/listkeyassignmentsresponse.mdx deleted file mode 100644 index e0795245..00000000 --- a/client-sdks/python/api-reference/operations/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - Python SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse method reference -seoTitle: ListKeyAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20Python%20SDK&description=ListKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListKeyAssignmentsResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listmemberassignmentsglobals.mdx b/client-sdks/python/api-reference/operations/listmemberassignmentsglobals.mdx deleted file mode 100644 index de081871..00000000 --- a/client-sdks/python/api-reference/operations/listmemberassignmentsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListMemberAssignmentsGlobals - Python SDK -sidebarTitle: ListMemberAssignmentsGlobals -description: ListMemberAssignmentsGlobals method reference -seoTitle: ListMemberAssignmentsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmemberassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsGlobals | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsGlobals%20-%20Python%20SDK&description=ListMemberAssignmentsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmemberassignmentsrequest.mdx b/client-sdks/python/api-reference/operations/listmemberassignmentsrequest.mdx deleted file mode 100644 index dce60ae5..00000000 --- a/client-sdks/python/api-reference/operations/listmemberassignmentsrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListMemberAssignmentsRequest - Python SDK -sidebarTitle: ListMemberAssignmentsRequest -description: ListMemberAssignmentsRequest method reference -seoTitle: ListMemberAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsRequest%20-%20Python%20SDK&description=ListMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmemberassignmentsresponse.mdx b/client-sdks/python/api-reference/operations/listmemberassignmentsresponse.mdx deleted file mode 100644 index f48912f0..00000000 --- a/client-sdks/python/api-reference/operations/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - Python SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse method reference -seoTitle: ListMemberAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20Python%20SDK&description=ListMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListMemberAssignmentsResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listmodelscountglobals.mdx b/client-sdks/python/api-reference/operations/listmodelscountglobals.mdx deleted file mode 100644 index 638992ff..00000000 --- a/client-sdks/python/api-reference/operations/listmodelscountglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListModelsCountGlobals - Python SDK -sidebarTitle: ListModelsCountGlobals -description: ListModelsCountGlobals method reference -seoTitle: ListModelsCountGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmodelscountglobals -'og:site_name': OpenRouter Documentation -'og:title': ListModelsCountGlobals | OpenRouter Python SDK -'og:description': >- - ListModelsCountGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsCountGlobals%20-%20Python%20SDK&description=ListModelsCountGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmodelscountrequest.mdx b/client-sdks/python/api-reference/operations/listmodelscountrequest.mdx deleted file mode 100644 index 2fd77115..00000000 --- a/client-sdks/python/api-reference/operations/listmodelscountrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListModelsCountRequest - Python SDK -sidebarTitle: ListModelsCountRequest -description: ListModelsCountRequest method reference -seoTitle: ListModelsCountRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmodelscountrequest -'og:site_name': OpenRouter Documentation -'og:title': ListModelsCountRequest | OpenRouter Python SDK -'og:description': >- - ListModelsCountRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsCountRequest%20-%20Python%20SDK&description=ListModelsCountRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `output_modalities` | *Optional[str]* | :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 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmodelsuserglobals.mdx b/client-sdks/python/api-reference/operations/listmodelsuserglobals.mdx deleted file mode 100644 index c029fef3..00000000 --- a/client-sdks/python/api-reference/operations/listmodelsuserglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListModelsUserGlobals - Python SDK -sidebarTitle: ListModelsUserGlobals -description: ListModelsUserGlobals method reference -seoTitle: ListModelsUserGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmodelsuserglobals -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserGlobals | OpenRouter Python SDK -'og:description': >- - ListModelsUserGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserGlobals%20-%20Python%20SDK&description=ListModelsUserGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmodelsuserrequest.mdx b/client-sdks/python/api-reference/operations/listmodelsuserrequest.mdx deleted file mode 100644 index 3a8e69b4..00000000 --- a/client-sdks/python/api-reference/operations/listmodelsuserrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListModelsUserRequest - Python SDK -sidebarTitle: ListModelsUserRequest -description: ListModelsUserRequest method reference -seoTitle: ListModelsUserRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmodelsuserrequest -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserRequest | OpenRouter Python SDK -'og:description': >- - ListModelsUserRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserRequest%20-%20Python%20SDK&description=ListModelsUserRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listmodelsusersecurity.mdx b/client-sdks/python/api-reference/operations/listmodelsusersecurity.mdx deleted file mode 100644 index 34d16ad6..00000000 --- a/client-sdks/python/api-reference/operations/listmodelsusersecurity.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListModelsUserSecurity - Python SDK -sidebarTitle: ListModelsUserSecurity -description: ListModelsUserSecurity method reference -seoTitle: ListModelsUserSecurity | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listmodelsusersecurity -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserSecurity | OpenRouter Python SDK -'og:description': >- - ListModelsUserSecurity method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserSecurity%20-%20Python%20SDK&description=ListModelsUserSecurity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listobservabilitydestinationsglobals.mdx b/client-sdks/python/api-reference/operations/listobservabilitydestinationsglobals.mdx deleted file mode 100644 index 85a1321e..00000000 --- a/client-sdks/python/api-reference/operations/listobservabilitydestinationsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListObservabilityDestinationsGlobals - Python SDK -sidebarTitle: ListObservabilityDestinationsGlobals -description: ListObservabilityDestinationsGlobals method reference -seoTitle: ListObservabilityDestinationsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listobservabilitydestinationsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsGlobals | OpenRouter Python SDK -'og:description': >- - ListObservabilityDestinationsGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsGlobals%20-%20Python%20SDK&description=ListObservabilityDestinationsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listobservabilitydestinationsrequest.mdx b/client-sdks/python/api-reference/operations/listobservabilitydestinationsrequest.mdx deleted file mode 100644 index cd161a4c..00000000 --- a/client-sdks/python/api-reference/operations/listobservabilitydestinationsrequest.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListObservabilityDestinationsRequest - Python SDK -sidebarTitle: ListObservabilityDestinationsRequest -description: ListObservabilityDestinationsRequest method reference -seoTitle: ListObservabilityDestinationsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listobservabilitydestinationsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsRequest | OpenRouter Python SDK -'og:description': >- - ListObservabilityDestinationsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsRequest%20-%20Python%20SDK&description=ListObservabilityDestinationsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listobservabilitydestinationsresponse.mdx b/client-sdks/python/api-reference/operations/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index 38530898..00000000 --- a/client-sdks/python/api-reference/operations/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - Python SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse method reference -seoTitle: ListObservabilityDestinationsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse | OpenRouter Python SDK -'og:description': >- - ListObservabilityDestinationsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20Python%20SDK&description=ListObservabilityDestinationsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListObservabilityDestinationsResponse](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/listorganizationmembersdata.mdx b/client-sdks/python/api-reference/operations/listorganizationmembersdata.mdx deleted file mode 100644 index 28b560b4..00000000 --- a/client-sdks/python/api-reference/operations/listorganizationmembersdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListOrganizationMembersData - Python SDK -sidebarTitle: ListOrganizationMembersData -description: ListOrganizationMembersData method reference -seoTitle: ListOrganizationMembersData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listorganizationmembersdata -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersData | OpenRouter Python SDK -'og:description': >- - ListOrganizationMembersData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersData%20-%20Python%20SDK&description=ListOrganizationMembersData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `email` | *str* | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `first_name` | *Nullable[str]* | :heavy_check_mark: | First name of the member | Jane | -| `id` | *str* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `last_name` | *Nullable[str]* | :heavy_check_mark: | Last name of the member | Doe | -| `role` | [operations.Role](/client-sdks/python/api-reference/operations/role) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listorganizationmembersglobals.mdx b/client-sdks/python/api-reference/operations/listorganizationmembersglobals.mdx deleted file mode 100644 index d8c1b287..00000000 --- a/client-sdks/python/api-reference/operations/listorganizationmembersglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListOrganizationMembersGlobals - Python SDK -sidebarTitle: ListOrganizationMembersGlobals -description: ListOrganizationMembersGlobals method reference -seoTitle: ListOrganizationMembersGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listorganizationmembersglobals -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersGlobals | OpenRouter Python SDK -'og:description': >- - ListOrganizationMembersGlobals method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersGlobals%20-%20Python%20SDK&description=ListOrganizationMembersGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listorganizationmembersrequest.mdx b/client-sdks/python/api-reference/operations/listorganizationmembersrequest.mdx deleted file mode 100644 index b8133461..00000000 --- a/client-sdks/python/api-reference/operations/listorganizationmembersrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListOrganizationMembersRequest - Python SDK -sidebarTitle: ListOrganizationMembersRequest -description: ListOrganizationMembersRequest method reference -seoTitle: ListOrganizationMembersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listorganizationmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersRequest | OpenRouter Python SDK -'og:description': >- - ListOrganizationMembersRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersRequest%20-%20Python%20SDK&description=ListOrganizationMembersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listorganizationmembersresponse.mdx b/client-sdks/python/api-reference/operations/listorganizationmembersresponse.mdx deleted file mode 100644 index eb3819e9..00000000 --- a/client-sdks/python/api-reference/operations/listorganizationmembersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListOrganizationMembersResponse - Python SDK -sidebarTitle: ListOrganizationMembersResponse -description: ListOrganizationMembersResponse method reference -seoTitle: ListOrganizationMembersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listorganizationmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponse | OpenRouter Python SDK -'og:description': >- - ListOrganizationMembersResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponse%20-%20Python%20SDK&description=ListOrganizationMembersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `result` | [operations.ListOrganizationMembersResponseBody](/client-sdks/python/api-reference/operations/listorganizationmembersresponsebody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listorganizationmembersresponsebody.mdx b/client-sdks/python/api-reference/operations/listorganizationmembersresponsebody.mdx deleted file mode 100644 index 2151343b..00000000 --- a/client-sdks/python/api-reference/operations/listorganizationmembersresponsebody.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListOrganizationMembersResponseBody - Python SDK -sidebarTitle: ListOrganizationMembersResponseBody -description: ListOrganizationMembersResponseBody method reference -seoTitle: ListOrganizationMembersResponseBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listorganizationmembersresponsebody -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponseBody | OpenRouter Python SDK -'og:description': >- - ListOrganizationMembersResponseBody method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponseBody%20-%20Python%20SDK&description=ListOrganizationMembersResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of organization members - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListOrganizationMembersData](/client-sdks/python/api-reference/operations/listorganizationmembersdata)] | :heavy_check_mark: | List of organization members | | -| `total_count` | *int* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listprovidersdata.mdx b/client-sdks/python/api-reference/operations/listprovidersdata.mdx deleted file mode 100644 index a1e22609..00000000 --- a/client-sdks/python/api-reference/operations/listprovidersdata.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ListProvidersData - Python SDK -sidebarTitle: ListProvidersData -description: ListProvidersData method reference -seoTitle: ListProvidersData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listprovidersdata -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersData | OpenRouter Python SDK -'og:description': >- - ListProvidersData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersData%20-%20Python%20SDK&description=ListProvidersData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `datacenters` | List[[operations.Datacenter](/client-sdks/python/api-reference/operations/datacenter)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [OptionalNullable[operations.Headquarters]](../operations/headquarters.md) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `name` | *str* | :heavy_check_mark: | Display name of the provider | OpenAI | -| `privacy_policy_url` | *Nullable[str]* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `status_page_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `terms_of_service_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listprovidersglobals.mdx b/client-sdks/python/api-reference/operations/listprovidersglobals.mdx deleted file mode 100644 index 40662617..00000000 --- a/client-sdks/python/api-reference/operations/listprovidersglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListProvidersGlobals - Python SDK -sidebarTitle: ListProvidersGlobals -description: ListProvidersGlobals method reference -seoTitle: ListProvidersGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listprovidersglobals -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersGlobals | OpenRouter Python SDK -'og:description': >- - ListProvidersGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersGlobals%20-%20Python%20SDK&description=ListProvidersGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listprovidersrequest.mdx b/client-sdks/python/api-reference/operations/listprovidersrequest.mdx deleted file mode 100644 index 0ad64b83..00000000 --- a/client-sdks/python/api-reference/operations/listprovidersrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListProvidersRequest - Python SDK -sidebarTitle: ListProvidersRequest -description: ListProvidersRequest method reference -seoTitle: ListProvidersRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listprovidersrequest -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersRequest | OpenRouter Python SDK -'og:description': >- - ListProvidersRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersRequest%20-%20Python%20SDK&description=ListProvidersRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listprovidersresponse.mdx b/client-sdks/python/api-reference/operations/listprovidersresponse.mdx deleted file mode 100644 index bff31791..00000000 --- a/client-sdks/python/api-reference/operations/listprovidersresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListProvidersResponse - Python SDK -sidebarTitle: ListProvidersResponse -description: ListProvidersResponse method reference -seoTitle: ListProvidersResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listprovidersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersResponse | OpenRouter Python SDK -'og:description': >- - ListProvidersResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersResponse%20-%20Python%20SDK&description=ListProvidersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of providers - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | List[[operations.ListProvidersData](/client-sdks/python/api-reference/operations/listprovidersdata)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listrequest.mdx b/client-sdks/python/api-reference/operations/listrequest.mdx deleted file mode 100644 index e3f38b95..00000000 --- a/client-sdks/python/api-reference/operations/listrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListRequest - Python SDK -sidebarTitle: ListRequest -description: ListRequest method reference -seoTitle: ListRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/listrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListRequest | OpenRouter Python SDK -'og:description': >- - ListRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListRequest%20-%20Python%20SDK&description=ListRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `include_disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspace_id` | *Optional[str]* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listresponse.mdx b/client-sdks/python/api-reference/operations/listresponse.mdx deleted file mode 100644 index 58522c77..00000000 --- a/client-sdks/python/api-reference/operations/listresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListResponse - Python SDK -sidebarTitle: ListResponse -description: ListResponse method reference -seoTitle: ListResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/listresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListResponse | OpenRouter Python SDK -'og:description': >- - ListResponse method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListResponse%20-%20Python%20SDK&description=ListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of API keys - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[operations.ListData](/client-sdks/python/api-reference/operations/listdata)] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listvideoscontentglobals.mdx b/client-sdks/python/api-reference/operations/listvideoscontentglobals.mdx deleted file mode 100644 index 434b8787..00000000 --- a/client-sdks/python/api-reference/operations/listvideoscontentglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListVideosContentGlobals - Python SDK -sidebarTitle: ListVideosContentGlobals -description: ListVideosContentGlobals method reference -seoTitle: ListVideosContentGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listvideoscontentglobals -'og:site_name': OpenRouter Documentation -'og:title': ListVideosContentGlobals | OpenRouter Python SDK -'og:description': >- - ListVideosContentGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosContentGlobals%20-%20Python%20SDK&description=ListVideosContentGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listvideoscontentrequest.mdx b/client-sdks/python/api-reference/operations/listvideoscontentrequest.mdx deleted file mode 100644 index 62af53b3..00000000 --- a/client-sdks/python/api-reference/operations/listvideoscontentrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListVideosContentRequest - Python SDK -sidebarTitle: ListVideosContentRequest -description: ListVideosContentRequest method reference -seoTitle: ListVideosContentRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listvideoscontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListVideosContentRequest | OpenRouter Python SDK -'og:description': >- - ListVideosContentRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosContentRequest%20-%20Python%20SDK&description=ListVideosContentRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listvideosmodelsglobals.mdx b/client-sdks/python/api-reference/operations/listvideosmodelsglobals.mdx deleted file mode 100644 index 5e3cb7d7..00000000 --- a/client-sdks/python/api-reference/operations/listvideosmodelsglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListVideosModelsGlobals - Python SDK -sidebarTitle: ListVideosModelsGlobals -description: ListVideosModelsGlobals method reference -seoTitle: ListVideosModelsGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listvideosmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListVideosModelsGlobals | OpenRouter Python SDK -'og:description': >- - ListVideosModelsGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosModelsGlobals%20-%20Python%20SDK&description=ListVideosModelsGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listvideosmodelsrequest.mdx b/client-sdks/python/api-reference/operations/listvideosmodelsrequest.mdx deleted file mode 100644 index d4ab7ddf..00000000 --- a/client-sdks/python/api-reference/operations/listvideosmodelsrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListVideosModelsRequest - Python SDK -sidebarTitle: ListVideosModelsRequest -description: ListVideosModelsRequest method reference -seoTitle: ListVideosModelsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listvideosmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListVideosModelsRequest | OpenRouter Python SDK -'og:description': >- - ListVideosModelsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosModelsRequest%20-%20Python%20SDK&description=ListVideosModelsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listworkspacesglobals.mdx b/client-sdks/python/api-reference/operations/listworkspacesglobals.mdx deleted file mode 100644 index aa2d7337..00000000 --- a/client-sdks/python/api-reference/operations/listworkspacesglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListWorkspacesGlobals - Python SDK -sidebarTitle: ListWorkspacesGlobals -description: ListWorkspacesGlobals method reference -seoTitle: ListWorkspacesGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listworkspacesglobals -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesGlobals | OpenRouter Python SDK -'og:description': >- - ListWorkspacesGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesGlobals%20-%20Python%20SDK&description=ListWorkspacesGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listworkspacesrequest.mdx b/client-sdks/python/api-reference/operations/listworkspacesrequest.mdx deleted file mode 100644 index 158a1dde..00000000 --- a/client-sdks/python/api-reference/operations/listworkspacesrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListWorkspacesRequest - Python SDK -sidebarTitle: ListWorkspacesRequest -description: ListWorkspacesRequest method reference -seoTitle: ListWorkspacesRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listworkspacesrequest -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesRequest | OpenRouter Python SDK -'og:description': >- - ListWorkspacesRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesRequest%20-%20Python%20SDK&description=ListWorkspacesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/listworkspacesresponse.mdx b/client-sdks/python/api-reference/operations/listworkspacesresponse.mdx deleted file mode 100644 index 951142ac..00000000 --- a/client-sdks/python/api-reference/operations/listworkspacesresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListWorkspacesResponse - Python SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse method reference -seoTitle: ListWorkspacesResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/listworkspacesresponse -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse | OpenRouter Python SDK -'og:description': >- - ListWorkspacesResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20Python%20SDK&description=ListWorkspacesResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [components.ListWorkspacesResponse](/client-sdks/python/api-reference/components/listworkspacesresponse) | :heavy_check_mark: | N/A | `{"data": [{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/python/api-reference/operations/object.mdx b/client-sdks/python/api-reference/operations/object.mdx deleted file mode 100644 index 05735293..00000000 --- a/client-sdks/python/api-reference/operations/object.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Object - Python SDK -sidebarTitle: Object -description: Object method reference -seoTitle: Object | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/object' -'og:site_name': OpenRouter Documentation -'og:title': Object | OpenRouter Python SDK -'og:description': >- - Object method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Object%20-%20Python%20SDK&description=Object%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `LIST` | list | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/objectembedding.mdx b/client-sdks/python/api-reference/operations/objectembedding.mdx deleted file mode 100644 index 23a1435a..00000000 --- a/client-sdks/python/api-reference/operations/objectembedding.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ObjectEmbedding - Python SDK -sidebarTitle: ObjectEmbedding -description: ObjectEmbedding method reference -seoTitle: ObjectEmbedding | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/objectembedding -'og:site_name': OpenRouter Documentation -'og:title': ObjectEmbedding | OpenRouter Python SDK -'og:description': >- - ObjectEmbedding method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectEmbedding%20-%20Python%20SDK&description=ObjectEmbedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `EMBEDDING` | embedding | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/prompttokensdetails.mdx b/client-sdks/python/api-reference/operations/prompttokensdetails.mdx deleted file mode 100644 index 35218f3a..00000000 --- a/client-sdks/python/api-reference/operations/prompttokensdetails.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: PromptTokensDetails - Python SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails method reference -seoTitle: PromptTokensDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/prompttokensdetails -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails | OpenRouter Python SDK -'og:description': >- - PromptTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20Python%20SDK&description=PromptTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audio_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `file_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `image_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `text_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `video_tokens` | *Optional[int]* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/provider.mdx b/client-sdks/python/api-reference/operations/provider.mdx deleted file mode 100644 index d6b372f7..00000000 --- a/client-sdks/python/api-reference/operations/provider.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Provider - Python SDK -sidebarTitle: Provider -description: Provider method reference -seoTitle: Provider | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/provider' -'og:site_name': OpenRouter Documentation -'og:title': Provider | OpenRouter Python SDK -'og:description': >- - Provider method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Provider%20-%20Python%20SDK&description=Provider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `AI21` | ai21 | -| `AION_LABS` | aion-labs | -| `AKASHML` | akashml | -| `ALIBABA` | alibaba | -| `AMAZON_BEDROCK` | amazon-bedrock | -| `AMAZON_NOVA` | amazon-nova | -| `AMBIENT` | ambient | -| `ANTHROPIC` | anthropic | -| `ARCEE_AI` | arcee-ai | -| `ATLAS_CLOUD` | atlas-cloud | -| `AVIAN` | avian | -| `AZURE` | azure | -| `BAIDU` | baidu | -| `BASETEN` | baseten | -| `BLACK_FOREST_LABS` | black-forest-labs | -| `BYTEPLUS` | byteplus | -| `CEREBRAS` | cerebras | -| `CHUTES` | chutes | -| `CIRRASCALE` | cirrascale | -| `CLARIFAI` | clarifai | -| `CLOUDFLARE` | cloudflare | -| `COHERE` | cohere | -| `CRUSOE` | crusoe | -| `DARKBLOOM` | darkbloom | -| `DEEPINFRA` | deepinfra | -| `DEEPSEEK` | deepseek | -| `DEKALLM` | dekallm | -| `DIGITALOCEAN` | digitalocean | -| `FEATHERLESS` | featherless | -| `FIREWORKS` | fireworks | -| `FRIENDLI` | friendli | -| `GMICLOUD` | gmicloud | -| `GOOGLE_AI_STUDIO` | google-ai-studio | -| `GOOGLE_VERTEX` | google-vertex | -| `GROQ` | groq | -| `HYPERBOLIC` | hyperbolic | -| `INCEPTION` | inception | -| `INCEPTRON` | inceptron | -| `INFERENCE_NET` | inference-net | -| `INFERMATIC` | infermatic | -| `INFLECTION` | inflection | -| `IO_NET` | io-net | -| `IONSTREAM` | ionstream | -| `LIQUID` | liquid | -| `MANCER` | mancer | -| `MARA` | mara | -| `MINIMAX` | minimax | -| `MISTRAL` | mistral | -| `MODELRUN` | modelrun | -| `MODULAR` | modular | -| `MOONSHOTAI` | moonshotai | -| `MORPH` | morph | -| `NCOMPASS` | ncompass | -| `NEBIUS` | nebius | -| `NEX_AGI` | nex-agi | -| `NEXTBIT` | nextbit | -| `NOVITA` | novita | -| `NVIDIA` | nvidia | -| `OPEN_INFERENCE` | open-inference | -| `OPENAI` | openai | -| `PARASAIL` | parasail | -| `PERCEPTRON` | perceptron | -| `PERPLEXITY` | perplexity | -| `PHALA` | phala | -| `POOLSIDE` | poolside | -| `RECRAFT` | recraft | -| `REKA` | reka | -| `RELACE` | relace | -| `SAMBANOVA` | sambanova | -| `SEED` | seed | -| `SILICONFLOW` | siliconflow | -| `SOURCEFUL` | sourceful | -| `STEPFUN` | stepfun | -| `STREAMLAKE` | streamlake | -| `SWITCHPOINT` | switchpoint | -| `TOGETHER` | together | -| `UPSTAGE` | upstage | -| `VENICE` | venice | -| `WANDB` | wandb | -| `XAI` | xai | -| `XIAOMI` | xiaomi | -| `Z_AI` | z-ai | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/ratelimit.mdx b/client-sdks/python/api-reference/operations/ratelimit.mdx deleted file mode 100644 index 5109a6fe..00000000 --- a/client-sdks/python/api-reference/operations/ratelimit.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ~~RateLimit~~ - Python SDK -sidebarTitle: ~~RateLimit~~ -description: ~~RateLimit~~ method reference -seoTitle: ~~RateLimit~~ | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/ratelimit' -'og:site_name': OpenRouter Documentation -'og:title': ~~RateLimit~~ | OpenRouter Python SDK -'og:description': >- - ~~RateLimit~~ method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~RateLimit~~%20-%20Python%20SDK&description=~~RateLimit~~%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Legacy rate limit information about a key. Will always return -1. - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `interval` | *str* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *str* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `requests` | *int* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/result.mdx b/client-sdks/python/api-reference/operations/result.mdx deleted file mode 100644 index b41a0cbb..00000000 --- a/client-sdks/python/api-reference/operations/result.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Result - Python SDK -sidebarTitle: Result -description: Result method reference -seoTitle: Result | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/result' -'og:site_name': OpenRouter Documentation -'og:title': Result | OpenRouter Python SDK -'og:description': >- - Result method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Result%20-%20Python%20SDK&description=Result%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A single rerank result - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `document` | [operations.Document](/client-sdks/python/api-reference/operations/document) | :heavy_check_mark: | The document object containing the original text | | -| `index` | *int* | :heavy_check_mark: | Index of the document in the original input list | 0 | -| `relevance_score` | *float* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/role.mdx b/client-sdks/python/api-reference/operations/role.mdx deleted file mode 100644 index bc0249c7..00000000 --- a/client-sdks/python/api-reference/operations/role.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Role - Python SDK -sidebarTitle: Role -description: Role method reference -seoTitle: Role | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/role' -'og:site_name': OpenRouter Documentation -'og:title': Role | OpenRouter Python SDK -'og:description': >- - Role method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Role%20-%20Python%20SDK&description=Role%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Role of the member in the organization - -## Values - -| Name | Value | -| ------------ | ------------ | -| `ORG_ADMIN` | org:admin | -| `ORG_MEMBER` | org:member | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/sendchatcompletionrequestglobals.mdx b/client-sdks/python/api-reference/operations/sendchatcompletionrequestglobals.mdx deleted file mode 100644 index ef7b1bb0..00000000 --- a/client-sdks/python/api-reference/operations/sendchatcompletionrequestglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: SendChatCompletionRequestGlobals - Python SDK -sidebarTitle: SendChatCompletionRequestGlobals -description: SendChatCompletionRequestGlobals method reference -seoTitle: SendChatCompletionRequestGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/sendchatcompletionrequestglobals -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestGlobals | OpenRouter Python SDK -'og:description': >- - SendChatCompletionRequestGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestGlobals%20-%20Python%20SDK&description=SendChatCompletionRequestGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/sendchatcompletionrequestrequest.mdx b/client-sdks/python/api-reference/operations/sendchatcompletionrequestrequest.mdx deleted file mode 100644 index 576b3f9a..00000000 --- a/client-sdks/python/api-reference/operations/sendchatcompletionrequestrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: SendChatCompletionRequestRequest - Python SDK -sidebarTitle: SendChatCompletionRequestRequest -description: SendChatCompletionRequestRequest method reference -seoTitle: SendChatCompletionRequestRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/sendchatcompletionrequestrequest -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestRequest | OpenRouter Python SDK -'og:description': >- - SendChatCompletionRequestRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestRequest%20-%20Python%20SDK&description=SendChatCompletionRequestRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_experimental_metadata` | [Optional[components.MetadataLevel]](../components/metadatalevel.md) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `chat_request` | [components.ChatRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/sendchatcompletionrequestresponse.mdx b/client-sdks/python/api-reference/operations/sendchatcompletionrequestresponse.mdx deleted file mode 100644 index d71e13c7..00000000 --- a/client-sdks/python/api-reference/operations/sendchatcompletionrequestresponse.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: SendChatCompletionRequestResponse - Python SDK -sidebarTitle: SendChatCompletionRequestResponse -description: SendChatCompletionRequestResponse method reference -seoTitle: SendChatCompletionRequestResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/sendchatcompletionrequestresponse -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestResponse | OpenRouter Python SDK -'og:description': >- - SendChatCompletionRequestResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestResponse%20-%20Python%20SDK&description=SendChatCompletionRequestResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatResult` - -```python lines -value: components.ChatResult = /* values here */ -``` - -### `Union[eventstreaming.EventStream[components.ChatStreamChunk], eventstreaming.EventStreamAsync[components.ChatStreamChunk]]` - -```python lines -value: Union[eventstreaming.EventStream[components.ChatStreamChunk], eventstreaming.EventStreamAsync[components.ChatStreamChunk]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/typeimageurl.mdx b/client-sdks/python/api-reference/operations/typeimageurl.mdx deleted file mode 100644 index 679c205e..00000000 --- a/client-sdks/python/api-reference/operations/typeimageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeImageURL - Python SDK -sidebarTitle: TypeImageURL -description: TypeImageURL method reference -seoTitle: TypeImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/typeimageurl' -'og:site_name': OpenRouter Documentation -'og:title': TypeImageURL | OpenRouter Python SDK -'og:description': >- - TypeImageURL method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeImageURL%20-%20Python%20SDK&description=TypeImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `IMAGE_URL` | image_url | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/typetext.mdx b/client-sdks/python/api-reference/operations/typetext.mdx deleted file mode 100644 index 1a7b5c0f..00000000 --- a/client-sdks/python/api-reference/operations/typetext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeText - Python SDK -sidebarTitle: TypeText -description: TypeText method reference -seoTitle: TypeText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/typetext' -'og:site_name': OpenRouter Documentation -'og:title': TypeText | OpenRouter Python SDK -'og:description': >- - TypeText method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeText%20-%20Python%20SDK&description=TypeText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatebyokkeyglobals.mdx b/client-sdks/python/api-reference/operations/updatebyokkeyglobals.mdx deleted file mode 100644 index a55903a8..00000000 --- a/client-sdks/python/api-reference/operations/updatebyokkeyglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateBYOKKeyGlobals - Python SDK -sidebarTitle: UpdateBYOKKeyGlobals -description: UpdateBYOKKeyGlobals method reference -seoTitle: UpdateBYOKKeyGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatebyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyGlobals | OpenRouter Python SDK -'og:description': >- - UpdateBYOKKeyGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyGlobals%20-%20Python%20SDK&description=UpdateBYOKKeyGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatebyokkeyrequest.mdx b/client-sdks/python/api-reference/operations/updatebyokkeyrequest.mdx deleted file mode 100644 index 926e0543..00000000 --- a/client-sdks/python/api-reference/operations/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - Python SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest method reference -seoTitle: UpdateBYOKKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest | OpenRouter Python SDK -'og:description': >- - UpdateBYOKKeyRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20Python%20SDK&description=UpdateBYOKKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `update_byok_key_request` | [components.UpdateBYOKKeyRequest](/client-sdks/python/api-reference/components/updatebyokkeyrequest) | :heavy_check_mark: | N/A | `{"disabled": false,"name": "Updated OpenAI Key"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updateguardrailglobals.mdx b/client-sdks/python/api-reference/operations/updateguardrailglobals.mdx deleted file mode 100644 index ee8d1857..00000000 --- a/client-sdks/python/api-reference/operations/updateguardrailglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateGuardrailGlobals - Python SDK -sidebarTitle: UpdateGuardrailGlobals -description: UpdateGuardrailGlobals method reference -seoTitle: UpdateGuardrailGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailGlobals | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailGlobals%20-%20Python%20SDK&description=UpdateGuardrailGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updateguardrailrequest.mdx b/client-sdks/python/api-reference/operations/updateguardrailrequest.mdx deleted file mode 100644 index d85f93b0..00000000 --- a/client-sdks/python/api-reference/operations/updateguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateGuardrailRequest - Python SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest method reference -seoTitle: UpdateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20Python%20SDK&description=UpdateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `update_guardrail_request` | [components.UpdateGuardrailRequest](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/updatekeysdata.mdx b/client-sdks/python/api-reference/operations/updatekeysdata.mdx deleted file mode 100644 index 13328b8a..00000000 --- a/client-sdks/python/api-reference/operations/updatekeysdata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: UpdateKeysData - Python SDK -sidebarTitle: UpdateKeysData -description: UpdateKeysData method reference -seoTitle: UpdateKeysData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/updatekeysdata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysData | OpenRouter Python SDK -'og:description': >- - UpdateKeysData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysData%20-%20Python%20SDK&description=UpdateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The updated API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creator_user_id` | *Nullable[str]* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatekeysglobals.mdx b/client-sdks/python/api-reference/operations/updatekeysglobals.mdx deleted file mode 100644 index 23158fd3..00000000 --- a/client-sdks/python/api-reference/operations/updatekeysglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateKeysGlobals - Python SDK -sidebarTitle: UpdateKeysGlobals -description: UpdateKeysGlobals method reference -seoTitle: UpdateKeysGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatekeysglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysGlobals | OpenRouter Python SDK -'og:description': >- - UpdateKeysGlobals method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysGlobals%20-%20Python%20SDK&description=UpdateKeysGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatekeyslimitreset.mdx b/client-sdks/python/api-reference/operations/updatekeyslimitreset.mdx deleted file mode 100644 index 182ef99d..00000000 --- a/client-sdks/python/api-reference/operations/updatekeyslimitreset.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateKeysLimitReset - Python SDK -sidebarTitle: UpdateKeysLimitReset -description: UpdateKeysLimitReset method reference -seoTitle: UpdateKeysLimitReset | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatekeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysLimitReset | OpenRouter Python SDK -'og:description': >- - UpdateKeysLimitReset method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysLimitReset%20-%20Python%20SDK&description=UpdateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatekeysrequest.mdx b/client-sdks/python/api-reference/operations/updatekeysrequest.mdx deleted file mode 100644 index 9f3d6714..00000000 --- a/client-sdks/python/api-reference/operations/updatekeysrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateKeysRequest - Python SDK -sidebarTitle: UpdateKeysRequest -description: UpdateKeysRequest method reference -seoTitle: UpdateKeysRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatekeysrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequest | OpenRouter Python SDK -'og:description': >- - UpdateKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequest%20-%20Python%20SDK&description=UpdateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `request_body` | [operations.UpdateKeysRequestBody](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/updatekeysrequestbody.mdx b/client-sdks/python/api-reference/operations/updatekeysrequestbody.mdx deleted file mode 100644 index d3c1e1df..00000000 --- a/client-sdks/python/api-reference/operations/updatekeysrequestbody.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateKeysRequestBody - Python SDK -sidebarTitle: UpdateKeysRequestBody -description: UpdateKeysRequestBody method reference -seoTitle: UpdateKeysRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatekeysrequestbody -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequestBody | OpenRouter Python SDK -'og:description': >- - UpdateKeysRequestBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequestBody%20-%20Python%20SDK&description=UpdateKeysRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../operations/updatekeyslimitreset.md) | :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` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updatekeysresponse.mdx b/client-sdks/python/api-reference/operations/updatekeysresponse.mdx deleted file mode 100644 index 33c54e22..00000000 --- a/client-sdks/python/api-reference/operations/updatekeysresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateKeysResponse - Python SDK -sidebarTitle: UpdateKeysResponse -description: UpdateKeysResponse method reference -seoTitle: UpdateKeysResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updatekeysresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysResponse | OpenRouter Python SDK -'og:description': >- - UpdateKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysResponse%20-%20Python%20SDK&description=UpdateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key updated successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.UpdateKeysData](/client-sdks/python/api-reference/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/client-sdks/python/api-reference/operations/updateobservabilitydestinationglobals.mdx b/client-sdks/python/api-reference/operations/updateobservabilitydestinationglobals.mdx deleted file mode 100644 index 992c5e60..00000000 --- a/client-sdks/python/api-reference/operations/updateobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateObservabilityDestinationGlobals - Python SDK -sidebarTitle: UpdateObservabilityDestinationGlobals -description: UpdateObservabilityDestinationGlobals method reference -seoTitle: UpdateObservabilityDestinationGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationGlobals | OpenRouter Python SDK -'og:description': >- - UpdateObservabilityDestinationGlobals method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationGlobals%20-%20Python%20SDK&description=UpdateObservabilityDestinationGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updateobservabilitydestinationrequest.mdx b/client-sdks/python/api-reference/operations/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index 6d8ef465..00000000 --- a/client-sdks/python/api-reference/operations/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - Python SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest method reference -seoTitle: UpdateObservabilityDestinationRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest | OpenRouter Python SDK -'og:description': >- - UpdateObservabilityDestinationRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20Python%20SDK&description=UpdateObservabilityDestinationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `update_observability_destination_request` | [components.UpdateObservabilityDestinationRequest](/client-sdks/python/api-reference/components/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"enabled": false,"name": "Updated Langfuse"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updateworkspaceglobals.mdx b/client-sdks/python/api-reference/operations/updateworkspaceglobals.mdx deleted file mode 100644 index fcfca423..00000000 --- a/client-sdks/python/api-reference/operations/updateworkspaceglobals.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateWorkspaceGlobals - Python SDK -sidebarTitle: UpdateWorkspaceGlobals -description: UpdateWorkspaceGlobals method reference -seoTitle: UpdateWorkspaceGlobals | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceGlobals | OpenRouter Python SDK -'og:description': >- - UpdateWorkspaceGlobals method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceGlobals%20-%20Python%20SDK&description=UpdateWorkspaceGlobals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/updateworkspacerequest.mdx b/client-sdks/python/api-reference/operations/updateworkspacerequest.mdx deleted file mode 100644 index 35368f7a..00000000 --- a/client-sdks/python/api-reference/operations/updateworkspacerequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateWorkspaceRequest - Python SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest method reference -seoTitle: UpdateWorkspaceRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/api-reference/operations/updateworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest | OpenRouter Python SDK -'og:description': >- - UpdateWorkspaceRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20Python%20SDK&description=UpdateWorkspaceRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `update_workspace_request` | [components.UpdateWorkspaceRequest](/client-sdks/python/api-reference/components/updateworkspacerequest) | :heavy_check_mark: | N/A | `{"name": "Updated Workspace","slug": "updated-workspace"}` | \ No newline at end of file diff --git a/client-sdks/python/api-reference/operations/usagelimittype.mdx b/client-sdks/python/api-reference/operations/usagelimittype.mdx deleted file mode 100644 index e227a260..00000000 --- a/client-sdks/python/api-reference/operations/usagelimittype.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: UsageLimitType - Python SDK -sidebarTitle: UsageLimitType -description: UsageLimitType method reference -seoTitle: UsageLimitType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/operations/usagelimittype' -'og:site_name': OpenRouter Documentation -'og:title': UsageLimitType | OpenRouter Python SDK -'og:description': >- - UsageLimitType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageLimitType%20-%20Python%20SDK&description=UsageLimitType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Optional credit limit reset interval. When set, the credit limit resets on this interval. - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/api-reference/organization.mdx b/client-sdks/python/api-reference/organization.mdx deleted file mode 100644 index 0a4e246e..00000000 --- a/client-sdks/python/api-reference/organization.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Organization - Python SDK -sidebarTitle: Organization -description: Organization method reference -seoTitle: Organization | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/organization' -'og:site_name': OpenRouter Documentation -'og:title': Organization | OpenRouter Python SDK -'og:description': >- - Organization method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Organization%20-%20Python%20SDK&description=Organization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Organization endpoints - -### Available Operations - -* [list_members](#list_members) - List organization members - -## list_members - -List all members of the organization associated with the authenticated management key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listOrganizationMembers" method="get" path="/organization/members" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.organization.list_members() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListOrganizationMembersResponse](/client-sdks/python/api-reference/operations/listorganizationmembersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/presets.mdx b/client-sdks/python/api-reference/presets.mdx deleted file mode 100644 index cca4e27c..00000000 --- a/client-sdks/python/api-reference/presets.mdx +++ /dev/null @@ -1,299 +0,0 @@ ---- -title: Presets - Python SDK -sidebarTitle: Presets -description: Presets method reference -seoTitle: Presets | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/presets' -'og:site_name': OpenRouter Documentation -'og:title': Presets | OpenRouter Python SDK -'og:description': >- - Presets method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Presets%20-%20Python%20SDK&description=Presets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Presets endpoints - -### Available Operations - -* [create_presets_chat_completions](#create_presets_chat_completions) - Create a preset from a chat-completions request body -* [create_presets_messages](#create_presets_messages) - Create a preset from a messages request body -* [create_presets_responses](#create_presets_responses) - Create a preset from a responses request body - -## create_presets_chat_completions - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createPresetsChatCompletions" method="post" path="/presets/{slug}/chat/completions" */} -```python expandable lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.presets.create_presets_chat_completions(slug="my-preset", messages=[ - { - "content": "You are a helpful assistant.", - "role": "system", - }, - { - "content": "Hello!", - "role": "user", - }, - ], model="openai/gpt-5.4", stream=False, temperature=0.7) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.ChatMessages](/client-sdks/python/api-reference/components/chatmessages)] | :heavy_check_mark: | List of messages for the conversation | [
`{"content": "Hello!","role": "user"}`
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](/client-sdks/python/api-reference/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `debug` | [Optional[components.ChatDebugOptions]](/client-sdks/python/api-reference/components/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | `{"echo_upstream_body": true}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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"}` | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | Token logit bias adjustments | `{"50256": -100}` | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | Return log probabilities | false | -| `max_completion_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `metadata` | Dict[str, *str*] | :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"}` | -| `modalities` | List[[components.Modality](/client-sdks/python/api-reference/components/modality)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | List[*str*] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallel_tool_calls` | *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` | List[[components.ChatRequestPlugin](/client-sdks/python/api-reference/components/chatrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [Optional[components.ChatRequestReasoning]](/client-sdks/python/api-reference/components/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | `{"effort": "medium","summary": "concise"}` | -| `response_format` | [Optional[components.ResponseFormat]](/client-sdks/python/api-reference/components/responseformat) | :heavy_minus_sign: | Response format configuration | `{"type": "json_object"}` | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `service_tier` | [OptionalNullable[components.ChatRequestServiceTier]](/client-sdks/python/api-reference/components/chatrequestservicetier) | :heavy_minus_sign: | The service tier to use for processing this request. | auto | -| `session_id` | *Optional[str]* | :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[components.Stop]](/client-sdks/python/api-reference/components/stop) | :heavy_minus_sign: | Stop sequences (up to 4) | [
""
] | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | Enable streaming response | false | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](/client-sdks/python/api-reference/components/chatstreamoptions) | :heavy_minus_sign: | Streaming configuration options | `{"include_usage": true}` | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `tool_choice` | [Optional[components.ChatToolChoice]](/client-sdks/python/api-reference/components/chattoolchoice) | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | List[[components.ChatFunctionTool](/client-sdks/python/api-reference/components/chatfunctiontool)] | :heavy_minus_sign: | Available tools for function calling | [
`{"function": {"description": "Get weather","name": "get_weather"}`,
"type": "function"
\}
] | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [Optional[components.TraceConfig]](/client-sdks/python/api-reference/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` | *Optional[str]* | :heavy_minus_sign: | Unique user identifier | user-123 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreatePresetFromInferenceResponse](/client-sdks/python/api-reference/components/createpresetfrominferenceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create_presets_messages - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createPresetsMessages" method="post" path="/presets/{slug}/messages" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.presets.create_presets_messages(slug="my-preset", messages=[ - { - "content": "Hello!", - "role": "user", - }, - ], model="anthropic/claude-4.6-sonnet", max_tokens=1024, system="You are a helpful assistant.") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messages` | List[[components.MessagesMessageParam](/client-sdks/python/api-reference/components/messagesmessageparam)] | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](/client-sdks/python/api-reference/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `context_management` | [OptionalNullable[components.ContextManagement]](/client-sdks/python/api-reference/components/contextmanagement) | :heavy_minus_sign: | N/A | | -| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | [Optional[components.Metadata]](/client-sdks/python/api-reference/components/metadata) | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `output_config` | [Optional[components.MessagesOutputConfig]](/client-sdks/python/api-reference/components/messagesoutputconfig) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | `{"effort": "medium"}` | -| `plugins` | List[[components.MessagesRequestPlugin](/client-sdks/python/api-reference/components/messagesrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `service_tier` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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[components.Speed]](/client-sdks/python/api-reference/components/speed) | :heavy_minus_sign: | N/A | standard | -| `stop_sequences` | List[*str*] | :heavy_minus_sign: | N/A | | -| `stop_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `system` | [Optional[components.System]](/client-sdks/python/api-reference/components/system) | :heavy_minus_sign: | N/A | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `thinking` | [Optional[components.Thinking]](/client-sdks/python/api-reference/components/thinking) | :heavy_minus_sign: | N/A | | -| `tool_choice` | [Optional[components.ToolChoice]](/client-sdks/python/api-reference/components/toolchoice) | :heavy_minus_sign: | N/A | | -| `tools` | List[[components.MessagesRequestToolUnion](/client-sdks/python/api-reference/components/messagesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](/client-sdks/python/api-reference/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` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreatePresetFromInferenceResponse](/client-sdks/python/api-reference/components/createpresetfrominferenceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create_presets_responses - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createPresetsResponses" method="post" path="/presets/{slug}/responses" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.presets.create_presets_responses(slug="my-preset", input="Hello!", instructions="You are a helpful assistant.", model="openai/gpt-5.4", service_tier="auto", stream=False) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `slug` | *str* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](/client-sdks/python/api-reference/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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` | List[[components.ResponseIncludesEnum](/client-sdks/python/api-reference/components/responseincludesenum)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](/client-sdks/python/api-reference/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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](/client-sdks/python/api-reference/components/outputmodalityenum)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](/client-sdks/python/api-reference/components/responsesrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](/client-sdks/python/api-reference/components/storedprompttemplate) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](/client-sdks/python/api-reference/components/reasoningconfig) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"effort": "medium","summary": "auto"}` | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](/client-sdks/python/api-reference/components/responsesrequestservicetier) | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](/client-sdks/python/api-reference/components/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
\} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](/client-sdks/python/api-reference/components/responsesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](/client-sdks/python/api-reference/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[components.OpenAIResponsesTruncation]](/client-sdks/python/api-reference/components/openairesponsestruncation) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreatePresetFromInferenceResponse](/client-sdks/python/api-reference/components/createpresetfrominferenceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/providers.mdx b/client-sdks/python/api-reference/providers.mdx deleted file mode 100644 index c368ab93..00000000 --- a/client-sdks/python/api-reference/providers.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Providers - Python SDK -sidebarTitle: Providers -description: Providers method reference -seoTitle: Providers | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/providers' -'og:site_name': OpenRouter Documentation -'og:title': Providers | OpenRouter Python SDK -'og:description': >- - Providers method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Providers%20-%20Python%20SDK&description=Providers%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: cloud ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Provider information endpoints - -### Available Operations - -* [list](#list) - List all providers - -## list - -List all providers - -### Example Usage - -{/* UsageSnippet language="python" operationID="listProviders" method="get" path="/providers" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.providers.list() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[operations.ListProvidersResponse](/client-sdks/python/api-reference/operations/listprovidersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/rerank.mdx b/client-sdks/python/api-reference/rerank.mdx deleted file mode 100644 index 4ccc0cec..00000000 --- a/client-sdks/python/api-reference/rerank.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Rerank - Python SDK -sidebarTitle: Rerank -description: Rerank method reference -seoTitle: Rerank | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/rerank' -'og:site_name': OpenRouter Documentation -'og:title': Rerank | OpenRouter Python SDK -'og:description': >- - Rerank method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rerank%20-%20Python%20SDK&description=Rerank%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Rerank endpoints - -### Available Operations - -* [rerank](#rerank) - Submit a rerank request - -## rerank - -Submits a rerank request to the rerank router - -### Example Usage - -{/* UsageSnippet language="python" operationID="createRerank" method="post" path="/rerank" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.rerank.rerank(documents=[ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - ], model="cohere/rerank-v3.5", query="What is the capital of France?") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | List[*str*] | :heavy_check_mark: | The list of documents to rerank | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `model` | *str* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `query` | *str* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | N/A | `{"allow_fallbacks": true}` | -| `top_n` | *Optional[int]* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.CreateRerankResponse](/client-sdks/python/api-reference/operations/creatererankresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/responses.mdx b/client-sdks/python/api-reference/responses.mdx deleted file mode 100644 index 3d2669cb..00000000 --- a/client-sdks/python/api-reference/responses.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: Beta.Responses - Python SDK -sidebarTitle: Beta.Responses -description: Beta.Responses method reference -seoTitle: Beta.Responses | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/responses' -'og:site_name': OpenRouter Documentation -'og:title': Beta.Responses | OpenRouter Python SDK -'og:description': >- - Beta.Responses method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Beta.Responses%20-%20Python%20SDK&description=Beta.Responses%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: reply ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -beta.responses endpoints - -### Available Operations - -* [send](#send) - Create a response - -## send - -Creates a streaming or non-streaming response using OpenResponses API format - -### Example Usage - -{/* UsageSnippet language="python" operationID="createResponses" method="post" path="/responses" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.beta.responses.send(x_open_router_experimental_metadata="enabled", input="Tell me a joke", model="openai/gpt-4o", service_tier="auto", stream=False) - - with res as event_stream: - for event in event_stream: - # handle event - print(event, flush=True) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `x_open_router_experimental_metadata` | [Optional[components.MetadataLevel]](/client-sdks/python/api-reference/components/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `cache_control` | [Optional[components.AnthropicCacheControlDirective]](/client-sdks/python/api-reference/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.ImageConfig](/client-sdks/python/api-reference/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` | List[[components.ResponseIncludesEnum](/client-sdks/python/api-reference/components/responseincludesenum)] | :heavy_minus_sign: | N/A | | -| `input` | [Optional[components.InputsUnion]](/client-sdks/python/api-reference/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[str]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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` | List[[components.OutputModalityEnum](/client-sdks/python/api-reference/components/outputmodalityenum)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `plugins` | List[[components.ResponsesRequestPlugin](/client-sdks/python/api-reference/components/responsesrequestplugin)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.StoredPromptTemplate]](/client-sdks/python/api-reference/components/storedprompttemplate) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `provider` | [OptionalNullable[components.ProviderPreferences]](/client-sdks/python/api-reference/components/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [OptionalNullable[components.ReasoningConfig]](/client-sdks/python/api-reference/components/reasoningconfig) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"effort": "medium","summary": "auto"}` | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `service_tier` | [OptionalNullable[components.ResponsesRequestServiceTier]](/client-sdks/python/api-reference/components/responsesrequestservicetier) | :heavy_minus_sign: | N/A | | -| `session_id` | *Optional[str]* | :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_server_tools_when` | List[[components.StopServerToolsWhenCondition](/client-sdks/python/api-reference/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`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.TextExtendedConfig]](/client-sdks/python/api-reference/components/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
\} | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion) | :heavy_minus_sign: | N/A | auto | -| `tools` | List[[components.ResponsesRequestToolUnion](/client-sdks/python/api-reference/components/responsesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `trace` | [Optional[components.TraceConfig]](/client-sdks/python/api-reference/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[components.OpenAIResponsesTruncation]](/client-sdks/python/api-reference/components/openairesponsestruncation) | :heavy_minus_sign: | N/A | auto | -| `user` | *Optional[str]* | :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. | | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.CreateResponsesResponse](/client-sdks/python/api-reference/operations/createresponsesresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.RequestTimeoutResponseError | 408 | application/json | -| errors.PayloadTooLargeResponseError | 413 | application/json | -| errors.UnprocessableEntityResponseError | 422 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/stt.mdx b/client-sdks/python/api-reference/stt.mdx deleted file mode 100644 index 5be8c26a..00000000 --- a/client-sdks/python/api-reference/stt.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Transcriptions - Python SDK -sidebarTitle: Transcriptions -description: Transcriptions method reference -seoTitle: Transcriptions | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/stt' -'og:site_name': OpenRouter Documentation -'og:title': Transcriptions | OpenRouter Python SDK -'og:description': >- - Transcriptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Transcriptions%20-%20Python%20SDK&description=Transcriptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Speech-to-text endpoints - -### Available Operations - -* [create_transcription](#create_transcription) - Create transcription - -## create_transcription - -Transcribes audio into text. Accepts base64-encoded audio input and returns the transcribed text. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createAudioTranscriptions" method="post" path="/audio/transcriptions" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.stt.create_transcription(input_audio={ - "data": "UklGRiQA...", - "format_": "wav", - }, model="openai/whisper-large-v3", language="en") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input_audio` | [components.STTInputAudio](/client-sdks/python/api-reference/components/sttinputaudio) | :heavy_check_mark: | Base64-encoded audio to transcribe | `{"data": "UklGRiQA...","format": "wav"}` | -| `model` | *str* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `language` | *Optional[str]* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `provider` | [Optional[components.STTRequestProvider]](/client-sdks/python/api-reference/components/sttrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `temperature` | *Optional[float]* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.STTResponse](/client-sdks/python/api-reference/components/sttresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/tts.mdx b/client-sdks/python/api-reference/tts.mdx deleted file mode 100644 index cc779055..00000000 --- a/client-sdks/python/api-reference/tts.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Speech - Python SDK -sidebarTitle: Speech -description: Speech method reference -seoTitle: Speech | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/tts' -'og:site_name': OpenRouter Documentation -'og:title': Speech | OpenRouter Python SDK -'og:description': >- - Speech method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speech%20-%20Python%20SDK&description=Speech%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Text-to-speech endpoints - -### Available Operations - -* [create_speech](#create_speech) - Create speech - -## create_speech - -Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav). - -### Example Usage - -{/* UsageSnippet language="python" operationID="createAudioSpeech" method="post" path="/audio/speech" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.tts.create_speech(input="Hello world", model="elevenlabs/eleven-turbo-v2", voice="alloy", response_format="pcm", speed=1) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | *str* | :heavy_check_mark: | Text to synthesize | Hello world | -| `model` | *str* | :heavy_check_mark: | TTS model identifier | elevenlabs/eleven-turbo-v2 | -| `voice` | *str* | :heavy_check_mark: | Voice identifier (provider-specific). | alloy | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `provider` | [Optional[components.SpeechRequestProvider]](/client-sdks/python/api-reference/components/speechrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `response_format` | [Optional[components.ResponseFormatEnum]](/client-sdks/python/api-reference/components/responseformatenum) | :heavy_minus_sign: | Audio output format | pcm | -| `speed` | *Optional[float]* | :heavy_minus_sign: | Playback speed multiplier. Only used by models that support it (e.g. OpenAI TTS). Ignored by other providers. | 1 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[httpx.Response](/client-sdks/python/api-reference/models)** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/videogeneration.mdx b/client-sdks/python/api-reference/videogeneration.mdx deleted file mode 100644 index 40134556..00000000 --- a/client-sdks/python/api-reference/videogeneration.mdx +++ /dev/null @@ -1,246 +0,0 @@ ---- -title: VideoGeneration - Python SDK -sidebarTitle: VideoGeneration -description: VideoGeneration method reference -seoTitle: VideoGeneration | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/videogeneration' -'og:site_name': OpenRouter Documentation -'og:title': VideoGeneration | OpenRouter Python SDK -'og:description': >- - VideoGeneration method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGeneration%20-%20Python%20SDK&description=VideoGeneration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Video Generation endpoints - -### Available Operations - -* [generate](#generate) - Submit a video generation request -* [get_generation](#get_generation) - Poll video generation status -* [get_video_content](#get_video_content) - Download generated video content -* [list_videos_models](#list_videos_models) - List all video generation models - -## generate - -Submits a video generation request and returns a polling URL to check status - -### Example Usage - -{/* UsageSnippet language="python" operationID="createVideos" method="post" path="/videos" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.video_generation.generate(model="google/veo-3.1", prompt="A serene mountain landscape at sunset", aspect_ratio="16:9", duration=8, resolution="720p") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `prompt` | *str* | :heavy_check_mark: | N/A | | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `aspect_ratio` | [Optional[components.AspectRatio]](/client-sdks/python/api-reference/components/aspectratio) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `callback_url` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frame_images` | List[[components.FrameImage](/client-sdks/python/api-reference/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. | | -| `generate_audio` | *Optional[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 | -| `input_references` | List[[components.ContentPartImage](/client-sdks/python/api-reference/components/contentpartimage)] | :heavy_minus_sign: | Reference images to guide video generation | | -| `provider` | [Optional[components.VideoGenerationRequestProvider]](/client-sdks/python/api-reference/components/videogenerationrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [Optional[components.Resolution]](/client-sdks/python/api-reference/components/resolution) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *Optional[int]* | :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` | *Optional[str]* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.VideoGenerationResponse](/client-sdks/python/api-reference/components/videogenerationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get_generation - -Returns job status and content URLs when completed - -### Example Usage - -{/* UsageSnippet language="python" operationID="getVideos" method="get" path="/videos/{jobId}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.video_generation.get_generation(job_id="job-abc123") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.VideoGenerationResponse](/client-sdks/python/api-reference/components/videogenerationresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get_video_content - -Streams the generated video content from the upstream provider - -### Example Usage - -{/* UsageSnippet language="python" operationID="listVideosContent" method="get" path="/videos/{jobId}/content" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.video_generation.get_video_content(job_id="job-abc123", index=0) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `job_id` | *str* | :heavy_check_mark: | N/A | job-abc123 | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `index` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 0 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[httpx.Response](/client-sdks/python/api-reference/models)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list_videos_models - -Returns a list of all available video generation models and their properties - -### Example Usage - -{/* UsageSnippet language="python" operationID="listVideosModels" method="get" path="/videos/models" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.video_generation.list_videos_models() - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - -### Response - -**[components.VideoModelsListResponse](/client-sdks/python/api-reference/components/videomodelslistresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/api-reference/workspaces.mdx b/client-sdks/python/api-reference/workspaces.mdx deleted file mode 100644 index d9576ab7..00000000 --- a/client-sdks/python/api-reference/workspaces.mdx +++ /dev/null @@ -1,418 +0,0 @@ ---- -title: Workspaces - Python SDK -sidebarTitle: Workspaces -description: Workspaces method reference -seoTitle: Workspaces | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/api-reference/workspaces' -'og:site_name': OpenRouter Documentation -'og:title': Workspaces | OpenRouter Python SDK -'og:description': >- - Workspaces method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspaces%20-%20Python%20SDK&description=Workspaces%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Overview - -Workspaces endpoints - -### Available Operations - -* [list](#list) - List workspaces -* [create](#create) - Create a workspace -* [delete](#delete) - Delete a workspace -* [get](#get) - Get a workspace -* [update](#update) - Update a workspace -* [bulk_add_members](#bulk_add_members) - Bulk add members to a workspace -* [bulk_remove_members](#bulk_remove_members) - Bulk remove members from a workspace - -## list - -List all workspaces for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="listWorkspaces" method="get" path="/workspaces" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.list() - - while res is not None: - # Handle items - - res = res.next() - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *Optional[int]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[operations.ListWorkspacesResponse](/client-sdks/python/api-reference/operations/listworkspacesresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new workspace for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="createWorkspace" method="post" path="/workspaces" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.create(name="Production", slug="production", default_image_model="openai/dall-e-3", default_provider_sort="price", default_text_model="openai/gpt-4o", description="Production environment workspace") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *str* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.CreateWorkspaceResponse](/client-sdks/python/api-reference/components/createworkspaceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="deleteWorkspace" method="delete" path="/workspaces/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.delete(id="production") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.DeleteWorkspaceResponse](/client-sdks/python/api-reference/components/deleteworkspaceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="getWorkspace" method="get" path="/workspaces/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.get(id="production") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.GetWorkspaceResponse](/client-sdks/python/api-reference/components/getworkspaceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="updateWorkspace" method="patch" path="/workspaces/{id}" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.update(id="production", name="Updated Workspace", slug="updated-workspace") - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `default_image_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `default_provider_sort` | *OptionalNullable[str]* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `default_text_model` | *OptionalNullable[str]* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `io_logging_api_key_ids` | List[*int*] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `io_logging_sampling_rate` | *Optional[float]* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `is_data_discount_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `is_observability_broadcast_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `is_observability_io_logging_enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *Optional[str]* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.UpdateWorkspaceResponse](/client-sdks/python/api-reference/components/updateworkspaceresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_add_members - -Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkAddWorkspaceMembers" method="post" path="/workspaces/{id}/members/add" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.bulk_add_members(id="production", user_ids=[ - "user_abc123", - "user_def456", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkAddWorkspaceMembersResponse](/client-sdks/python/api-reference/components/bulkaddworkspacemembersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulk_remove_members - -Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="python" operationID="bulkRemoveWorkspaceMembers" method="post" path="/workspaces/{id}/members/remove" */} -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - http_referer="", - x_open_router_title="", - x_open_router_categories="", - api_key=os.getenv("OPENROUTER_API_KEY", ""), -) as open_router: - - res = open_router.workspaces.bulk_remove_members(id="production", user_ids=[ - "user_abc123", - "user_def456", - ]) - - # Handle response - print(res) - -``` - -### Parameters - -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `user_ids` | List[*str*] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `x_open_router_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `x_open_router_categories` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `retries` | [Optional[utils.RetryConfig]](/client-sdks/python/models/retryconfig) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | - -### Response - -**[components.BulkRemoveWorkspaceMembersResponse](/client-sdks/python/api-reference/components/bulkremoveworkspacemembersresponse)** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/python/assets/banner.png b/client-sdks/python/assets/banner.png deleted file mode 100644 index c970d60d..00000000 Binary files a/client-sdks/python/assets/banner.png and /dev/null differ diff --git a/client-sdks/python/assets/logo.svg b/client-sdks/python/assets/logo.svg deleted file mode 100644 index f4e6ea17..00000000 --- a/client-sdks/python/assets/logo.svg +++ /dev/null @@ -1,10 +0,0 @@ - - OpenRouter - - - - - - - - diff --git a/client-sdks/python/components/activityitem.mdx b/client-sdks/python/components/activityitem.mdx deleted file mode 100644 index 01d238f5..00000000 --- a/client-sdks/python/components/activityitem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ActivityItem - Python SDK -description: ActivityItem method reference -seoTitle: ActivityItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/activityitem' -'og:site_name': OpenRouter Documentation -'og:title': ActivityItem | OpenRouter Python SDK -'og:description': >- - ActivityItem method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityItem%20-%20Python%20SDK&description=ActivityItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `date_` | *str* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `model` | *str* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `model_permaslug` | *str* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `endpoint_id` | *str* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `provider_name` | *str* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `usage` | *float* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `byok_usage_inference` | *float* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `requests` | *float* | :heavy_check_mark: | Number of requests made | 5 | -| `prompt_tokens` | *float* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `completion_tokens` | *float* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `reasoning_tokens` | *float* | :heavy_check_mark: | Total reasoning tokens used | 25 | \ No newline at end of file diff --git a/client-sdks/python/components/architecture.mdx b/client-sdks/python/components/architecture.mdx deleted file mode 100644 index 3976f712..00000000 --- a/client-sdks/python/components/architecture.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Architecture - Python SDK -description: Architecture method reference -seoTitle: Architecture | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/architecture' -'og:site_name': OpenRouter Documentation -'og:title': Architecture | OpenRouter Python SDK -'og:description': >- - Architecture method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Architecture%20-%20Python%20SDK&description=Architecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `tokenizer` | [Nullable[components.Tokenizer]](../components/tokenizer.md) | :heavy_check_mark: | N/A | GPT | -| `instruct_type` | [Nullable[components.InstructType]](../components/instructtype.md) | :heavy_check_mark: | Instruction format type | | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text | -| `input_modalities` | List[[components.InputModality](/client-sdks/python/api-reference/components/inputmodality)] | :heavy_check_mark: | Supported input modalities | | -| `output_modalities` | List[[components.OutputModality](/client-sdks/python/api-reference/components/outputmodality)] | :heavy_check_mark: | Supported output modalities | | \ No newline at end of file diff --git a/client-sdks/python/components/assistantmessage.mdx b/client-sdks/python/components/assistantmessage.mdx deleted file mode 100644 index bd96ba83..00000000 --- a/client-sdks/python/components/assistantmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: AssistantMessage - Python SDK -description: AssistantMessage method reference -seoTitle: AssistantMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/assistantmessage' -'og:site_name': OpenRouter Documentation -'og:title': AssistantMessage | OpenRouter Python SDK -'og:description': >- - AssistantMessage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AssistantMessage%20-%20Python%20SDK&description=AssistantMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `role` | *Literal["assistant"]* | :heavy_check_mark: | N/A | -| `content` | [OptionalNullable[components.AssistantMessageContent]](../components/assistantmessagecontent.md) | :heavy_minus_sign: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `tool_calls` | List[[components.ChatMessageToolCall](/client-sdks/python/components/chatmessagetoolcall)] | :heavy_minus_sign: | N/A | -| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reasoning_details` | List[[components.Schema2](/client-sdks/python/components/schema2)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/assistantmessagecontent.mdx b/client-sdks/python/components/assistantmessagecontent.mdx deleted file mode 100644 index 2e0fd06f..00000000 --- a/client-sdks/python/components/assistantmessagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: AssistantMessageContent - Python SDK -description: AssistantMessageContent method reference -seoTitle: AssistantMessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/assistantmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': AssistantMessageContent | OpenRouter Python SDK -'og:description': >- - AssistantMessageContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AssistantMessageContent%20-%20Python%20SDK&description=AssistantMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatMessageContentItem]` - -```python lines -value: List[components.ChatMessageContentItem] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/badgatewayresponseerrordata.mdx b/client-sdks/python/components/badgatewayresponseerrordata.mdx deleted file mode 100644 index 9584c932..00000000 --- a/client-sdks/python/components/badgatewayresponseerrordata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BadGatewayResponseErrorData - Python SDK -description: BadGatewayResponseErrorData method reference -seoTitle: BadGatewayResponseErrorData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/badgatewayresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseErrorData | OpenRouter Python SDK -'og:description': >- - BadGatewayResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseErrorData%20-%20Python%20SDK&description=BadGatewayResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for BadGatewayResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/badrequestresponseerrordata.mdx b/client-sdks/python/components/badrequestresponseerrordata.mdx deleted file mode 100644 index b1b53b7c..00000000 --- a/client-sdks/python/components/badrequestresponseerrordata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: BadRequestResponseErrorData - Python SDK -description: BadRequestResponseErrorData method reference -seoTitle: BadRequestResponseErrorData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/badrequestresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseErrorData | OpenRouter Python SDK -'og:description': >- - BadRequestResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseErrorData%20-%20Python%20SDK&description=BadRequestResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for BadRequestResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chainid.mdx b/client-sdks/python/components/chainid.mdx deleted file mode 100644 index e440383e..00000000 --- a/client-sdks/python/components/chainid.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChainID - Python SDK -description: ChainID method reference -seoTitle: ChainID | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chainid' -'og:site_name': OpenRouter Documentation -'og:title': ChainID | OpenRouter Python SDK -'og:description': >- - ChainID method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChainID%20-%20Python%20SDK&description=ChainID%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------------- | --------------------------------------------- | -| `ONE` | 1 | -| `ONE_HUNDRED_AND_THIRTY_SEVEN` | 137 | -| `EIGHT_THOUSAND_FOUR_HUNDRED_AND_FIFTY_THREE` | 8453 | \ No newline at end of file diff --git a/client-sdks/python/components/chatcompletionfinishreason.mdx b/client-sdks/python/components/chatcompletionfinishreason.mdx deleted file mode 100644 index 58488487..00000000 --- a/client-sdks/python/components/chatcompletionfinishreason.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatCompletionFinishReason - Python SDK -description: ChatCompletionFinishReason method reference -seoTitle: ChatCompletionFinishReason | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatcompletionfinishreason' -'og:site_name': OpenRouter Documentation -'og:title': ChatCompletionFinishReason | OpenRouter Python SDK -'og:description': >- - ChatCompletionFinishReason method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatCompletionFinishReason%20-%20Python%20SDK&description=ChatCompletionFinishReason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `TOOL_CALLS` | tool_calls | -| `STOP` | stop | -| `LENGTH` | length | -| `CONTENT_FILTER` | content_filter | -| `ERROR` | error | \ No newline at end of file diff --git a/client-sdks/python/components/chaterrorerror.mdx b/client-sdks/python/components/chaterrorerror.mdx deleted file mode 100644 index 1c26d1c0..00000000 --- a/client-sdks/python/components/chaterrorerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatErrorError - Python SDK -description: ChatErrorError method reference -seoTitle: ChatErrorError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chaterrorerror' -'og:site_name': OpenRouter Documentation -'og:title': ChatErrorError | OpenRouter Python SDK -'og:description': >- - ChatErrorError method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatErrorError%20-%20Python%20SDK&description=ChatErrorError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `code` | [Nullable[components.Code]](../components/code.md) | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `param` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparams.mdx b/client-sdks/python/components/chatgenerationparams.mdx deleted file mode 100644 index 712009f9..00000000 --- a/client-sdks/python/components/chatgenerationparams.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: ChatGenerationParams - Python SDK -description: ChatGenerationParams method reference -seoTitle: ChatGenerationParams | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatgenerationparams' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParams | OpenRouter Python SDK -'og:description': >- - ChatGenerationParams method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParams%20-%20Python%20SDK&description=ChatGenerationParams%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `provider` | [OptionalNullable[components.ChatGenerationParamsProvider]](../components/chatgenerationparamsprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | -| `plugins` | List[[components.ChatGenerationParamsPluginUnion](/client-sdks/python/components/chatgenerationparamspluginunion)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | -| `route` | [OptionalNullable[components.Route]](../components/route.md) | :heavy_minus_sign: | N/A | -| `user` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | -| `messages` | List[[components.Message](/client-sdks/python/components/chatgenerationparamspluginunion)] | :heavy_check_mark: | N/A | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A | -| `logprobs` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `top_logprobs` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `reasoning` | [Optional[components.Reasoning]](../components/reasoning.md) | :heavy_minus_sign: | N/A | -| `response_format` | [Optional[components.ChatGenerationParamsResponseFormatUnion]](../components/chatgenerationparamsresponseformatunion.md) | :heavy_minus_sign: | N/A | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `stop` | [OptionalNullable[components.ChatGenerationParamsStop]](../components/chatgenerationparamsstop.md) | :heavy_minus_sign: | N/A | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `stream_options` | [OptionalNullable[components.ChatStreamOptions]](../components/chatstreamoptions.md) | :heavy_minus_sign: | N/A | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `tool_choice` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `tools` | List[[components.ToolDefinitionJSON](/client-sdks/python/components/tooldefinitionjson)] | :heavy_minus_sign: | N/A | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `debug` | [Optional[components.Debug]](../components/debug.md) | :heavy_minus_sign: | N/A | -| `image_config` | Dict[str, [components.ChatGenerationParamsImageConfig](/client-sdks/python/components/chatgenerationparamsimageconfig)] | :heavy_minus_sign: | N/A | -| `modalities` | List[[components.Modality](/client-sdks/python/api-reference/components/modality)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsdatacollection.mdx b/client-sdks/python/components/chatgenerationparamsdatacollection.mdx deleted file mode 100644 index 84044c5b..00000000 --- a/client-sdks/python/components/chatgenerationparamsdatacollection.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatGenerationParamsDataCollection - Python SDK -description: ChatGenerationParamsDataCollection method reference -seoTitle: ChatGenerationParamsDataCollection | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsdatacollection -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsDataCollection | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsDataCollection method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsDataCollection%20-%20Python%20SDK&description=ChatGenerationParamsDataCollection%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `DENY` | deny | -| `ALLOW` | allow | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsimageconfig.mdx b/client-sdks/python/components/chatgenerationparamsimageconfig.mdx deleted file mode 100644 index 56ea1755..00000000 --- a/client-sdks/python/components/chatgenerationparamsimageconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatGenerationParamsImageConfig - Python SDK -description: ChatGenerationParamsImageConfig method reference -seoTitle: ChatGenerationParamsImageConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsimageconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsImageConfig | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsImageConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsImageConfig%20-%20Python%20SDK&description=ChatGenerationParamsImageConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsmaxprice.mdx b/client-sdks/python/components/chatgenerationparamsmaxprice.mdx deleted file mode 100644 index 1f83f1d3..00000000 --- a/client-sdks/python/components/chatgenerationparamsmaxprice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatGenerationParamsMaxPrice - Python SDK -description: ChatGenerationParamsMaxPrice method reference -seoTitle: ChatGenerationParamsMaxPrice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatgenerationparamsmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsMaxPrice | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsMaxPrice method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsMaxPrice%20-%20Python%20SDK&description=ChatGenerationParamsMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `prompt` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `completion` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `image` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `audio` | *Optional[Any]* | :heavy_minus_sign: | N/A | -| `request` | *Optional[Any]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginautorouter.mdx b/client-sdks/python/components/chatgenerationparamspluginautorouter.mdx deleted file mode 100644 index b4313b58..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginautorouter.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatGenerationParamsPluginAutoRouter - Python SDK -description: ChatGenerationParamsPluginAutoRouter method reference -seoTitle: ChatGenerationParamsPluginAutoRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginautorouter -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginAutoRouter | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginAutoRouter method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginAutoRouter%20-%20Python%20SDK&description=ChatGenerationParamsPluginAutoRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `id` | *Literal["auto-router"]* | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginfileparser.mdx b/client-sdks/python/components/chatgenerationparamspluginfileparser.mdx deleted file mode 100644 index 099f9c94..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginfileparser.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatGenerationParamsPluginFileParser - Python SDK -description: ChatGenerationParamsPluginFileParser method reference -seoTitle: ChatGenerationParamsPluginFileParser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginfileparser -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginFileParser | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginFileParser method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginFileParser%20-%20Python%20SDK&description=ChatGenerationParamsPluginFileParser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `id` | *Literal["file-parser"]* | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `pdf` | [Optional[components.Pdf]](../components/pdf.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginmoderation.mdx b/client-sdks/python/components/chatgenerationparamspluginmoderation.mdx deleted file mode 100644 index fd93f179..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginmoderation.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatGenerationParamsPluginModeration - Python SDK -description: ChatGenerationParamsPluginModeration method reference -seoTitle: ChatGenerationParamsPluginModeration | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginmoderation -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginModeration | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginModeration method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginModeration%20-%20Python%20SDK&description=ChatGenerationParamsPluginModeration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `id` | *Literal["moderation"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginresponsehealing.mdx b/client-sdks/python/components/chatgenerationparamspluginresponsehealing.mdx deleted file mode 100644 index a67c662c..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginresponsehealing.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatGenerationParamsPluginResponseHealing - Python SDK -description: ChatGenerationParamsPluginResponseHealing method reference -seoTitle: ChatGenerationParamsPluginResponseHealing | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginresponsehealing -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginResponseHealing | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginResponseHealing method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginResponseHealing%20-%20Python%20SDK&description=ChatGenerationParamsPluginResponseHealing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `id` | *Literal["response-healing"]* | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginunion.mdx b/client-sdks/python/components/chatgenerationparamspluginunion.mdx deleted file mode 100644 index 3cdcaca0..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ChatGenerationParamsPluginUnion - Python SDK -description: ChatGenerationParamsPluginUnion method reference -seoTitle: ChatGenerationParamsPluginUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginUnion | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginUnion%20-%20Python%20SDK&description=ChatGenerationParamsPluginUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatGenerationParamsPluginAutoRouter` - -```python lines -value: components.ChatGenerationParamsPluginAutoRouter = /* values here */ -``` - -### `components.ChatGenerationParamsPluginModeration` - -```python lines -value: components.ChatGenerationParamsPluginModeration = /* values here */ -``` - -### `components.ChatGenerationParamsPluginWeb` - -```python lines -value: components.ChatGenerationParamsPluginWeb = /* values here */ -``` - -### `components.ChatGenerationParamsPluginFileParser` - -```python lines -value: components.ChatGenerationParamsPluginFileParser = /* values here */ -``` - -### `components.ChatGenerationParamsPluginResponseHealing` - -```python lines -value: components.ChatGenerationParamsPluginResponseHealing = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspluginweb.mdx b/client-sdks/python/components/chatgenerationparamspluginweb.mdx deleted file mode 100644 index cde76038..00000000 --- a/client-sdks/python/components/chatgenerationparamspluginweb.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatGenerationParamsPluginWeb - Python SDK -description: ChatGenerationParamsPluginWeb method reference -seoTitle: ChatGenerationParamsPluginWeb | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspluginweb -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginWeb | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPluginWeb method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginWeb%20-%20Python%20SDK&description=ChatGenerationParamsPluginWeb%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `id` | *Literal["web"]* | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `engine` | [Optional[components.Engine]](../components/engine.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspreferredmaxlatency.mdx b/client-sdks/python/components/chatgenerationparamspreferredmaxlatency.mdx deleted file mode 100644 index a3acabbc..00000000 --- a/client-sdks/python/components/chatgenerationparamspreferredmaxlatency.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMaxLatency - Python SDK -description: ChatGenerationParamsPreferredMaxLatency method reference -seoTitle: ChatGenerationParamsPreferredMaxLatency | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspreferredmaxlatency -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMaxLatency | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPreferredMaxLatency method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMaxLatency%20-%20Python%20SDK&description=ChatGenerationParamsPreferredMaxLatency%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspreferredmaxlatencyunion.mdx b/client-sdks/python/components/chatgenerationparamspreferredmaxlatencyunion.mdx deleted file mode 100644 index e5f91fea..00000000 --- a/client-sdks/python/components/chatgenerationparamspreferredmaxlatencyunion.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMaxLatencyUnion - Python SDK -description: ChatGenerationParamsPreferredMaxLatencyUnion method reference -seoTitle: ChatGenerationParamsPreferredMaxLatencyUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspreferredmaxlatencyunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMaxLatencyUnion | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPreferredMaxLatencyUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMaxLatencyUnion%20-%20Python%20SDK&description=ChatGenerationParamsPreferredMaxLatencyUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.ChatGenerationParamsPreferredMaxLatency` - -```python lines -value: components.ChatGenerationParamsPreferredMaxLatency = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspreferredminthroughput.mdx b/client-sdks/python/components/chatgenerationparamspreferredminthroughput.mdx deleted file mode 100644 index 582ff074..00000000 --- a/client-sdks/python/components/chatgenerationparamspreferredminthroughput.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMinThroughput - Python SDK -description: ChatGenerationParamsPreferredMinThroughput method reference -seoTitle: ChatGenerationParamsPreferredMinThroughput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspreferredminthroughput -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMinThroughput | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPreferredMinThroughput method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMinThroughput%20-%20Python%20SDK&description=ChatGenerationParamsPreferredMinThroughput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamspreferredminthroughputunion.mdx b/client-sdks/python/components/chatgenerationparamspreferredminthroughputunion.mdx deleted file mode 100644 index 03fbf647..00000000 --- a/client-sdks/python/components/chatgenerationparamspreferredminthroughputunion.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMinThroughputUnion - Python SDK -description: ChatGenerationParamsPreferredMinThroughputUnion method reference -seoTitle: ChatGenerationParamsPreferredMinThroughputUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamspreferredminthroughputunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMinThroughputUnion | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsPreferredMinThroughputUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMinThroughputUnion%20-%20Python%20SDK&description=ChatGenerationParamsPreferredMinThroughputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.ChatGenerationParamsPreferredMinThroughput` - -```python lines -value: components.ChatGenerationParamsPreferredMinThroughput = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsprovider.mdx b/client-sdks/python/components/chatgenerationparamsprovider.mdx deleted file mode 100644 index ec183c33..00000000 --- a/client-sdks/python/components/chatgenerationparamsprovider.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatGenerationParamsProvider - Python SDK -description: ChatGenerationParamsProvider method reference -seoTitle: ChatGenerationParamsProvider | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatgenerationparamsprovider' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsProvider | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsProvider method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsProvider%20-%20Python%20SDK&description=ChatGenerationParamsProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| -| `require_parameters` | *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. | -| `data_collection` | [OptionalNullable[components.ChatGenerationParamsDataCollection]](../components/chatgenerationparamsdatacollection.md) | :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. | -| `zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `enforce_distillable_text` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `order` | List[[components.Schema0](/client-sdks/python/components/schema0)] | :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. | -| `only` | List[[components.Schema0](/client-sdks/python/components/schema0)] | :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. | -| `ignore` | List[[components.Schema0](/client-sdks/python/components/schema0)] | :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. | -| `quantizations` | List[[components.Quantizations](/client-sdks/python/components/quantizations)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | -| `sort` | [OptionalNullable[components.ProviderSortUnion]](../components/providersortunion.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | -| `max_price` | [Optional[components.ChatGenerationParamsMaxPrice]](../components/chatgenerationparamsmaxprice.md) | :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. | -| `preferred_min_throughput` | [OptionalNullable[components.ChatGenerationParamsPreferredMinThroughputUnion]](../components/chatgenerationparamspreferredminthroughputunion.md) | :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. | -| `preferred_max_latency` | [OptionalNullable[components.ChatGenerationParamsPreferredMaxLatencyUnion]](../components/chatgenerationparamspreferredmaxlatencyunion.md) | :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. | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsresponseformatjsonobject.mdx b/client-sdks/python/components/chatgenerationparamsresponseformatjsonobject.mdx deleted file mode 100644 index e3fa173a..00000000 --- a/client-sdks/python/components/chatgenerationparamsresponseformatjsonobject.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatJSONObject - Python SDK -description: ChatGenerationParamsResponseFormatJSONObject method reference -seoTitle: ChatGenerationParamsResponseFormatJSONObject | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsresponseformatjsonobject -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatJSONObject | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsResponseFormatJSONObject method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatJSONObject%20-%20Python%20SDK&description=ChatGenerationParamsResponseFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `type` | *Literal["json_object"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsresponseformatpython.mdx b/client-sdks/python/components/chatgenerationparamsresponseformatpython.mdx deleted file mode 100644 index d2fcf1c0..00000000 --- a/client-sdks/python/components/chatgenerationparamsresponseformatpython.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatPython - Python SDK -description: ChatGenerationParamsResponseFormatPython method reference -seoTitle: ChatGenerationParamsResponseFormatPython | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsresponseformatpython -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatPython | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsResponseFormatPython method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatPython%20-%20Python%20SDK&description=ChatGenerationParamsResponseFormatPython%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `type` | *Literal["python"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsresponseformattext.mdx b/client-sdks/python/components/chatgenerationparamsresponseformattext.mdx deleted file mode 100644 index 656d43c6..00000000 --- a/client-sdks/python/components/chatgenerationparamsresponseformattext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatText - Python SDK -description: ChatGenerationParamsResponseFormatText method reference -seoTitle: ChatGenerationParamsResponseFormatText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsresponseformattext -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatText | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsResponseFormatText method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatText%20-%20Python%20SDK&description=ChatGenerationParamsResponseFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *Literal["text"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsresponseformatunion.mdx b/client-sdks/python/components/chatgenerationparamsresponseformatunion.mdx deleted file mode 100644 index 3a323d9b..00000000 --- a/client-sdks/python/components/chatgenerationparamsresponseformatunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatUnion - Python SDK -description: ChatGenerationParamsResponseFormatUnion method reference -seoTitle: ChatGenerationParamsResponseFormatUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatgenerationparamsresponseformatunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatUnion | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsResponseFormatUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatUnion%20-%20Python%20SDK&description=ChatGenerationParamsResponseFormatUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatGenerationParamsResponseFormatText` - -```python lines -value: components.ChatGenerationParamsResponseFormatText = /* values here */ -``` - -### `components.ChatGenerationParamsResponseFormatJSONObject` - -```python lines -value: components.ChatGenerationParamsResponseFormatJSONObject = /* values here */ -``` - -### `components.ResponseFormatJSONSchema` - -```python lines -value: components.ResponseFormatJSONSchema = /* values here */ -``` - -### `components.ResponseFormatTextGrammar` - -```python lines -value: components.ResponseFormatTextGrammar = /* values here */ -``` - -### `components.ChatGenerationParamsResponseFormatPython` - -```python lines -value: components.ChatGenerationParamsResponseFormatPython = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationparamsstop.mdx b/client-sdks/python/components/chatgenerationparamsstop.mdx deleted file mode 100644 index 006440f8..00000000 --- a/client-sdks/python/components/chatgenerationparamsstop.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatGenerationParamsStop - Python SDK -description: ChatGenerationParamsStop method reference -seoTitle: ChatGenerationParamsStop | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatgenerationparamsstop' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsStop | OpenRouter Python SDK -'og:description': >- - ChatGenerationParamsStop method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsStop%20-%20Python%20SDK&description=ChatGenerationParamsStop%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatgenerationtokenusage.mdx b/client-sdks/python/components/chatgenerationtokenusage.mdx deleted file mode 100644 index ab9f2227..00000000 --- a/client-sdks/python/components/chatgenerationtokenusage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ChatGenerationTokenUsage - Python SDK -description: ChatGenerationTokenUsage method reference -seoTitle: ChatGenerationTokenUsage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatgenerationtokenusage' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationTokenUsage | OpenRouter Python SDK -'og:description': >- - ChatGenerationTokenUsage method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationTokenUsage%20-%20Python%20SDK&description=ChatGenerationTokenUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `completion_tokens` | *float* | :heavy_check_mark: | N/A | -| `prompt_tokens` | *float* | :heavy_check_mark: | N/A | -| `total_tokens` | *float* | :heavy_check_mark: | N/A | -| `completion_tokens_details` | [OptionalNullable[components.CompletionTokensDetails]](../components/completiontokensdetails.md) | :heavy_minus_sign: | N/A | -| `prompt_tokens_details` | [OptionalNullable[components.PromptTokensDetails]](../components/prompttokensdetails.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitem.mdx b/client-sdks/python/components/chatmessagecontentitem.mdx deleted file mode 100644 index cf59f969..00000000 --- a/client-sdks/python/components/chatmessagecontentitem.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ChatMessageContentItem - Python SDK -description: ChatMessageContentItem method reference -seoTitle: ChatMessageContentItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagecontentitem' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItem | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItem method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItem%20-%20Python%20SDK&description=ChatMessageContentItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatMessageContentItemText` - -```python lines -value: components.ChatMessageContentItemText = /* values here */ -``` - -### `components.ChatMessageContentItemImage` - -```python lines -value: components.ChatMessageContentItemImage = /* values here */ -``` - -### `components.ChatMessageContentItemAudio` - -```python lines -value: components.ChatMessageContentItemAudio = /* values here */ -``` - -### `components.ChatMessageContentItemVideo` - -```python lines -value: components.ChatMessageContentItemVideo = /* values here */ -``` - -### `components.ChatMessageContentItemVideo` - -```python lines -value: components.ChatMessageContentItemVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemaudio.mdx b/client-sdks/python/components/chatmessagecontentitemaudio.mdx deleted file mode 100644 index 0b5a3279..00000000 --- a/client-sdks/python/components/chatmessagecontentitemaudio.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatMessageContentItemAudio - Python SDK -description: ChatMessageContentItemAudio method reference -seoTitle: ChatMessageContentItemAudio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagecontentitemaudio' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemAudio | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemAudio method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemAudio%20-%20Python%20SDK&description=ChatMessageContentItemAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | *Literal["input_audio"]* | :heavy_check_mark: | N/A | -| `input_audio` | [components.ChatMessageContentItemAudioInputAudio](/client-sdks/python/components/chatmessagecontentitemaudioinputaudio) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemaudioinputaudio.mdx b/client-sdks/python/components/chatmessagecontentitemaudioinputaudio.mdx deleted file mode 100644 index 8151f317..00000000 --- a/client-sdks/python/components/chatmessagecontentitemaudioinputaudio.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageContentItemAudioInputAudio - Python SDK -description: ChatMessageContentItemAudioInputAudio method reference -seoTitle: ChatMessageContentItemAudioInputAudio | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagecontentitemaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemAudioInputAudio | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemAudioInputAudio method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemAudioInputAudio%20-%20Python%20SDK&description=ChatMessageContentItemAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemcachecontrol.mdx b/client-sdks/python/components/chatmessagecontentitemcachecontrol.mdx deleted file mode 100644 index 24544f0d..00000000 --- a/client-sdks/python/components/chatmessagecontentitemcachecontrol.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageContentItemCacheControl - Python SDK -description: ChatMessageContentItemCacheControl method reference -seoTitle: ChatMessageContentItemCacheControl | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagecontentitemcachecontrol -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemCacheControl | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemCacheControl method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemCacheControl%20-%20Python%20SDK&description=ChatMessageContentItemCacheControl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | *Literal["ephemeral"]* | :heavy_check_mark: | N/A | -| `ttl` | [Optional[components.TTL]](../components/ttl.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemimage.mdx b/client-sdks/python/components/chatmessagecontentitemimage.mdx deleted file mode 100644 index d8a47285..00000000 --- a/client-sdks/python/components/chatmessagecontentitemimage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatMessageContentItemImage - Python SDK -description: ChatMessageContentItemImage method reference -seoTitle: ChatMessageContentItemImage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagecontentitemimage' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemImage | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemImage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemImage%20-%20Python%20SDK&description=ChatMessageContentItemImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | *Literal["image_url"]* | :heavy_check_mark: | N/A | -| `image_url` | [components.ImageURL](/client-sdks/python/components/imageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemimagedetail.mdx b/client-sdks/python/components/chatmessagecontentitemimagedetail.mdx deleted file mode 100644 index 47c1a264..00000000 --- a/client-sdks/python/components/chatmessagecontentitemimagedetail.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatMessageContentItemImageDetail - Python SDK -description: ChatMessageContentItemImageDetail method reference -seoTitle: ChatMessageContentItemImageDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagecontentitemimagedetail -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemImageDetail | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemImageDetail method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemImageDetail%20-%20Python%20SDK&description=ChatMessageContentItemImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `LOW` | low | -| `HIGH` | high | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemtext.mdx b/client-sdks/python/components/chatmessagecontentitemtext.mdx deleted file mode 100644 index 063c1fdd..00000000 --- a/client-sdks/python/components/chatmessagecontentitemtext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageContentItemText - Python SDK -description: ChatMessageContentItemText method reference -seoTitle: ChatMessageContentItemText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagecontentitemtext' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemText | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemText method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemText%20-%20Python%20SDK&description=ChatMessageContentItemText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | *Literal["text"]* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `cache_control` | [Optional[components.ChatMessageContentItemCacheControl]](../components/chatmessagecontentitemcachecontrol.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemvideo.mdx b/client-sdks/python/components/chatmessagecontentitemvideo.mdx deleted file mode 100644 index 70290ad3..00000000 --- a/client-sdks/python/components/chatmessagecontentitemvideo.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatMessageContentItemVideo - Python SDK -description: ChatMessageContentItemVideo method reference -seoTitle: ChatMessageContentItemVideo | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagecontentitemvideo' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideo | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemVideo method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideo%20-%20Python%20SDK&description=ChatMessageContentItemVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatMessageContentItemVideoInputVideo` - -```python lines -value: components.ChatMessageContentItemVideoInputVideo = /* values here */ -``` - -### `components.ChatMessageContentItemVideoVideoURL` - -```python lines -value: components.ChatMessageContentItemVideoVideoURL = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemvideoinputvideo.mdx b/client-sdks/python/components/chatmessagecontentitemvideoinputvideo.mdx deleted file mode 100644 index b66842e9..00000000 --- a/client-sdks/python/components/chatmessagecontentitemvideoinputvideo.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageContentItemVideoInputVideo - Python SDK -description: ChatMessageContentItemVideoInputVideo method reference -seoTitle: ChatMessageContentItemVideoInputVideo | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagecontentitemvideoinputvideo -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideoInputVideo | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemVideoInputVideo method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideoInputVideo%20-%20Python%20SDK&description=ChatMessageContentItemVideoInputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `type` | *Literal["input_video"]* | :heavy_check_mark: | N/A | -| `video_url` | [components.VideoURL1](/client-sdks/python/components/videourl1) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagecontentitemvideovideourl.mdx b/client-sdks/python/components/chatmessagecontentitemvideovideourl.mdx deleted file mode 100644 index 8caec411..00000000 --- a/client-sdks/python/components/chatmessagecontentitemvideovideourl.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageContentItemVideoVideoURL - Python SDK -description: ChatMessageContentItemVideoVideoURL method reference -seoTitle: ChatMessageContentItemVideoVideoURL | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagecontentitemvideovideourl -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideoVideoURL | OpenRouter Python SDK -'og:description': >- - ChatMessageContentItemVideoVideoURL method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideoVideoURL%20-%20Python%20SDK&description=ChatMessageContentItemVideoVideoURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `type` | *Literal["video_url"]* | :heavy_check_mark: | N/A | -| `video_url` | [components.VideoURL2](/client-sdks/python/components/videourl2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagetokenlogprob.mdx b/client-sdks/python/components/chatmessagetokenlogprob.mdx deleted file mode 100644 index ba8b03ca..00000000 --- a/client-sdks/python/components/chatmessagetokenlogprob.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatMessageTokenLogprob - Python SDK -description: ChatMessageTokenLogprob method reference -seoTitle: ChatMessageTokenLogprob | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagetokenlogprob' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprob | OpenRouter Python SDK -'og:description': >- - ChatMessageTokenLogprob method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprob%20-%20Python%20SDK&description=ChatMessageTokenLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `token` | *str* | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `bytes_` | List[*float*] | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.ChatMessageTokenLogprobTopLogprob](/client-sdks/python/components/chatmessagetokenlogprobtoplogprob)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagetokenlogprobs.mdx b/client-sdks/python/components/chatmessagetokenlogprobs.mdx deleted file mode 100644 index 0cefc781..00000000 --- a/client-sdks/python/components/chatmessagetokenlogprobs.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatMessageTokenLogprobs - Python SDK -description: ChatMessageTokenLogprobs method reference -seoTitle: ChatMessageTokenLogprobs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagetokenlogprobs' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprobs | OpenRouter Python SDK -'og:description': >- - ChatMessageTokenLogprobs method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprobs%20-%20Python%20SDK&description=ChatMessageTokenLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `content` | List[[components.ChatMessageTokenLogprob](/client-sdks/python/components/chatmessagetokenlogprob)] | :heavy_check_mark: | N/A | -| `refusal` | List[[components.ChatMessageTokenLogprob](/client-sdks/python/components/chatmessagetokenlogprob)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagetokenlogprobtoplogprob.mdx b/client-sdks/python/components/chatmessagetokenlogprobtoplogprob.mdx deleted file mode 100644 index c21b7ff6..00000000 --- a/client-sdks/python/components/chatmessagetokenlogprobtoplogprob.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatMessageTokenLogprobTopLogprob - Python SDK -description: ChatMessageTokenLogprobTopLogprob method reference -seoTitle: ChatMessageTokenLogprobTopLogprob | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatmessagetokenlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprobTopLogprob | OpenRouter Python SDK -'og:description': >- - ChatMessageTokenLogprobTopLogprob method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprobTopLogprob%20-%20Python%20SDK&description=ChatMessageTokenLogprobTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *str* | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `bytes_` | List[*float*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagetoolcall.mdx b/client-sdks/python/components/chatmessagetoolcall.mdx deleted file mode 100644 index 8cda5739..00000000 --- a/client-sdks/python/components/chatmessagetoolcall.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatMessageToolCall - Python SDK -description: ChatMessageToolCall method reference -seoTitle: ChatMessageToolCall | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagetoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageToolCall | OpenRouter Python SDK -'og:description': >- - ChatMessageToolCall method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageToolCall%20-%20Python%20SDK&description=ChatMessageToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | *Literal["function"]* | :heavy_check_mark: | N/A | -| `function` | [components.ChatMessageToolCallFunction](/client-sdks/python/components/chatmessagetoolcallfunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatmessagetoolcallfunction.mdx b/client-sdks/python/components/chatmessagetoolcallfunction.mdx deleted file mode 100644 index 30c7e229..00000000 --- a/client-sdks/python/components/chatmessagetoolcallfunction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatMessageToolCallFunction - Python SDK -description: ChatMessageToolCallFunction method reference -seoTitle: ChatMessageToolCallFunction | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatmessagetoolcallfunction' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageToolCallFunction | OpenRouter Python SDK -'og:description': >- - ChatMessageToolCallFunction method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageToolCallFunction%20-%20Python%20SDK&description=ChatMessageToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | -| `arguments` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatresponse.mdx b/client-sdks/python/components/chatresponse.mdx deleted file mode 100644 index 343bc98b..00000000 --- a/client-sdks/python/components/chatresponse.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ChatResponse - Python SDK -description: ChatResponse method reference -seoTitle: ChatResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatresponse' -'og:site_name': OpenRouter Documentation -'og:title': ChatResponse | OpenRouter Python SDK -'og:description': >- - ChatResponse method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResponse%20-%20Python%20SDK&description=ChatResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `choices` | List[[components.ChatResponseChoice](/client-sdks/python/components/chatresponsechoice)] | :heavy_check_mark: | N/A | -| `created` | *float* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `object` | *Literal["chat.completion"]* | :heavy_check_mark: | N/A | -| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatresponsechoice.mdx b/client-sdks/python/components/chatresponsechoice.mdx deleted file mode 100644 index 0fb38a6e..00000000 --- a/client-sdks/python/components/chatresponsechoice.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatResponseChoice - Python SDK -description: ChatResponseChoice method reference -seoTitle: ChatResponseChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatresponsechoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatResponseChoice | OpenRouter Python SDK -'og:description': >- - ChatResponseChoice method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResponseChoice%20-%20Python%20SDK&description=ChatResponseChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A | -| `index` | *float* | :heavy_check_mark: | N/A | -| `message` | [components.AssistantMessage](/client-sdks/python/components/assistantmessage) | :heavy_check_mark: | N/A | -| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingchoice.mdx b/client-sdks/python/components/chatstreamingchoice.mdx deleted file mode 100644 index 59cf4bee..00000000 --- a/client-sdks/python/components/chatstreamingchoice.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatStreamingChoice - Python SDK -description: ChatStreamingChoice method reference -seoTitle: ChatStreamingChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatstreamingchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingChoice | OpenRouter Python SDK -'og:description': >- - ChatStreamingChoice method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingChoice%20-%20Python%20SDK&description=ChatStreamingChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `delta` | [components.ChatStreamingMessageChunk](/client-sdks/python/components/chatstreamingmessagechunk) | :heavy_check_mark: | N/A | -| `finish_reason` | [Nullable[components.ChatCompletionFinishReason]](../components/chatcompletionfinishreason.md) | :heavy_check_mark: | N/A | -| `index` | *float* | :heavy_check_mark: | N/A | -| `logprobs` | [OptionalNullable[components.ChatMessageTokenLogprobs]](../components/chatmessagetokenlogprobs.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingmessagechunk.mdx b/client-sdks/python/components/chatstreamingmessagechunk.mdx deleted file mode 100644 index 72480e39..00000000 --- a/client-sdks/python/components/chatstreamingmessagechunk.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ChatStreamingMessageChunk - Python SDK -description: ChatStreamingMessageChunk method reference -seoTitle: ChatStreamingMessageChunk | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatstreamingmessagechunk' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageChunk | OpenRouter Python SDK -'og:description': >- - ChatStreamingMessageChunk method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageChunk%20-%20Python%20SDK&description=ChatStreamingMessageChunk%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `role` | [Optional[components.ChatStreamingMessageChunkRole]](../components/chatstreamingmessagechunkrole.md) | :heavy_minus_sign: | N/A | -| `content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `refusal` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `tool_calls` | List[[components.ChatStreamingMessageToolCall](/client-sdks/python/components/chatstreamingmessagetoolcall)] | :heavy_minus_sign: | N/A | -| `reasoning_details` | List[[components.Schema2](/client-sdks/python/components/schema2)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingmessagechunkrole.mdx b/client-sdks/python/components/chatstreamingmessagechunkrole.mdx deleted file mode 100644 index 78ebd084..00000000 --- a/client-sdks/python/components/chatstreamingmessagechunkrole.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ChatStreamingMessageChunkRole - Python SDK -description: ChatStreamingMessageChunkRole method reference -seoTitle: ChatStreamingMessageChunkRole | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatstreamingmessagechunkrole -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageChunkRole | OpenRouter Python SDK -'og:description': >- - ChatStreamingMessageChunkRole method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageChunkRole%20-%20Python%20SDK&description=ChatStreamingMessageChunkRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingmessagetoolcall.mdx b/client-sdks/python/components/chatstreamingmessagetoolcall.mdx deleted file mode 100644 index 0ad65779..00000000 --- a/client-sdks/python/components/chatstreamingmessagetoolcall.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChatStreamingMessageToolCall - Python SDK -description: ChatStreamingMessageToolCall method reference -seoTitle: ChatStreamingMessageToolCall | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatstreamingmessagetoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageToolCall | OpenRouter Python SDK -'og:description': >- - ChatStreamingMessageToolCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageToolCall%20-%20Python%20SDK&description=ChatStreamingMessageToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `index` | *float* | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | *Optional[Literal["function"]]* | :heavy_minus_sign: | N/A | -| `function` | [Optional[components.ChatStreamingMessageToolCallFunction]](../components/chatstreamingmessagetoolcallfunction.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingmessagetoolcallfunction.mdx b/client-sdks/python/components/chatstreamingmessagetoolcallfunction.mdx deleted file mode 100644 index 588258ff..00000000 --- a/client-sdks/python/components/chatstreamingmessagetoolcallfunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatStreamingMessageToolCallFunction - Python SDK -description: ChatStreamingMessageToolCallFunction method reference -seoTitle: ChatStreamingMessageToolCallFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatstreamingmessagetoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageToolCallFunction | OpenRouter Python SDK -'og:description': >- - ChatStreamingMessageToolCallFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageToolCallFunction%20-%20Python%20SDK&description=ChatStreamingMessageToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `arguments` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingresponsechunk.mdx b/client-sdks/python/components/chatstreamingresponsechunk.mdx deleted file mode 100644 index 5ce9076c..00000000 --- a/client-sdks/python/components/chatstreamingresponsechunk.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ChatStreamingResponseChunk - Python SDK -description: ChatStreamingResponseChunk method reference -seoTitle: ChatStreamingResponseChunk | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatstreamingresponsechunk' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunk | OpenRouter Python SDK -'og:description': >- - ChatStreamingResponseChunk method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunk%20-%20Python%20SDK&description=ChatStreamingResponseChunk%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `data` | [components.ChatStreamingResponseChunkData](/client-sdks/python/components/chatstreamingresponsechunkdata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingresponsechunkdata.mdx b/client-sdks/python/components/chatstreamingresponsechunkdata.mdx deleted file mode 100644 index 20497feb..00000000 --- a/client-sdks/python/components/chatstreamingresponsechunkdata.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatStreamingResponseChunkData - Python SDK -description: ChatStreamingResponseChunkData method reference -seoTitle: ChatStreamingResponseChunkData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatstreamingresponsechunkdata -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunkData | OpenRouter Python SDK -'og:description': >- - ChatStreamingResponseChunkData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunkData%20-%20Python%20SDK&description=ChatStreamingResponseChunkData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `choices` | List[[components.ChatStreamingChoice](/client-sdks/python/components/chatstreamingchoice)] | :heavy_check_mark: | N/A | -| `created` | *float* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `object` | *Literal["chat.completion.chunk"]* | :heavy_check_mark: | N/A | -| `system_fingerprint` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `error` | [Optional[components.ChatStreamingResponseChunkError]](../components/chatstreamingresponsechunkerror.md) | :heavy_minus_sign: | N/A | -| `usage` | [Optional[components.ChatGenerationTokenUsage]](../components/chatgenerationtokenusage.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamingresponsechunkerror.mdx b/client-sdks/python/components/chatstreamingresponsechunkerror.mdx deleted file mode 100644 index 48030e23..00000000 --- a/client-sdks/python/components/chatstreamingresponsechunkerror.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ChatStreamingResponseChunkError - Python SDK -description: ChatStreamingResponseChunkError method reference -seoTitle: ChatStreamingResponseChunkError | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/chatstreamingresponsechunkerror -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunkError | OpenRouter Python SDK -'og:description': >- - ChatStreamingResponseChunkError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunkError%20-%20Python%20SDK&description=ChatStreamingResponseChunkError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *str* | :heavy_check_mark: | N/A | -| `code` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/chatstreamoptions.mdx b/client-sdks/python/components/chatstreamoptions.mdx deleted file mode 100644 index f2c932c5..00000000 --- a/client-sdks/python/components/chatstreamoptions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ChatStreamOptions - Python SDK -description: ChatStreamOptions method reference -seoTitle: ChatStreamOptions | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/chatstreamoptions' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamOptions | OpenRouter Python SDK -'og:description': >- - ChatStreamOptions method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamOptions%20-%20Python%20SDK&description=ChatStreamOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `include_usage` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/code.mdx b/client-sdks/python/components/code.mdx deleted file mode 100644 index 34f5aa22..00000000 --- a/client-sdks/python/components/code.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Code - Python SDK -description: Code method reference -seoTitle: Code | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/code' -'og:site_name': OpenRouter Documentation -'og:title': Code | OpenRouter Python SDK -'og:description': >- - Code method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Code%20-%20Python%20SDK&description=Code%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/codeenum.mdx b/client-sdks/python/components/codeenum.mdx deleted file mode 100644 index 2b45052a..00000000 --- a/client-sdks/python/components/codeenum.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CodeEnum - Python SDK -description: CodeEnum method reference -seoTitle: CodeEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/codeenum' -'og:site_name': OpenRouter Documentation -'og:title': CodeEnum | OpenRouter Python SDK -'og:description': >- - CodeEnum method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodeEnum%20-%20Python%20SDK&description=CodeEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `SERVER_ERROR` | server_error | -| `RATE_LIMIT_EXCEEDED` | rate_limit_exceeded | -| `INVALID_PROMPT` | invalid_prompt | -| `VECTOR_STORE_TIMEOUT` | vector_store_timeout | -| `INVALID_IMAGE` | invalid_image | -| `INVALID_IMAGE_FORMAT` | invalid_image_format | -| `INVALID_BASE64_IMAGE` | invalid_base64_image | -| `INVALID_IMAGE_URL` | invalid_image_url | -| `IMAGE_TOO_LARGE` | image_too_large | -| `IMAGE_TOO_SMALL` | image_too_small | -| `IMAGE_PARSE_ERROR` | image_parse_error | -| `IMAGE_CONTENT_POLICY_VIOLATION` | image_content_policy_violation | -| `INVALID_IMAGE_MODE` | invalid_image_mode | -| `IMAGE_FILE_TOO_LARGE` | image_file_too_large | -| `UNSUPPORTED_IMAGE_MEDIA_TYPE` | unsupported_image_media_type | -| `EMPTY_IMAGE_FILE` | empty_image_file | -| `FAILED_TO_DOWNLOAD_IMAGE` | failed_to_download_image | -| `IMAGE_FILE_NOT_FOUND` | image_file_not_found | \ No newline at end of file diff --git a/client-sdks/python/components/completionchoice.mdx b/client-sdks/python/components/completionchoice.mdx deleted file mode 100644 index 878cc766..00000000 --- a/client-sdks/python/components/completionchoice.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CompletionChoice - Python SDK -description: CompletionChoice method reference -seoTitle: CompletionChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completionchoice' -'og:site_name': OpenRouter Documentation -'og:title': CompletionChoice | OpenRouter Python SDK -'og:description': >- - CompletionChoice method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionChoice%20-%20Python%20SDK&description=CompletionChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `text` | *str* | :heavy_check_mark: | N/A | -| `index` | *float* | :heavy_check_mark: | N/A | -| `logprobs` | [Nullable[components.CompletionLogprobs]](../components/completionlogprobs.md) | :heavy_check_mark: | N/A | -| `finish_reason` | [Nullable[components.CompletionFinishReason]](../components/completionfinishreason.md) | :heavy_check_mark: | N/A | -| `native_finish_reason` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `reasoning` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparams.mdx b/client-sdks/python/components/completioncreateparams.mdx deleted file mode 100644 index 6f45ed11..00000000 --- a/client-sdks/python/components/completioncreateparams.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: CompletionCreateParams - Python SDK -description: CompletionCreateParams method reference -seoTitle: CompletionCreateParams | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completioncreateparams' -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParams | OpenRouter Python SDK -'og:description': >- - CompletionCreateParams method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParams%20-%20Python%20SDK&description=CompletionCreateParams%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | -| `prompt` | [components.Prompt](/client-sdks/python/components/prompt) | :heavy_check_mark: | N/A | -| `best_of` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `echo` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `logit_bias` | Dict[str, *float*] | :heavy_minus_sign: | N/A | -| `logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `max_tokens` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `n` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `seed` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | -| `stop` | [OptionalNullable[components.CompletionCreateParamsStop]](../components/completioncreateparamsstop.md) | :heavy_minus_sign: | N/A | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `stream_options` | [OptionalNullable[components.StreamOptions]](../components/streamoptions.md) | :heavy_minus_sign: | N/A | -| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `user` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `metadata` | Dict[str, *str*] | :heavy_minus_sign: | N/A | -| `response_format` | [OptionalNullable[components.CompletionCreateParamsResponseFormatUnion]](../components/completioncreateparamsresponseformatunion.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparamsresponseformatjsonobject.mdx b/client-sdks/python/components/completioncreateparamsresponseformatjsonobject.mdx deleted file mode 100644 index 8911bbd8..00000000 --- a/client-sdks/python/components/completioncreateparamsresponseformatjsonobject.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatJSONObject - Python SDK -description: CompletionCreateParamsResponseFormatJSONObject method reference -seoTitle: CompletionCreateParamsResponseFormatJSONObject | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/completioncreateparamsresponseformatjsonobject -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatJSONObject | OpenRouter Python SDK -'og:description': >- - CompletionCreateParamsResponseFormatJSONObject method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatJSONObject%20-%20Python%20SDK&description=CompletionCreateParamsResponseFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `type` | *Literal["json_object"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparamsresponseformatpython.mdx b/client-sdks/python/components/completioncreateparamsresponseformatpython.mdx deleted file mode 100644 index 73c0af29..00000000 --- a/client-sdks/python/components/completioncreateparamsresponseformatpython.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatPython - Python SDK -description: CompletionCreateParamsResponseFormatPython method reference -seoTitle: CompletionCreateParamsResponseFormatPython | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/completioncreateparamsresponseformatpython -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatPython | OpenRouter Python SDK -'og:description': >- - CompletionCreateParamsResponseFormatPython method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatPython%20-%20Python%20SDK&description=CompletionCreateParamsResponseFormatPython%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `type` | *Literal["python"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparamsresponseformattext.mdx b/client-sdks/python/components/completioncreateparamsresponseformattext.mdx deleted file mode 100644 index 23ef0417..00000000 --- a/client-sdks/python/components/completioncreateparamsresponseformattext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatText - Python SDK -description: CompletionCreateParamsResponseFormatText method reference -seoTitle: CompletionCreateParamsResponseFormatText | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/completioncreateparamsresponseformattext -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatText | OpenRouter Python SDK -'og:description': >- - CompletionCreateParamsResponseFormatText method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatText%20-%20Python%20SDK&description=CompletionCreateParamsResponseFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *Literal["text"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparamsresponseformatunion.mdx b/client-sdks/python/components/completioncreateparamsresponseformatunion.mdx deleted file mode 100644 index 846f5866..00000000 --- a/client-sdks/python/components/completioncreateparamsresponseformatunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatUnion - Python SDK -description: CompletionCreateParamsResponseFormatUnion method reference -seoTitle: CompletionCreateParamsResponseFormatUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/completioncreateparamsresponseformatunion -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatUnion | OpenRouter Python SDK -'og:description': >- - CompletionCreateParamsResponseFormatUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatUnion%20-%20Python%20SDK&description=CompletionCreateParamsResponseFormatUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.CompletionCreateParamsResponseFormatText` - -```python lines -value: components.CompletionCreateParamsResponseFormatText = /* values here */ -``` - -### `components.CompletionCreateParamsResponseFormatJSONObject` - -```python lines -value: components.CompletionCreateParamsResponseFormatJSONObject = /* values here */ -``` - -### `components.ResponseFormatJSONSchema` - -```python lines -value: components.ResponseFormatJSONSchema = /* values here */ -``` - -### `components.ResponseFormatTextGrammar` - -```python lines -value: components.ResponseFormatTextGrammar = /* values here */ -``` - -### `components.CompletionCreateParamsResponseFormatPython` - -```python lines -value: components.CompletionCreateParamsResponseFormatPython = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/completioncreateparamsstop.mdx b/client-sdks/python/components/completioncreateparamsstop.mdx deleted file mode 100644 index e1f70a5e..00000000 --- a/client-sdks/python/components/completioncreateparamsstop.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CompletionCreateParamsStop - Python SDK -description: CompletionCreateParamsStop method reference -seoTitle: CompletionCreateParamsStop | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completioncreateparamsstop' -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsStop | OpenRouter Python SDK -'og:description': >- - CompletionCreateParamsStop method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsStop%20-%20Python%20SDK&description=CompletionCreateParamsStop%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/completionfinishreason.mdx b/client-sdks/python/components/completionfinishreason.mdx deleted file mode 100644 index 5627b2c2..00000000 --- a/client-sdks/python/components/completionfinishreason.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CompletionFinishReason - Python SDK -description: CompletionFinishReason method reference -seoTitle: CompletionFinishReason | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completionfinishreason' -'og:site_name': OpenRouter Documentation -'og:title': CompletionFinishReason | OpenRouter Python SDK -'og:description': >- - CompletionFinishReason method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionFinishReason%20-%20Python%20SDK&description=CompletionFinishReason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `STOP` | stop | -| `LENGTH` | length | -| `CONTENT_FILTER` | content_filter | \ No newline at end of file diff --git a/client-sdks/python/components/completionlogprobs.mdx b/client-sdks/python/components/completionlogprobs.mdx deleted file mode 100644 index 2101d0e7..00000000 --- a/client-sdks/python/components/completionlogprobs.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CompletionLogprobs - Python SDK -description: CompletionLogprobs method reference -seoTitle: CompletionLogprobs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completionlogprobs' -'og:site_name': OpenRouter Documentation -'og:title': CompletionLogprobs | OpenRouter Python SDK -'og:description': >- - CompletionLogprobs method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionLogprobs%20-%20Python%20SDK&description=CompletionLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `tokens` | List[*str*] | :heavy_check_mark: | N/A | -| `token_logprobs` | List[*float*] | :heavy_check_mark: | N/A | -| `top_logprobs` | List[Dict[str, *float*]] | :heavy_check_mark: | N/A | -| `text_offset` | List[*float*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completionresponse.mdx b/client-sdks/python/components/completionresponse.mdx deleted file mode 100644 index 9402359c..00000000 --- a/client-sdks/python/components/completionresponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: CompletionResponse - Python SDK -description: CompletionResponse method reference -seoTitle: CompletionResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completionresponse' -'og:site_name': OpenRouter Documentation -'og:title': CompletionResponse | OpenRouter Python SDK -'og:description': >- - CompletionResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionResponse%20-%20Python%20SDK&description=CompletionResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `object` | *Literal["text_completion"]* | :heavy_check_mark: | N/A | -| `created` | *float* | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `provider` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `choices` | List[[components.CompletionChoice](/client-sdks/python/components/completionchoice)] | :heavy_check_mark: | N/A | -| `usage` | [Optional[components.CompletionUsage]](../components/completionusage.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completiontokensdetails.mdx b/client-sdks/python/components/completiontokensdetails.mdx deleted file mode 100644 index 14dbf87c..00000000 --- a/client-sdks/python/components/completiontokensdetails.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CompletionTokensDetails - Python SDK -description: CompletionTokensDetails method reference -seoTitle: CompletionTokensDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completiontokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': CompletionTokensDetails | OpenRouter Python SDK -'og:description': >- - CompletionTokensDetails method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionTokensDetails%20-%20Python%20SDK&description=CompletionTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `reasoning_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `audio_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `accepted_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `rejected_prediction_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/completionusage.mdx b/client-sdks/python/components/completionusage.mdx deleted file mode 100644 index 9006dc45..00000000 --- a/client-sdks/python/components/completionusage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CompletionUsage - Python SDK -description: CompletionUsage method reference -seoTitle: CompletionUsage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/completionusage' -'og:site_name': OpenRouter Documentation -'og:title': CompletionUsage | OpenRouter Python SDK -'og:description': >- - CompletionUsage method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionUsage%20-%20Python%20SDK&description=CompletionUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `prompt_tokens` | *float* | :heavy_check_mark: | N/A | -| `completion_tokens` | *float* | :heavy_check_mark: | N/A | -| `total_tokens` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/costdetails.mdx b/client-sdks/python/components/costdetails.mdx deleted file mode 100644 index 783b0262..00000000 --- a/client-sdks/python/components/costdetails.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CostDetails - Python SDK -description: CostDetails method reference -seoTitle: CostDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/costdetails' -'og:site_name': OpenRouter Documentation -'og:title': CostDetails | OpenRouter Python SDK -'og:description': >- - CostDetails method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CostDetails%20-%20Python%20SDK&description=CostDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `upstream_inference_cost` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `upstream_inference_input_cost` | *float* | :heavy_check_mark: | N/A | -| `upstream_inference_output_cost` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/createchargerequest.mdx b/client-sdks/python/components/createchargerequest.mdx deleted file mode 100644 index 5db35ef1..00000000 --- a/client-sdks/python/components/createchargerequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateChargeRequest - Python SDK -description: CreateChargeRequest method reference -seoTitle: CreateChargeRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/createchargerequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateChargeRequest | OpenRouter Python SDK -'og:description': >- - CreateChargeRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateChargeRequest%20-%20Python%20SDK&description=CreateChargeRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Create a Coinbase charge for crypto payment - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `amount` | *float* | :heavy_check_mark: | N/A | -| `sender` | *str* | :heavy_check_mark: | N/A | -| `chain_id` | [components.ChainID](/client-sdks/python/components/chainid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/datacollection.mdx b/client-sdks/python/components/datacollection.mdx deleted file mode 100644 index 45d5bc7a..00000000 --- a/client-sdks/python/components/datacollection.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: DataCollection - Python SDK -description: DataCollection method reference -seoTitle: DataCollection | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/datacollection' -'og:site_name': OpenRouter Documentation -'og:title': DataCollection | OpenRouter Python SDK -'og:description': >- - DataCollection method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DataCollection%20-%20Python%20SDK&description=DataCollection%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| ------- | ------- | -| `DENY` | deny | -| `ALLOW` | allow | \ No newline at end of file diff --git a/client-sdks/python/components/debug.mdx b/client-sdks/python/components/debug.mdx deleted file mode 100644 index 7d457dd6..00000000 --- a/client-sdks/python/components/debug.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Debug - Python SDK -description: Debug method reference -seoTitle: Debug | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/debug' -'og:site_name': OpenRouter Documentation -'og:title': Debug | OpenRouter Python SDK -'og:description': >- - Debug method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Debug%20-%20Python%20SDK&description=Debug%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `echo_upstream_body` | *Optional[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/defaultparameters.mdx b/client-sdks/python/components/defaultparameters.mdx deleted file mode 100644 index 12e84084..00000000 --- a/client-sdks/python/components/defaultparameters.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: DefaultParameters - Python SDK -description: DefaultParameters method reference -seoTitle: DefaultParameters | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/defaultparameters' -'og:site_name': OpenRouter Documentation -'og:title': DefaultParameters | OpenRouter Python SDK -'og:description': >- - DefaultParameters method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DefaultParameters%20-%20Python%20SDK&description=DefaultParameters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Default parameters for this model - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/edgenetworktimeoutresponseerrordata.mdx b/client-sdks/python/components/edgenetworktimeoutresponseerrordata.mdx deleted file mode 100644 index d84ae6f7..00000000 --- a/client-sdks/python/components/edgenetworktimeoutresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseErrorData - Python SDK -description: EdgeNetworkTimeoutResponseErrorData method reference -seoTitle: EdgeNetworkTimeoutResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/edgenetworktimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseErrorData | OpenRouter Python SDK -'og:description': >- - EdgeNetworkTimeoutResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseErrorData%20-%20Python%20SDK&description=EdgeNetworkTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for EdgeNetworkTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/effort.mdx b/client-sdks/python/components/effort.mdx deleted file mode 100644 index ac0edc39..00000000 --- a/client-sdks/python/components/effort.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Effort - Python SDK -description: Effort method reference -seoTitle: Effort | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/effort' -'og:site_name': OpenRouter Documentation -'og:title': Effort | OpenRouter Python SDK -'og:description': >- - Effort method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Effort%20-%20Python%20SDK&description=Effort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `XHIGH` | xhigh | -| `HIGH` | high | -| `MEDIUM` | medium | -| `LOW` | low | -| `MINIMAL` | minimal | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/components/endpointstatus.mdx b/client-sdks/python/components/endpointstatus.mdx deleted file mode 100644 index cc42e073..00000000 --- a/client-sdks/python/components/endpointstatus.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: EndpointStatus - Python SDK -description: EndpointStatus method reference -seoTitle: EndpointStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/endpointstatus' -'og:site_name': OpenRouter Documentation -'og:title': EndpointStatus | OpenRouter Python SDK -'og:description': >- - EndpointStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointStatus%20-%20Python%20SDK&description=EndpointStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `ZERO` | 0 | -| `MINUS_1` | -1 | -| `MINUS_2` | -2 | -| `MINUS_3` | -3 | -| `MINUS_5` | -5 | -| `MINUS_10` | -10 | \ No newline at end of file diff --git a/client-sdks/python/components/engine.mdx b/client-sdks/python/components/engine.mdx deleted file mode 100644 index 5cc92def..00000000 --- a/client-sdks/python/components/engine.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Engine - Python SDK -description: Engine method reference -seoTitle: Engine | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/engine' -'og:site_name': OpenRouter Documentation -'og:title': Engine | OpenRouter Python SDK -'og:description': >- - Engine method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Engine%20-%20Python%20SDK&description=Engine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `NATIVE` | native | -| `EXA` | exa | \ No newline at end of file diff --git a/client-sdks/python/components/filecitation.mdx b/client-sdks/python/components/filecitation.mdx deleted file mode 100644 index 18fb546d..00000000 --- a/client-sdks/python/components/filecitation.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: FileCitation - Python SDK -description: FileCitation method reference -seoTitle: FileCitation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/filecitation' -'og:site_name': OpenRouter Documentation -'og:title': FileCitation | OpenRouter Python SDK -'og:description': >- - FileCitation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitation%20-%20Python%20SDK&description=FileCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | [components.FileCitationType](/client-sdks/python/api-reference/components/filecitationtype) | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `filename` | *str* | :heavy_check_mark: | N/A | -| `index` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/filecitationtype.mdx b/client-sdks/python/components/filecitationtype.mdx deleted file mode 100644 index 87f23d3f..00000000 --- a/client-sdks/python/components/filecitationtype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: FileCitationType - Python SDK -description: FileCitationType method reference -seoTitle: FileCitationType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/filecitationtype' -'og:site_name': OpenRouter Documentation -'og:title': FileCitationType | OpenRouter Python SDK -'og:description': >- - FileCitationType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitationType%20-%20Python%20SDK&description=FileCitationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FILE_CITATION` | file_citation | \ No newline at end of file diff --git a/client-sdks/python/components/filepath.mdx b/client-sdks/python/components/filepath.mdx deleted file mode 100644 index 10bf007e..00000000 --- a/client-sdks/python/components/filepath.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: FilePath - Python SDK -description: FilePath method reference -seoTitle: FilePath | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/filepath' -'og:site_name': OpenRouter Documentation -'og:title': FilePath | OpenRouter Python SDK -'og:description': >- - FilePath method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePath%20-%20Python%20SDK&description=FilePath%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `type` | [components.FilePathType](/client-sdks/python/api-reference/components/filepathtype) | :heavy_check_mark: | N/A | -| `file_id` | *str* | :heavy_check_mark: | N/A | -| `index` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/filepathtype.mdx b/client-sdks/python/components/filepathtype.mdx deleted file mode 100644 index 2e502dad..00000000 --- a/client-sdks/python/components/filepathtype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: FilePathType - Python SDK -description: FilePathType method reference -seoTitle: FilePathType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/filepathtype' -'og:site_name': OpenRouter Documentation -'og:title': FilePathType | OpenRouter Python SDK -'og:description': >- - FilePathType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePathType%20-%20Python%20SDK&description=FilePathType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `FILE_PATH` | file_path | \ No newline at end of file diff --git a/client-sdks/python/components/forbiddenresponseerrordata.mdx b/client-sdks/python/components/forbiddenresponseerrordata.mdx deleted file mode 100644 index a6d7ddb3..00000000 --- a/client-sdks/python/components/forbiddenresponseerrordata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ForbiddenResponseErrorData - Python SDK -description: ForbiddenResponseErrorData method reference -seoTitle: ForbiddenResponseErrorData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/forbiddenresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseErrorData | OpenRouter Python SDK -'og:description': >- - ForbiddenResponseErrorData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseErrorData%20-%20Python%20SDK&description=ForbiddenResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ForbiddenResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/idautorouter.mdx b/client-sdks/python/components/idautorouter.mdx deleted file mode 100644 index 335710a0..00000000 --- a/client-sdks/python/components/idautorouter.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: IDAutoRouter - Python SDK -description: IDAutoRouter method reference -seoTitle: IDAutoRouter | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/idautorouter' -'og:site_name': OpenRouter Documentation -'og:title': IDAutoRouter | OpenRouter Python SDK -'og:description': >- - IDAutoRouter method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IDAutoRouter%20-%20Python%20SDK&description=IDAutoRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `AUTO_ROUTER` | auto-router | \ No newline at end of file diff --git a/client-sdks/python/components/idfileparser.mdx b/client-sdks/python/components/idfileparser.mdx deleted file mode 100644 index bde12e7b..00000000 --- a/client-sdks/python/components/idfileparser.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: IDFileParser - Python SDK -description: IDFileParser method reference -seoTitle: IDFileParser | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/idfileparser' -'og:site_name': OpenRouter Documentation -'og:title': IDFileParser | OpenRouter Python SDK -'og:description': >- - IDFileParser method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IDFileParser%20-%20Python%20SDK&description=IDFileParser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `FILE_PARSER` | file-parser | \ No newline at end of file diff --git a/client-sdks/python/components/idmoderation.mdx b/client-sdks/python/components/idmoderation.mdx deleted file mode 100644 index 3bc06bf8..00000000 --- a/client-sdks/python/components/idmoderation.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: IDModeration - Python SDK -description: IDModeration method reference -seoTitle: IDModeration | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/idmoderation' -'og:site_name': OpenRouter Documentation -'og:title': IDModeration | OpenRouter Python SDK -'og:description': >- - IDModeration method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IDModeration%20-%20Python%20SDK&description=IDModeration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `MODERATION` | moderation | \ No newline at end of file diff --git a/client-sdks/python/components/idresponsehealing.mdx b/client-sdks/python/components/idresponsehealing.mdx deleted file mode 100644 index 9665cfa7..00000000 --- a/client-sdks/python/components/idresponsehealing.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: IDResponseHealing - Python SDK -description: IDResponseHealing method reference -seoTitle: IDResponseHealing | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/idresponsehealing' -'og:site_name': OpenRouter Documentation -'og:title': IDResponseHealing | OpenRouter Python SDK -'og:description': >- - IDResponseHealing method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IDResponseHealing%20-%20Python%20SDK&description=IDResponseHealing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `RESPONSE_HEALING` | response-healing | \ No newline at end of file diff --git a/client-sdks/python/components/idweb.mdx b/client-sdks/python/components/idweb.mdx deleted file mode 100644 index 5ae8cbf0..00000000 --- a/client-sdks/python/components/idweb.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: IDWeb - Python SDK -description: IDWeb method reference -seoTitle: IDWeb | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/idweb' -'og:site_name': OpenRouter Documentation -'og:title': IDWeb | OpenRouter Python SDK -'og:description': >- - IDWeb method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IDWeb%20-%20Python%20SDK&description=IDWeb%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `WEB` | web | \ No newline at end of file diff --git a/client-sdks/python/components/imagegenerationstatus.mdx b/client-sdks/python/components/imagegenerationstatus.mdx deleted file mode 100644 index b453f2c9..00000000 --- a/client-sdks/python/components/imagegenerationstatus.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ImageGenerationStatus - Python SDK -description: ImageGenerationStatus method reference -seoTitle: ImageGenerationStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/imagegenerationstatus' -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationStatus | OpenRouter Python SDK -'og:description': >- - ImageGenerationStatus method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationStatus%20-%20Python%20SDK&description=ImageGenerationStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `GENERATING` | generating | -| `FAILED` | failed | \ No newline at end of file diff --git a/client-sdks/python/components/imageurl.mdx b/client-sdks/python/components/imageurl.mdx deleted file mode 100644 index 557695d6..00000000 --- a/client-sdks/python/components/imageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ImageURL - Python SDK -description: ImageURL method reference -seoTitle: ImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageURL | OpenRouter Python SDK -'og:description': >- - ImageURL method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageURL%20-%20Python%20SDK&description=ImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | -| `detail` | [Optional[components.ChatMessageContentItemImageDetail]](../components/chatmessagecontentitemimagedetail.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/inputmodality.mdx b/client-sdks/python/components/inputmodality.mdx deleted file mode 100644 index 689d18a3..00000000 --- a/client-sdks/python/components/inputmodality.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: InputModality - Python SDK -description: InputModality method reference -seoTitle: InputModality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/inputmodality' -'og:site_name': OpenRouter Documentation -'og:title': InputModality | OpenRouter Python SDK -'og:description': >- - InputModality method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputModality%20-%20Python%20SDK&description=InputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | -| `FILE` | file | -| `AUDIO` | audio | -| `VIDEO` | video | \ No newline at end of file diff --git a/client-sdks/python/components/inputtokensdetails.mdx b/client-sdks/python/components/inputtokensdetails.mdx deleted file mode 100644 index ab71019e..00000000 --- a/client-sdks/python/components/inputtokensdetails.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: InputTokensDetails - Python SDK -description: InputTokensDetails method reference -seoTitle: InputTokensDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/inputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': InputTokensDetails | OpenRouter Python SDK -'og:description': >- - InputTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTokensDetails%20-%20Python%20SDK&description=InputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `cached_tokens` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/instructtype.mdx b/client-sdks/python/components/instructtype.mdx deleted file mode 100644 index a314ec78..00000000 --- a/client-sdks/python/components/instructtype.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: InstructType - Python SDK -description: InstructType method reference -seoTitle: InstructType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/instructtype' -'og:site_name': OpenRouter Documentation -'og:title': InstructType | OpenRouter Python SDK -'og:description': >- - InstructType method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InstructType%20-%20Python%20SDK&description=InstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Values - -| Name | Value | -| --------------- | --------------- | -| `NONE` | none | -| `AIROBOROS` | airoboros | -| `ALPACA` | alpaca | -| `ALPACA_MODIF` | alpaca-modif | -| `CHATML` | chatml | -| `CLAUDE` | claude | -| `CODE_LLAMA` | code-llama | -| `GEMMA` | gemma | -| `LLAMA2` | llama2 | -| `LLAMA3` | llama3 | -| `MISTRAL` | mistral | -| `NEMOTRON` | nemotron | -| `NEURAL` | neural | -| `OPENCHAT` | openchat | -| `PHI3` | phi3 | -| `RWKV` | rwkv | -| `VICUNA` | vicuna | -| `ZEPHYR` | zephyr | -| `DEEPSEEK_R1` | deepseek-r1 | -| `DEEPSEEK_V3_1` | deepseek-v3.1 | -| `QWQ` | qwq | -| `QWEN3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/python/components/internalserverresponseerrordata.mdx b/client-sdks/python/components/internalserverresponseerrordata.mdx deleted file mode 100644 index 451fd7f7..00000000 --- a/client-sdks/python/components/internalserverresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: InternalServerResponseErrorData - Python SDK -description: InternalServerResponseErrorData method reference -seoTitle: InternalServerResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/internalserverresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseErrorData | OpenRouter Python SDK -'og:description': >- - InternalServerResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseErrorData%20-%20Python%20SDK&description=InternalServerResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for InternalServerResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/jsonschemaconfig.mdx b/client-sdks/python/components/jsonschemaconfig.mdx deleted file mode 100644 index 5ae79668..00000000 --- a/client-sdks/python/components/jsonschemaconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: JSONSchemaConfig - Python SDK -description: JSONSchemaConfig method reference -seoTitle: JSONSchemaConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/jsonschemaconfig' -'og:site_name': OpenRouter Documentation -'og:title': JSONSchemaConfig | OpenRouter Python SDK -'og:description': >- - JSONSchemaConfig method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=JSONSchemaConfig%20-%20Python%20SDK&description=JSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `schema_` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/listendpointsresponse.mdx b/client-sdks/python/components/listendpointsresponse.mdx deleted file mode 100644 index a7a872f9..00000000 --- a/client-sdks/python/components/listendpointsresponse.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListEndpointsResponse - Python SDK -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/listendpointsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Python%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of available endpoints for a model - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `created` | *float* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *str* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `architecture` | [components.Architecture](/client-sdks/python/api-reference/components/architecture) | :heavy_check_mark: | N/A | `{"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}` | -| `endpoints` | List[[components.PublicEndpoint](/client-sdks/python/api-reference/components/publicendpoint)] | :heavy_check_mark: | List of available endpoints for this model | | \ No newline at end of file diff --git a/client-sdks/python/components/logprob.mdx b/client-sdks/python/components/logprob.mdx deleted file mode 100644 index e44a425e..00000000 --- a/client-sdks/python/components/logprob.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Logprob - Python SDK -description: Logprob method reference -seoTitle: Logprob | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/logprob' -'og:site_name': OpenRouter Documentation -'og:title': Logprob | OpenRouter Python SDK -'og:description': >- - Logprob method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logprob%20-%20Python%20SDK&description=Logprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `token` | *str* | :heavy_check_mark: | N/A | -| `bytes_` | List[*float*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.ResponseOutputTextTopLogprob](/client-sdks/python/api-reference/components/responseoutputtexttoplogprob)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/message.mdx b/client-sdks/python/components/message.mdx deleted file mode 100644 index c79151eb..00000000 --- a/client-sdks/python/components/message.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Message - Python SDK -description: Message method reference -seoTitle: Message | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/message' -'og:site_name': OpenRouter Documentation -'og:title': Message | OpenRouter Python SDK -'og:description': >- - Message method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Message%20-%20Python%20SDK&description=Message%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.SystemMessage` - -```python lines -value: components.SystemMessage = /* values here */ -``` - -### `components.UserMessage` - -```python lines -value: components.UserMessage = /* values here */ -``` - -### `components.MessageDeveloper` - -```python lines -value: components.MessageDeveloper = /* values here */ -``` - -### `components.AssistantMessage` - -```python lines -value: components.AssistantMessage = /* values here */ -``` - -### `components.ToolResponseMessage` - -```python lines -value: components.ToolResponseMessage = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/messagecontent.mdx b/client-sdks/python/components/messagecontent.mdx deleted file mode 100644 index bcca1470..00000000 --- a/client-sdks/python/components/messagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: MessageContent - Python SDK -description: MessageContent method reference -seoTitle: MessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/messagecontent' -'og:site_name': OpenRouter Documentation -'og:title': MessageContent | OpenRouter Python SDK -'og:description': >- - MessageContent method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessageContent%20-%20Python%20SDK&description=MessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatMessageContentItemText]` - -```python lines -value: List[components.ChatMessageContentItemText] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/messagedeveloper.mdx b/client-sdks/python/components/messagedeveloper.mdx deleted file mode 100644 index 85c6bf7e..00000000 --- a/client-sdks/python/components/messagedeveloper.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: MessageDeveloper - Python SDK -description: MessageDeveloper method reference -seoTitle: MessageDeveloper | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/messagedeveloper' -'og:site_name': OpenRouter Documentation -'og:title': MessageDeveloper | OpenRouter Python SDK -'og:description': >- - MessageDeveloper method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessageDeveloper%20-%20Python%20SDK&description=MessageDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `role` | *Literal["developer"]* | :heavy_check_mark: | N/A | -| `content` | [components.MessageContent](/client-sdks/python/components/messagecontent) | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/modality.mdx b/client-sdks/python/components/modality.mdx deleted file mode 100644 index b70dd0da..00000000 --- a/client-sdks/python/components/modality.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Modality - Python SDK -description: Modality method reference -seoTitle: Modality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modality' -'og:site_name': OpenRouter Documentation -'og:title': Modality | OpenRouter Python SDK -'og:description': >- - Modality method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Modality%20-%20Python%20SDK&description=Modality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/components/model.mdx b/client-sdks/python/components/model.mdx deleted file mode 100644 index 81194582..00000000 --- a/client-sdks/python/components/model.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Model - Python SDK -description: Model method reference -seoTitle: Model | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/model' -'og:site_name': OpenRouter Documentation -'og:title': Model | OpenRouter Python SDK -'og:description': >- - Model method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Model%20-%20Python%20SDK&description=Model%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about an AI model available on OpenRouter - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `canonical_slug` | *str* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `hugging_face_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `name` | *str* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `created` | *float* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *Optional[str]* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `pricing` | [components.PublicPricing](/client-sdks/python/api-reference/components/publicpricing) | :heavy_check_mark: | Pricing information for the model | `{"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"}` | -| `context_length` | *Nullable[float]* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `architecture` | [components.ModelArchitecture](/client-sdks/python/api-reference/components/modelarchitecture) | :heavy_check_mark: | Model architecture information | `{"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}` | -| `top_provider` | [components.TopProviderInfo](/client-sdks/python/api-reference/components/topproviderinfo) | :heavy_check_mark: | Information about the top provider for this model | `{"context_length": 8192,"max_completion_tokens": 4096,"is_moderated": true}` | -| `per_request_limits` | [Nullable[components.PerRequestLimits]](../components/perrequestlimits.md) | :heavy_check_mark: | Per-request token limits | `{"prompt_tokens": 1000,"completion_tokens": 1000}` | -| `supported_parameters` | List[[components.Parameter](/client-sdks/python/api-reference/components/parameter)] | :heavy_check_mark: | List of supported parameters for this model | | -| `default_parameters` | [Nullable[components.DefaultParameters]](../components/defaultparameters.md) | :heavy_check_mark: | Default parameters for this model | `{"temperature": 0.7,"top_p": 0.9,"frequency_penalty": 0}` | -| `expiration_date` | *OptionalNullable[str]* | :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 | \ No newline at end of file diff --git a/client-sdks/python/components/modelarchitecture.mdx b/client-sdks/python/components/modelarchitecture.mdx deleted file mode 100644 index cc6a2117..00000000 --- a/client-sdks/python/components/modelarchitecture.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ModelArchitecture - Python SDK -description: ModelArchitecture method reference -seoTitle: ModelArchitecture | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modelarchitecture' -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitecture | OpenRouter Python SDK -'og:description': >- - ModelArchitecture method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitecture%20-%20Python%20SDK&description=ModelArchitecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `tokenizer` | [Optional[components.ModelGroup]](../components/modelgroup.md) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | -| `instruct_type` | [OptionalNullable[components.ModelArchitectureInstructType]](../components/modelarchitectureinstructtype.md) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *Nullable[str]* | :heavy_check_mark: | Primary modality of the model | text->text | -| `input_modalities` | List[[components.InputModality](/client-sdks/python/api-reference/components/inputmodality)] | :heavy_check_mark: | Supported input modalities | | -| `output_modalities` | List[[components.OutputModality](/client-sdks/python/api-reference/components/outputmodality)] | :heavy_check_mark: | Supported output modalities | | \ No newline at end of file diff --git a/client-sdks/python/components/modelarchitectureinstructtype.mdx b/client-sdks/python/components/modelarchitectureinstructtype.mdx deleted file mode 100644 index 11528423..00000000 --- a/client-sdks/python/components/modelarchitectureinstructtype.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ModelArchitectureInstructType - Python SDK -description: ModelArchitectureInstructType method reference -seoTitle: ModelArchitectureInstructType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/modelarchitectureinstructtype -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitectureInstructType | OpenRouter Python SDK -'og:description': >- - ModelArchitectureInstructType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitectureInstructType%20-%20Python%20SDK&description=ModelArchitectureInstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Values - -| Name | Value | -| --------------- | --------------- | -| `NONE` | none | -| `AIROBOROS` | airoboros | -| `ALPACA` | alpaca | -| `ALPACA_MODIF` | alpaca-modif | -| `CHATML` | chatml | -| `CLAUDE` | claude | -| `CODE_LLAMA` | code-llama | -| `GEMMA` | gemma | -| `LLAMA2` | llama2 | -| `LLAMA3` | llama3 | -| `MISTRAL` | mistral | -| `NEMOTRON` | nemotron | -| `NEURAL` | neural | -| `OPENCHAT` | openchat | -| `PHI3` | phi3 | -| `RWKV` | rwkv | -| `VICUNA` | vicuna | -| `ZEPHYR` | zephyr | -| `DEEPSEEK_R1` | deepseek-r1 | -| `DEEPSEEK_V3_1` | deepseek-v3.1 | -| `QWQ` | qwq | -| `QWEN3` | qwen3 | \ No newline at end of file diff --git a/client-sdks/python/components/modelgroup.mdx b/client-sdks/python/components/modelgroup.mdx deleted file mode 100644 index bbb34513..00000000 --- a/client-sdks/python/components/modelgroup.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ModelGroup - Python SDK -description: ModelGroup method reference -seoTitle: ModelGroup | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modelgroup' -'og:site_name': OpenRouter Documentation -'og:title': ModelGroup | OpenRouter Python SDK -'og:description': >- - ModelGroup method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelGroup%20-%20Python%20SDK&description=ModelGroup%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ROUTER` | Router | -| `MEDIA` | Media | -| `OTHER` | Other | -| `GPT` | GPT | -| `CLAUDE` | Claude | -| `GEMINI` | Gemini | -| `GROK` | Grok | -| `COHERE` | Cohere | -| `NOVA` | Nova | -| `QWEN` | Qwen | -| `YI` | Yi | -| `DEEP_SEEK` | DeepSeek | -| `MISTRAL` | Mistral | -| `LLAMA2` | Llama2 | -| `LLAMA3` | Llama3 | -| `LLAMA4` | Llama4 | -| `PA_LM` | PaLM | -| `RWKV` | RWKV | -| `QWEN3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/python/components/modelscountresponse.mdx b/client-sdks/python/components/modelscountresponse.mdx deleted file mode 100644 index 4ad64a37..00000000 --- a/client-sdks/python/components/modelscountresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModelsCountResponse - Python SDK -description: ModelsCountResponse method reference -seoTitle: ModelsCountResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modelscountresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponse | OpenRouter Python SDK -'og:description': >- - ModelsCountResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponse%20-%20Python%20SDK&description=ModelsCountResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [components.ModelsCountResponseData](/client-sdks/python/api-reference/components/modelscountresponsedata) | :heavy_check_mark: | Model count data | `{"count": 150}` | \ No newline at end of file diff --git a/client-sdks/python/components/modelscountresponsedata.mdx b/client-sdks/python/components/modelscountresponsedata.mdx deleted file mode 100644 index 23b601fe..00000000 --- a/client-sdks/python/components/modelscountresponsedata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModelsCountResponseData - Python SDK -description: ModelsCountResponseData method reference -seoTitle: ModelsCountResponseData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modelscountresponsedata' -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponseData | OpenRouter Python SDK -'og:description': >- - ModelsCountResponseData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponseData%20-%20Python%20SDK&description=ModelsCountResponseData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Model count data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *float* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/client-sdks/python/components/modelslistresponse.mdx b/client-sdks/python/components/modelslistresponse.mdx deleted file mode 100644 index 54dbafe8..00000000 --- a/client-sdks/python/components/modelslistresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ModelsListResponse - Python SDK -description: ModelsListResponse method reference -seoTitle: ModelsListResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/modelslistresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsListResponse | OpenRouter Python SDK -'og:description': >- - ModelsListResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsListResponse%20-%20Python%20SDK&description=ModelsListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of available models - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `data` | List[[components.Model](/client-sdks/python/api-reference/components/model)] | :heavy_check_mark: | List of available models | \ No newline at end of file diff --git a/client-sdks/python/components/namedtoolchoice.mdx b/client-sdks/python/components/namedtoolchoice.mdx deleted file mode 100644 index aa8c3d22..00000000 --- a/client-sdks/python/components/namedtoolchoice.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: NamedToolChoice - Python SDK -description: NamedToolChoice method reference -seoTitle: NamedToolChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/namedtoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': NamedToolChoice | OpenRouter Python SDK -'og:description': >- - NamedToolChoice method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NamedToolChoice%20-%20Python%20SDK&description=NamedToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | *Literal["function"]* | :heavy_check_mark: | N/A | -| `function` | [components.NamedToolChoiceFunction](/client-sdks/python/components/namedtoolchoicefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/namedtoolchoicefunction.mdx b/client-sdks/python/components/namedtoolchoicefunction.mdx deleted file mode 100644 index 1612db2c..00000000 --- a/client-sdks/python/components/namedtoolchoicefunction.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: NamedToolChoiceFunction - Python SDK -description: NamedToolChoiceFunction method reference -seoTitle: NamedToolChoiceFunction | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/namedtoolchoicefunction' -'og:site_name': OpenRouter Documentation -'og:title': NamedToolChoiceFunction | OpenRouter Python SDK -'og:description': >- - NamedToolChoiceFunction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NamedToolChoiceFunction%20-%20Python%20SDK&description=NamedToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/notfoundresponseerrordata.mdx b/client-sdks/python/components/notfoundresponseerrordata.mdx deleted file mode 100644 index bb15b15f..00000000 --- a/client-sdks/python/components/notfoundresponseerrordata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: NotFoundResponseErrorData - Python SDK -description: NotFoundResponseErrorData method reference -seoTitle: NotFoundResponseErrorData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/notfoundresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseErrorData | OpenRouter Python SDK -'og:description': >- - NotFoundResponseErrorData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseErrorData%20-%20Python%20SDK&description=NotFoundResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for NotFoundResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/object.mdx b/client-sdks/python/components/object.mdx deleted file mode 100644 index 23195556..00000000 --- a/client-sdks/python/components/object.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Object - Python SDK -description: Object method reference -seoTitle: Object | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/object' -'og:site_name': OpenRouter Documentation -'og:title': Object | OpenRouter Python SDK -'og:description': >- - Object method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Object%20-%20Python%20SDK&description=Object%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `RESPONSE` | response | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesannotation.mdx b/client-sdks/python/components/openairesponsesannotation.mdx deleted file mode 100644 index a5a121d6..00000000 --- a/client-sdks/python/components/openairesponsesannotation.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponsesAnnotation - Python SDK -description: OpenAIResponsesAnnotation method reference -seoTitle: OpenAIResponsesAnnotation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesannotation' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesAnnotation | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesAnnotation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesAnnotation%20-%20Python%20SDK&description=OpenAIResponsesAnnotation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.FileCitation` - -```python lines -value: components.FileCitation = /* values here */ -``` - -### `components.URLCitation` - -```python lines -value: components.URLCitation = /* values here */ -``` - -### `components.FilePath` - -```python lines -value: components.FilePath = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesincludable.mdx b/client-sdks/python/components/openairesponsesincludable.mdx deleted file mode 100644 index 2d622f43..00000000 --- a/client-sdks/python/components/openairesponsesincludable.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OpenAIResponsesIncludable - Python SDK -description: OpenAIResponsesIncludable method reference -seoTitle: OpenAIResponsesIncludable | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesincludable' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesIncludable | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesIncludable method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesIncludable%20-%20Python%20SDK&description=OpenAIResponsesIncludable%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `FILE_SEARCH_CALL_RESULTS` | file_search_call.results | -| `MESSAGE_INPUT_IMAGE_IMAGE_URL` | message.input_image.image_url | -| `COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL` | computer_call_output.output.image_url | -| `REASONING_ENCRYPTED_CONTENT` | reasoning.encrypted_content | -| `CODE_INTERPRETER_CALL_OUTPUTS` | code_interpreter_call.outputs | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesincompletedetails.mdx b/client-sdks/python/components/openairesponsesincompletedetails.mdx deleted file mode 100644 index c8170c9b..00000000 --- a/client-sdks/python/components/openairesponsesincompletedetails.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesIncompleteDetails - Python SDK -description: OpenAIResponsesIncompleteDetails method reference -seoTitle: OpenAIResponsesIncompleteDetails | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesincompletedetails -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesIncompleteDetails | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesIncompleteDetails method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesIncompleteDetails%20-%20Python%20SDK&description=OpenAIResponsesIncompleteDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `reason` | [Optional[components.Reason]](../components/reason.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputcontent1.mdx b/client-sdks/python/components/openairesponsesinputcontent1.mdx deleted file mode 100644 index fcf94510..00000000 --- a/client-sdks/python/components/openairesponsesinputcontent1.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAIResponsesInputContent1 - Python SDK -description: OpenAIResponsesInputContent1 method reference -seoTitle: OpenAIResponsesInputContent1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputcontent1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputContent1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent1%20-%20Python%20SDK&description=OpenAIResponsesInputContent1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseInputText` - -```python lines -value: components.ResponseInputText = /* values here */ -``` - -### `components.ResponseInputImage` - -```python lines -value: components.ResponseInputImage = /* values here */ -``` - -### `components.ResponseInputFile` - -```python lines -value: components.ResponseInputFile = /* values here */ -``` - -### `components.ResponseInputAudio` - -```python lines -value: components.ResponseInputAudio = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputcontent2.mdx b/client-sdks/python/components/openairesponsesinputcontent2.mdx deleted file mode 100644 index 18bef2fa..00000000 --- a/client-sdks/python/components/openairesponsesinputcontent2.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenAIResponsesInputContent2 - Python SDK -description: OpenAIResponsesInputContent2 method reference -seoTitle: OpenAIResponsesInputContent2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputcontent2' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputContent2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent2%20-%20Python%20SDK&description=OpenAIResponsesInputContent2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.OpenAIResponsesInputContent1]` - -```python lines -value: List[components.OpenAIResponsesInputContent1] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputcontent3.mdx b/client-sdks/python/components/openairesponsesinputcontent3.mdx deleted file mode 100644 index b6585494..00000000 --- a/client-sdks/python/components/openairesponsesinputcontent3.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAIResponsesInputContent3 - Python SDK -description: OpenAIResponsesInputContent3 method reference -seoTitle: OpenAIResponsesInputContent3 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputcontent3' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent3 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputContent3 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent3%20-%20Python%20SDK&description=OpenAIResponsesInputContent3%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseInputText` - -```python lines -value: components.ResponseInputText = /* values here */ -``` - -### `components.ResponseInputImage` - -```python lines -value: components.ResponseInputImage = /* values here */ -``` - -### `components.ResponseInputFile` - -```python lines -value: components.ResponseInputFile = /* values here */ -``` - -### `components.ResponseInputAudio` - -```python lines -value: components.ResponseInputAudio = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputfunctioncall.mdx b/client-sdks/python/components/openairesponsesinputfunctioncall.mdx deleted file mode 100644 index db763809..00000000 --- a/client-sdks/python/components/openairesponsesinputfunctioncall.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenAIResponsesInputFunctionCall - Python SDK -description: OpenAIResponsesInputFunctionCall method reference -seoTitle: OpenAIResponsesInputFunctionCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputfunctioncall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputFunctionCall | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputFunctionCall method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputFunctionCall%20-%20Python%20SDK&description=OpenAIResponsesInputFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesInputTypeFunctionCall](/client-sdks/python/components/openairesponsesinputtypefunctioncall) | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputfunctioncalloutput.mdx b/client-sdks/python/components/openairesponsesinputfunctioncalloutput.mdx deleted file mode 100644 index 29079fbb..00000000 --- a/client-sdks/python/components/openairesponsesinputfunctioncalloutput.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenAIResponsesInputFunctionCallOutput - Python SDK -description: OpenAIResponsesInputFunctionCallOutput method reference -seoTitle: OpenAIResponsesInputFunctionCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputfunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputFunctionCallOutput | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputFunctionCallOutput method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputFunctionCallOutput%20-%20Python%20SDK&description=OpenAIResponsesInputFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesInputTypeFunctionCallOutput](/client-sdks/python/components/openairesponsesinputtypefunctioncalloutput) | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `output` | *str* | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputmessage1.mdx b/client-sdks/python/components/openairesponsesinputmessage1.mdx deleted file mode 100644 index fbca1eb2..00000000 --- a/client-sdks/python/components/openairesponsesinputmessage1.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesInputMessage1 - Python SDK -description: OpenAIResponsesInputMessage1 method reference -seoTitle: OpenAIResponsesInputMessage1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputmessage1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputMessage1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputMessage1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputMessage1%20-%20Python%20SDK&description=OpenAIResponsesInputMessage1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [Optional[components.OpenAIResponsesInputTypeMessage1]](../components/openairesponsesinputtypemessage1.md) | :heavy_minus_sign: | N/A | -| `role` | [components.OpenAIResponsesInputRoleUnion1](/client-sdks/python/components/openairesponsesinputroleunion1) | :heavy_check_mark: | N/A | -| `content` | [components.OpenAIResponsesInputContent2](/client-sdks/python/components/openairesponsesinputcontent2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputmessage2.mdx b/client-sdks/python/components/openairesponsesinputmessage2.mdx deleted file mode 100644 index 734e84e4..00000000 --- a/client-sdks/python/components/openairesponsesinputmessage2.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenAIResponsesInputMessage2 - Python SDK -description: OpenAIResponsesInputMessage2 method reference -seoTitle: OpenAIResponsesInputMessage2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputmessage2' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputMessage2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputMessage2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputMessage2%20-%20Python%20SDK&description=OpenAIResponsesInputMessage2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `type` | [Optional[components.OpenAIResponsesInputTypeMessage2]](../components/openairesponsesinputtypemessage2.md) | :heavy_minus_sign: | N/A | -| `role` | [components.OpenAIResponsesInputRoleUnion2](/client-sdks/python/components/openairesponsesinputroleunion2) | :heavy_check_mark: | N/A | -| `content` | List[[components.OpenAIResponsesInputContent3](/client-sdks/python/components/openairesponsesinputcontent3)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroleassistant.mdx b/client-sdks/python/components/openairesponsesinputroleassistant.mdx deleted file mode 100644 index b3836ee4..00000000 --- a/client-sdks/python/components/openairesponsesinputroleassistant.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleAssistant - Python SDK -description: OpenAIResponsesInputRoleAssistant method reference -seoTitle: OpenAIResponsesInputRoleAssistant | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroleassistant -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleAssistant | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleAssistant method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleAssistant%20-%20Python%20SDK&description=OpenAIResponsesInputRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroledeveloper1.mdx b/client-sdks/python/components/openairesponsesinputroledeveloper1.mdx deleted file mode 100644 index 4454f0e5..00000000 --- a/client-sdks/python/components/openairesponsesinputroledeveloper1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleDeveloper1 - Python SDK -description: OpenAIResponsesInputRoleDeveloper1 method reference -seoTitle: OpenAIResponsesInputRoleDeveloper1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroledeveloper1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleDeveloper1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleDeveloper1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleDeveloper1%20-%20Python%20SDK&description=OpenAIResponsesInputRoleDeveloper1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroledeveloper2.mdx b/client-sdks/python/components/openairesponsesinputroledeveloper2.mdx deleted file mode 100644 index aceace6d..00000000 --- a/client-sdks/python/components/openairesponsesinputroledeveloper2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleDeveloper2 - Python SDK -description: OpenAIResponsesInputRoleDeveloper2 method reference -seoTitle: OpenAIResponsesInputRoleDeveloper2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroledeveloper2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleDeveloper2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleDeveloper2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleDeveloper2%20-%20Python%20SDK&description=OpenAIResponsesInputRoleDeveloper2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputrolesystem1.mdx b/client-sdks/python/components/openairesponsesinputrolesystem1.mdx deleted file mode 100644 index ecd4a558..00000000 --- a/client-sdks/python/components/openairesponsesinputrolesystem1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleSystem1 - Python SDK -description: OpenAIResponsesInputRoleSystem1 method reference -seoTitle: OpenAIResponsesInputRoleSystem1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputrolesystem1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleSystem1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleSystem1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleSystem1%20-%20Python%20SDK&description=OpenAIResponsesInputRoleSystem1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputrolesystem2.mdx b/client-sdks/python/components/openairesponsesinputrolesystem2.mdx deleted file mode 100644 index 1b17f3c9..00000000 --- a/client-sdks/python/components/openairesponsesinputrolesystem2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleSystem2 - Python SDK -description: OpenAIResponsesInputRoleSystem2 method reference -seoTitle: OpenAIResponsesInputRoleSystem2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputrolesystem2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleSystem2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleSystem2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleSystem2%20-%20Python%20SDK&description=OpenAIResponsesInputRoleSystem2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroleunion1.mdx b/client-sdks/python/components/openairesponsesinputroleunion1.mdx deleted file mode 100644 index 26549916..00000000 --- a/client-sdks/python/components/openairesponsesinputroleunion1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUnion1 - Python SDK -description: OpenAIResponsesInputRoleUnion1 method reference -seoTitle: OpenAIResponsesInputRoleUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroleunion1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUnion1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleUnion1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUnion1%20-%20Python%20SDK&description=OpenAIResponsesInputRoleUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesInputRoleUser1` - -```python lines -value: components.OpenAIResponsesInputRoleUser1 = /* values here */ -``` - -### `components.OpenAIResponsesInputRoleSystem1` - -```python lines -value: components.OpenAIResponsesInputRoleSystem1 = /* values here */ -``` - -### `components.OpenAIResponsesInputRoleAssistant` - -```python lines -value: components.OpenAIResponsesInputRoleAssistant = /* values here */ -``` - -### `components.OpenAIResponsesInputRoleDeveloper1` - -```python lines -value: components.OpenAIResponsesInputRoleDeveloper1 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroleunion2.mdx b/client-sdks/python/components/openairesponsesinputroleunion2.mdx deleted file mode 100644 index f365864c..00000000 --- a/client-sdks/python/components/openairesponsesinputroleunion2.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUnion2 - Python SDK -description: OpenAIResponsesInputRoleUnion2 method reference -seoTitle: OpenAIResponsesInputRoleUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroleunion2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUnion2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleUnion2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUnion2%20-%20Python%20SDK&description=OpenAIResponsesInputRoleUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesInputRoleUser2` - -```python lines -value: components.OpenAIResponsesInputRoleUser2 = /* values here */ -``` - -### `components.OpenAIResponsesInputRoleSystem2` - -```python lines -value: components.OpenAIResponsesInputRoleSystem2 = /* values here */ -``` - -### `components.OpenAIResponsesInputRoleDeveloper2` - -```python lines -value: components.OpenAIResponsesInputRoleDeveloper2 = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroleuser1.mdx b/client-sdks/python/components/openairesponsesinputroleuser1.mdx deleted file mode 100644 index 3d25d226..00000000 --- a/client-sdks/python/components/openairesponsesinputroleuser1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUser1 - Python SDK -description: OpenAIResponsesInputRoleUser1 method reference -seoTitle: OpenAIResponsesInputRoleUser1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroleuser1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUser1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleUser1 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUser1%20-%20Python%20SDK&description=OpenAIResponsesInputRoleUser1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputroleuser2.mdx b/client-sdks/python/components/openairesponsesinputroleuser2.mdx deleted file mode 100644 index 33fba9b7..00000000 --- a/client-sdks/python/components/openairesponsesinputroleuser2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUser2 - Python SDK -description: OpenAIResponsesInputRoleUser2 method reference -seoTitle: OpenAIResponsesInputRoleUser2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputroleuser2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUser2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputRoleUser2 method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUser2%20-%20Python%20SDK&description=OpenAIResponsesInputRoleUser2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputtypefunctioncall.mdx b/client-sdks/python/components/openairesponsesinputtypefunctioncall.mdx deleted file mode 100644 index 55563a57..00000000 --- a/client-sdks/python/components/openairesponsesinputtypefunctioncall.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputTypeFunctionCall - Python SDK -description: OpenAIResponsesInputTypeFunctionCall method reference -seoTitle: OpenAIResponsesInputTypeFunctionCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputtypefunctioncall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeFunctionCall | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputTypeFunctionCall method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeFunctionCall%20-%20Python%20SDK&description=OpenAIResponsesInputTypeFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputtypefunctioncalloutput.mdx b/client-sdks/python/components/openairesponsesinputtypefunctioncalloutput.mdx deleted file mode 100644 index db4edcb0..00000000 --- a/client-sdks/python/components/openairesponsesinputtypefunctioncalloutput.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputTypeFunctionCallOutput - Python SDK -description: OpenAIResponsesInputTypeFunctionCallOutput method reference -seoTitle: OpenAIResponsesInputTypeFunctionCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputtypefunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeFunctionCallOutput | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputTypeFunctionCallOutput method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeFunctionCallOutput%20-%20Python%20SDK&description=OpenAIResponsesInputTypeFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FUNCTION_CALL_OUTPUT` | function_call_output | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputtypemessage1.mdx b/client-sdks/python/components/openairesponsesinputtypemessage1.mdx deleted file mode 100644 index d0573097..00000000 --- a/client-sdks/python/components/openairesponsesinputtypemessage1.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputTypeMessage1 - Python SDK -description: OpenAIResponsesInputTypeMessage1 method reference -seoTitle: OpenAIResponsesInputTypeMessage1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputtypemessage1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeMessage1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputTypeMessage1 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeMessage1%20-%20Python%20SDK&description=OpenAIResponsesInputTypeMessage1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputtypemessage2.mdx b/client-sdks/python/components/openairesponsesinputtypemessage2.mdx deleted file mode 100644 index 33a6740e..00000000 --- a/client-sdks/python/components/openairesponsesinputtypemessage2.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesInputTypeMessage2 - Python SDK -description: OpenAIResponsesInputTypeMessage2 method reference -seoTitle: OpenAIResponsesInputTypeMessage2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesinputtypemessage2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeMessage2 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputTypeMessage2 method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeMessage2%20-%20Python%20SDK&description=OpenAIResponsesInputTypeMessage2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputunion.mdx b/client-sdks/python/components/openairesponsesinputunion.mdx deleted file mode 100644 index 68d73155..00000000 --- a/client-sdks/python/components/openairesponsesinputunion.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponsesInputUnion - Python SDK -description: OpenAIResponsesInputUnion method reference -seoTitle: OpenAIResponsesInputUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputunion' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputUnion | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputUnion%20-%20Python%20SDK&description=OpenAIResponsesInputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.OpenAIResponsesInputUnion1]` - -```python lines -value: List[components.OpenAIResponsesInputUnion1] = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesinputunion1.mdx b/client-sdks/python/components/openairesponsesinputunion1.mdx deleted file mode 100644 index 067e78b8..00000000 --- a/client-sdks/python/components/openairesponsesinputunion1.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: OpenAIResponsesInputUnion1 - Python SDK -description: OpenAIResponsesInputUnion1 method reference -seoTitle: OpenAIResponsesInputUnion1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesinputunion1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputUnion1 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesInputUnion1 method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputUnion1%20-%20Python%20SDK&description=OpenAIResponsesInputUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesInputMessage1` - -```python lines -value: components.OpenAIResponsesInputMessage1 = /* values here */ -``` - -### `components.OpenAIResponsesInputMessage2` - -```python lines -value: components.OpenAIResponsesInputMessage2 = /* values here */ -``` - -### `components.OpenAIResponsesInputFunctionCallOutput` - -```python lines -value: components.OpenAIResponsesInputFunctionCallOutput = /* values here */ -``` - -### `components.OpenAIResponsesInputFunctionCall` - -```python lines -value: components.OpenAIResponsesInputFunctionCall = /* values here */ -``` - -### `components.OutputItemImageGenerationCall` - -```python lines -value: components.OutputItemImageGenerationCall = /* values here */ -``` - -### `components.OutputMessage` - -```python lines -value: components.OutputMessage = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesprompt.mdx b/client-sdks/python/components/openairesponsesprompt.mdx deleted file mode 100644 index ba3f4088..00000000 --- a/client-sdks/python/components/openairesponsesprompt.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesPrompt - Python SDK -description: OpenAIResponsesPrompt method reference -seoTitle: OpenAIResponsesPrompt | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesprompt' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesPrompt | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesPrompt method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesPrompt%20-%20Python%20SDK&description=OpenAIResponsesPrompt%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | -| `variables` | Dict[str, [components.Variables](/client-sdks/python/api-reference/components/variables)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesreasoningconfig.mdx b/client-sdks/python/components/openairesponsesreasoningconfig.mdx deleted file mode 100644 index 780e8d49..00000000 --- a/client-sdks/python/components/openairesponsesreasoningconfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesReasoningConfig - Python SDK -description: OpenAIResponsesReasoningConfig method reference -seoTitle: OpenAIResponsesReasoningConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesreasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesReasoningConfig | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesReasoningConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesReasoningConfig%20-%20Python%20SDK&description=OpenAIResponsesReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.OpenAIResponsesReasoningEffort]](../components/openairesponsesreasoningeffort.md) | :heavy_minus_sign: | N/A | -| `summary` | [Optional[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesreasoningeffort.mdx b/client-sdks/python/components/openairesponsesreasoningeffort.mdx deleted file mode 100644 index 23d68c3a..00000000 --- a/client-sdks/python/components/openairesponsesreasoningeffort.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenAIResponsesReasoningEffort - Python SDK -description: OpenAIResponsesReasoningEffort method reference -seoTitle: OpenAIResponsesReasoningEffort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesreasoningeffort -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesReasoningEffort | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesReasoningEffort method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesReasoningEffort%20-%20Python%20SDK&description=OpenAIResponsesReasoningEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `XHIGH` | xhigh | -| `HIGH` | high | -| `MEDIUM` | medium | -| `LOW` | low | -| `MINIMAL` | minimal | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesrefusalcontent.mdx b/client-sdks/python/components/openairesponsesrefusalcontent.mdx deleted file mode 100644 index 21323465..00000000 --- a/client-sdks/python/components/openairesponsesrefusalcontent.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesRefusalContent - Python SDK -description: OpenAIResponsesRefusalContent method reference -seoTitle: OpenAIResponsesRefusalContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesrefusalcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContent | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesRefusalContent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContent%20-%20Python%20SDK&description=OpenAIResponsesRefusalContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesRefusalContentType](/client-sdks/python/api-reference/components/openairesponsesrefusalcontenttype) | :heavy_check_mark: | N/A | -| `refusal` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesrefusalcontenttype.mdx b/client-sdks/python/components/openairesponsesrefusalcontenttype.mdx deleted file mode 100644 index 3e6d15f0..00000000 --- a/client-sdks/python/components/openairesponsesrefusalcontenttype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesRefusalContentType - Python SDK -description: OpenAIResponsesRefusalContentType method reference -seoTitle: OpenAIResponsesRefusalContentType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesrefusalcontenttype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContentType | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesRefusalContentType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContentType%20-%20Python%20SDK&description=OpenAIResponsesRefusalContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `REFUSAL` | refusal | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesresponsestatus.mdx b/client-sdks/python/components/openairesponsesresponsestatus.mdx deleted file mode 100644 index 04d19cb1..00000000 --- a/client-sdks/python/components/openairesponsesresponsestatus.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenAIResponsesResponseStatus - Python SDK -description: OpenAIResponsesResponseStatus method reference -seoTitle: OpenAIResponsesResponseStatus | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsesresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesResponseStatus | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesResponseStatus method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesResponseStatus%20-%20Python%20SDK&description=OpenAIResponsesResponseStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | -| `IN_PROGRESS` | in_progress | -| `FAILED` | failed | -| `CANCELLED` | cancelled | -| `QUEUED` | queued | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsesservicetier.mdx b/client-sdks/python/components/openairesponsesservicetier.mdx deleted file mode 100644 index 3537df75..00000000 --- a/client-sdks/python/components/openairesponsesservicetier.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OpenAIResponsesServiceTier - Python SDK -description: OpenAIResponsesServiceTier method reference -seoTitle: OpenAIResponsesServiceTier | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsesservicetier' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesServiceTier | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesServiceTier method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesServiceTier%20-%20Python%20SDK&description=OpenAIResponsesServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DEFAULT` | default | -| `FLEX` | flex | -| `PRIORITY` | priority | -| `SCALE` | scale | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoice.mdx b/client-sdks/python/components/openairesponsestoolchoice.mdx deleted file mode 100644 index 4c86aeab..00000000 --- a/client-sdks/python/components/openairesponsestoolchoice.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OpenAIResponsesToolChoice - Python SDK -description: OpenAIResponsesToolChoice method reference -seoTitle: OpenAIResponsesToolChoice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsestoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoice | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoice method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoice%20-%20Python%20SDK&description=OpenAIResponsesToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [components.Type](/client-sdks/python/api-reference/components/type) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoiceauto.mdx b/client-sdks/python/components/openairesponsestoolchoiceauto.mdx deleted file mode 100644 index 4a20a8d2..00000000 --- a/client-sdks/python/components/openairesponsestoolchoiceauto.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceAuto - Python SDK -description: OpenAIResponsesToolChoiceAuto method reference -seoTitle: OpenAIResponsesToolChoiceAuto | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceAuto | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceAuto method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceAuto%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicefunction.mdx b/client-sdks/python/components/openairesponsestoolchoicefunction.mdx deleted file mode 100644 index 2f9b29d8..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicefunction.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceFunction - Python SDK -description: OpenAIResponsesToolChoiceFunction method reference -seoTitle: OpenAIResponsesToolChoiceFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceFunction | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceFunction%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenAIResponsesToolChoiceTypeFunction](/client-sdks/python/api-reference/components/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicenone.mdx b/client-sdks/python/components/openairesponsestoolchoicenone.mdx deleted file mode 100644 index 7097d08f..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicenone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceNone - Python SDK -description: OpenAIResponsesToolChoiceNone method reference -seoTitle: OpenAIResponsesToolChoiceNone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceNone | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceNone method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceNone%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicerequired.mdx b/client-sdks/python/components/openairesponsestoolchoicerequired.mdx deleted file mode 100644 index 6f9077a6..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicerequired.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceRequired - Python SDK -description: OpenAIResponsesToolChoiceRequired method reference -seoTitle: OpenAIResponsesToolChoiceRequired | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceRequired | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceRequired method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceRequired%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceRequired%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `REQUIRED` | required | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicetypefunction.mdx b/client-sdks/python/components/openairesponsestoolchoicetypefunction.mdx deleted file mode 100644 index bda4c0e5..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicetypefunction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeFunction - Python SDK -description: OpenAIResponsesToolChoiceTypeFunction method reference -seoTitle: OpenAIResponsesToolChoiceTypeFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicetypefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeFunction | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeFunction%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview.mdx b/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview.mdx deleted file mode 100644 index e7b52dfb..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview - Python SDK -description: OpenAIResponsesToolChoiceTypeWebSearchPreview method reference -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicetypewebsearchpreview -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `WEB_SEARCH_PREVIEW` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx b/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx deleted file mode 100644 index 566428ab..00000000 --- a/client-sdks/python/components/openairesponsestoolchoicetypewebsearchpreview20250311.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - Python SDK -description: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method reference -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoicetypewebsearchpreview20250311 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method documentation for - the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `WEB_SEARCH_PREVIEW_2025_03_11` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestoolchoiceunion.mdx b/client-sdks/python/components/openairesponsestoolchoiceunion.mdx deleted file mode 100644 index 82aa2874..00000000 --- a/client-sdks/python/components/openairesponsestoolchoiceunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceUnion - Python SDK -description: OpenAIResponsesToolChoiceUnion method reference -seoTitle: OpenAIResponsesToolChoiceUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openairesponsestoolchoiceunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceUnion | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesToolChoiceUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceUnion%20-%20Python%20SDK&description=OpenAIResponsesToolChoiceUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesToolChoiceAuto` - -```python lines -value: components.OpenAIResponsesToolChoiceAuto = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceNone` - -```python lines -value: components.OpenAIResponsesToolChoiceNone = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceRequired` - -```python lines -value: components.OpenAIResponsesToolChoiceRequired = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceFunction` - -```python lines -value: components.OpenAIResponsesToolChoiceFunction = /* values here */ -``` - -### `components.OpenAIResponsesToolChoice` - -```python lines -value: components.OpenAIResponsesToolChoice = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openairesponsestruncation.mdx b/client-sdks/python/components/openairesponsestruncation.mdx deleted file mode 100644 index 319835f3..00000000 --- a/client-sdks/python/components/openairesponsestruncation.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenAIResponsesTruncation - Python SDK -description: OpenAIResponsesTruncation method reference -seoTitle: OpenAIResponsesTruncation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openairesponsestruncation' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesTruncation | OpenRouter Python SDK -'og:description': >- - OpenAIResponsesTruncation method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesTruncation%20-%20Python%20SDK&description=OpenAIResponsesTruncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessage.mdx b/client-sdks/python/components/openresponseseasyinputmessage.mdx deleted file mode 100644 index f515692f..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessage.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesEasyInputMessage - Python SDK -description: OpenResponsesEasyInputMessage method reference -seoTitle: OpenResponsesEasyInputMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessage | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessage method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessage%20-%20Python%20SDK&description=OpenResponsesEasyInputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `type` | [Optional[components.OpenResponsesEasyInputMessageTypeMessage]](../components/openresponseseasyinputmessagetypemessage.md) | :heavy_minus_sign: | N/A | -| `role` | [components.OpenResponsesEasyInputMessageRoleUnion](/client-sdks/python/components/openresponseseasyinputmessageroleunion) | :heavy_check_mark: | N/A | -| `content` | [components.OpenResponsesEasyInputMessageContentUnion2](/client-sdks/python/components/openresponseseasyinputmessagecontentunion2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagecontentinputimage.mdx b/client-sdks/python/components/openresponseseasyinputmessagecontentinputimage.mdx deleted file mode 100644 index 69842743..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagecontentinputimage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentInputImage - Python SDK -description: OpenResponsesEasyInputMessageContentInputImage method reference -seoTitle: OpenResponsesEasyInputMessageContentInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagecontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentInputImage | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageContentInputImage method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentInputImage%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesEasyInputMessageContentType](/client-sdks/python/components/openresponseseasyinputmessagecontenttype) | :heavy_check_mark: | N/A | -| `detail` | [components.OpenResponsesEasyInputMessageDetail](/client-sdks/python/components/openresponseseasyinputmessagedetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagecontenttype.mdx b/client-sdks/python/components/openresponseseasyinputmessagecontenttype.mdx deleted file mode 100644 index 720a80dd..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagecontenttype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentType - Python SDK -description: OpenResponsesEasyInputMessageContentType method reference -seoTitle: OpenResponsesEasyInputMessageContentType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagecontenttype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentType | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageContentType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentType%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagecontentunion1.mdx b/client-sdks/python/components/openresponseseasyinputmessagecontentunion1.mdx deleted file mode 100644 index 9bbf1c35..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagecontentunion1.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentUnion1 - Python SDK -description: OpenResponsesEasyInputMessageContentUnion1 method reference -seoTitle: OpenResponsesEasyInputMessageContentUnion1 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagecontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentUnion1 | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageContentUnion1 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentUnion1%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageContentUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseInputText` - -```python lines -value: components.ResponseInputText = /* values here */ -``` - -### `components.OpenResponsesEasyInputMessageContentInputImage` - -```python lines -value: components.OpenResponsesEasyInputMessageContentInputImage = /* values here */ -``` - -### `components.ResponseInputFile` - -```python lines -value: components.ResponseInputFile = /* values here */ -``` - -### `components.ResponseInputAudio` - -```python lines -value: components.ResponseInputAudio = /* values here */ -``` - -### `components.ResponseInputVideo` - -```python lines -value: components.ResponseInputVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagecontentunion2.mdx b/client-sdks/python/components/openresponseseasyinputmessagecontentunion2.mdx deleted file mode 100644 index 2e45ade2..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagecontentunion2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentUnion2 - Python SDK -description: OpenResponsesEasyInputMessageContentUnion2 method reference -seoTitle: OpenResponsesEasyInputMessageContentUnion2 | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagecontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentUnion2 | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageContentUnion2 method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentUnion2%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageContentUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[components.OpenResponsesEasyInputMessageContentUnion1]` - -```python lines -value: List[components.OpenResponsesEasyInputMessageContentUnion1] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagedetail.mdx b/client-sdks/python/components/openresponseseasyinputmessagedetail.mdx deleted file mode 100644 index 3fc61783..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagedetail.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageDetail - Python SDK -description: OpenResponsesEasyInputMessageDetail method reference -seoTitle: OpenResponsesEasyInputMessageDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagedetail -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageDetail | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageDetail method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageDetail%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessageroleassistant.mdx b/client-sdks/python/components/openresponseseasyinputmessageroleassistant.mdx deleted file mode 100644 index aab39c8b..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessageroleassistant.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleAssistant - Python SDK -description: OpenResponsesEasyInputMessageRoleAssistant method reference -seoTitle: OpenResponsesEasyInputMessageRoleAssistant | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessageroleassistant -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleAssistant | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleAssistant method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleAssistant%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessageroledeveloper.mdx b/client-sdks/python/components/openresponseseasyinputmessageroledeveloper.mdx deleted file mode 100644 index 3ee738f0..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessageroledeveloper.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleDeveloper - Python SDK -description: OpenResponsesEasyInputMessageRoleDeveloper method reference -seoTitle: OpenResponsesEasyInputMessageRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessageroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleDeveloper | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleDeveloper method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleDeveloper%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagerolesystem.mdx b/client-sdks/python/components/openresponseseasyinputmessagerolesystem.mdx deleted file mode 100644 index 253118de..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagerolesystem.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleSystem - Python SDK -description: OpenResponsesEasyInputMessageRoleSystem method reference -seoTitle: OpenResponsesEasyInputMessageRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagerolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleSystem | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleSystem method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleSystem%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessageroleunion.mdx b/client-sdks/python/components/openresponseseasyinputmessageroleunion.mdx deleted file mode 100644 index f0d27783..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessageroleunion.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleUnion - Python SDK -description: OpenResponsesEasyInputMessageRoleUnion method reference -seoTitle: OpenResponsesEasyInputMessageRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessageroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleUnion%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesEasyInputMessageRoleUser` - -```python lines -value: components.OpenResponsesEasyInputMessageRoleUser = /* values here */ -``` - -### `components.OpenResponsesEasyInputMessageRoleSystem` - -```python lines -value: components.OpenResponsesEasyInputMessageRoleSystem = /* values here */ -``` - -### `components.OpenResponsesEasyInputMessageRoleAssistant` - -```python lines -value: components.OpenResponsesEasyInputMessageRoleAssistant = /* values here */ -``` - -### `components.OpenResponsesEasyInputMessageRoleDeveloper` - -```python lines -value: components.OpenResponsesEasyInputMessageRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessageroleuser.mdx b/client-sdks/python/components/openresponseseasyinputmessageroleuser.mdx deleted file mode 100644 index ac909365..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessageroleuser.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleUser - Python SDK -description: OpenResponsesEasyInputMessageRoleUser method reference -seoTitle: OpenResponsesEasyInputMessageRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessageroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleUser | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleUser method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleUser%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseseasyinputmessagetypemessage.mdx b/client-sdks/python/components/openresponseseasyinputmessagetypemessage.mdx deleted file mode 100644 index 77b53663..00000000 --- a/client-sdks/python/components/openresponseseasyinputmessagetypemessage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageTypeMessage - Python SDK -description: OpenResponsesEasyInputMessageTypeMessage method reference -seoTitle: OpenResponsesEasyInputMessageTypeMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseseasyinputmessagetypemessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageTypeMessage | OpenRouter Python SDK -'og:description': >- - OpenResponsesEasyInputMessageTypeMessage method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageTypeMessage%20-%20Python%20SDK&description=OpenResponsesEasyInputMessageTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseserrorevent.mdx b/client-sdks/python/components/openresponseserrorevent.mdx deleted file mode 100644 index f6e7d431..00000000 --- a/client-sdks/python/components/openresponseserrorevent.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesErrorEvent - Python SDK -description: OpenResponsesErrorEvent method reference -seoTitle: OpenResponsesErrorEvent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponseserrorevent' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesErrorEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesErrorEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesErrorEvent%20-%20Python%20SDK&description=OpenResponsesErrorEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when an error occurs during streaming - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesErrorEventType](/client-sdks/python/components/openresponseserroreventtype) | :heavy_check_mark: | N/A | -| `code` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `param` | *Nullable[str]* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseserroreventtype.mdx b/client-sdks/python/components/openresponseserroreventtype.mdx deleted file mode 100644 index 90196e34..00000000 --- a/client-sdks/python/components/openresponseserroreventtype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OpenResponsesErrorEventType - Python SDK -description: OpenResponsesErrorEventType method reference -seoTitle: OpenResponsesErrorEventType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponseserroreventtype' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesErrorEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesErrorEventType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesErrorEventType%20-%20Python%20SDK&description=OpenResponsesErrorEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `ERROR` | error | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesfunctioncalloutput.mdx b/client-sdks/python/components/openresponsesfunctioncalloutput.mdx deleted file mode 100644 index 4174ee47..00000000 --- a/client-sdks/python/components/openresponsesfunctioncalloutput.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenResponsesFunctionCallOutput - Python SDK -description: OpenResponsesFunctionCallOutput method reference -seoTitle: OpenResponsesFunctionCallOutput | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesfunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionCallOutput | OpenRouter Python SDK -'og:description': >- - OpenResponsesFunctionCallOutput method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionCallOutput%20-%20Python%20SDK&description=OpenResponsesFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The output from a function call execution - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesFunctionCallOutputType](/client-sdks/python/components/openresponsesfunctioncalloutputtype) | :heavy_check_mark: | N/A | | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `output` | *str* | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesfunctioncalloutputtype.mdx b/client-sdks/python/components/openresponsesfunctioncalloutputtype.mdx deleted file mode 100644 index 7cfa46b4..00000000 --- a/client-sdks/python/components/openresponsesfunctioncalloutputtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesFunctionCallOutputType - Python SDK -description: OpenResponsesFunctionCallOutputType method reference -seoTitle: OpenResponsesFunctionCallOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesfunctioncalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionCallOutputType | OpenRouter Python SDK -'og:description': >- - OpenResponsesFunctionCallOutputType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionCallOutputType%20-%20Python%20SDK&description=OpenResponsesFunctionCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `FUNCTION_CALL_OUTPUT` | function_call_output | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesfunctiontoolcall.mdx b/client-sdks/python/components/openresponsesfunctiontoolcall.mdx deleted file mode 100644 index c7a18031..00000000 --- a/client-sdks/python/components/openresponsesfunctiontoolcall.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesFunctionToolCall - Python SDK -description: OpenResponsesFunctionToolCall method reference -seoTitle: OpenResponsesFunctionToolCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesfunctiontoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionToolCall | OpenRouter Python SDK -'og:description': >- - OpenResponsesFunctionToolCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionToolCall%20-%20Python%20SDK&description=OpenResponsesFunctionToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -A function call initiated by the model - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesFunctionToolCallType](/client-sdks/python/components/openresponsesfunctiontoolcalltype) | :heavy_check_mark: | N/A | | -| `call_id` | *str* | :heavy_check_mark: | N/A | | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `arguments` | *str* | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [OptionalNullable[components.ToolCallStatus]](../components/toolcallstatus.md) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesfunctiontoolcalltype.mdx b/client-sdks/python/components/openresponsesfunctiontoolcalltype.mdx deleted file mode 100644 index 03b64931..00000000 --- a/client-sdks/python/components/openresponsesfunctiontoolcalltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesFunctionToolCallType - Python SDK -description: OpenResponsesFunctionToolCallType method reference -seoTitle: OpenResponsesFunctionToolCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesfunctiontoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionToolCallType | OpenRouter Python SDK -'og:description': >- - OpenResponsesFunctionToolCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionToolCallType%20-%20Python%20SDK&description=OpenResponsesFunctionToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallcompleted.mdx b/client-sdks/python/components/openresponsesimagegencallcompleted.mdx deleted file mode 100644 index d787edcc..00000000 --- a/client-sdks/python/components/openresponsesimagegencallcompleted.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesImageGenCallCompleted - Python SDK -description: OpenResponsesImageGenCallCompleted method reference -seoTitle: OpenResponsesImageGenCallCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallcompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallCompleted | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallCompleted%20-%20Python%20SDK&description=OpenResponsesImageGenCallCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call completed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesImageGenCallCompletedType](/client-sdks/python/components/openresponsesimagegencallcompletedtype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallcompletedtype.mdx b/client-sdks/python/components/openresponsesimagegencallcompletedtype.mdx deleted file mode 100644 index 6132d4c9..00000000 --- a/client-sdks/python/components/openresponsesimagegencallcompletedtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesImageGenCallCompletedType - Python SDK -description: OpenResponsesImageGenCallCompletedType method reference -seoTitle: OpenResponsesImageGenCallCompletedType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallcompletedtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallCompletedType | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallCompletedType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallCompletedType%20-%20Python%20SDK&description=OpenResponsesImageGenCallCompletedType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------------ | ------------------------------------------ | -| `RESPONSE_IMAGE_GENERATION_CALL_COMPLETED` | response.image_generation_call.completed | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallgenerating.mdx b/client-sdks/python/components/openresponsesimagegencallgenerating.mdx deleted file mode 100644 index 2b3bfdf1..00000000 --- a/client-sdks/python/components/openresponsesimagegencallgenerating.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesImageGenCallGenerating - Python SDK -description: OpenResponsesImageGenCallGenerating method reference -seoTitle: OpenResponsesImageGenCallGenerating | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallgenerating -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallGenerating | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallGenerating method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallGenerating%20-%20Python%20SDK&description=OpenResponsesImageGenCallGenerating%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call is generating - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesImageGenCallGeneratingType](/client-sdks/python/components/openresponsesimagegencallgeneratingtype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallgeneratingtype.mdx b/client-sdks/python/components/openresponsesimagegencallgeneratingtype.mdx deleted file mode 100644 index fcb2eea9..00000000 --- a/client-sdks/python/components/openresponsesimagegencallgeneratingtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesImageGenCallGeneratingType - Python SDK -description: OpenResponsesImageGenCallGeneratingType method reference -seoTitle: OpenResponsesImageGenCallGeneratingType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallgeneratingtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallGeneratingType | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallGeneratingType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallGeneratingType%20-%20Python%20SDK&description=OpenResponsesImageGenCallGeneratingType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------------------- | ------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_GENERATING` | response.image_generation_call.generating | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallinprogress.mdx b/client-sdks/python/components/openresponsesimagegencallinprogress.mdx deleted file mode 100644 index 25fabd0b..00000000 --- a/client-sdks/python/components/openresponsesimagegencallinprogress.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesImageGenCallInProgress - Python SDK -description: OpenResponsesImageGenCallInProgress method reference -seoTitle: OpenResponsesImageGenCallInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallInProgress | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallInProgress%20-%20Python%20SDK&description=OpenResponsesImageGenCallInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call in progress - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesImageGenCallInProgressType](/client-sdks/python/components/openresponsesimagegencallinprogresstype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallinprogresstype.mdx b/client-sdks/python/components/openresponsesimagegencallinprogresstype.mdx deleted file mode 100644 index bf7ea927..00000000 --- a/client-sdks/python/components/openresponsesimagegencallinprogresstype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesImageGenCallInProgressType - Python SDK -description: OpenResponsesImageGenCallInProgressType method reference -seoTitle: OpenResponsesImageGenCallInProgressType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallinprogresstype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallInProgressType | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallInProgressType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallInProgressType%20-%20Python%20SDK&description=OpenResponsesImageGenCallInProgressType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------------- | -------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_IN_PROGRESS` | response.image_generation_call.in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallpartialimage.mdx b/client-sdks/python/components/openresponsesimagegencallpartialimage.mdx deleted file mode 100644 index 89134d5f..00000000 --- a/client-sdks/python/components/openresponsesimagegencallpartialimage.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesImageGenCallPartialImage - Python SDK -description: OpenResponsesImageGenCallPartialImage method reference -seoTitle: OpenResponsesImageGenCallPartialImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallpartialimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallPartialImage | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallPartialImage method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallPartialImage%20-%20Python%20SDK&description=OpenResponsesImageGenCallPartialImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image generation call with partial image - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesImageGenCallPartialImageType](/client-sdks/python/components/openresponsesimagegencallpartialimagetype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | -| `partial_image_b64` | *str* | :heavy_check_mark: | N/A | -| `partial_image_index` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesimagegencallpartialimagetype.mdx b/client-sdks/python/components/openresponsesimagegencallpartialimagetype.mdx deleted file mode 100644 index a9869ca5..00000000 --- a/client-sdks/python/components/openresponsesimagegencallpartialimagetype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesImageGenCallPartialImageType - Python SDK -description: OpenResponsesImageGenCallPartialImageType method reference -seoTitle: OpenResponsesImageGenCallPartialImageType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesimagegencallpartialimagetype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallPartialImageType | OpenRouter Python SDK -'og:description': >- - OpenResponsesImageGenCallPartialImageType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallPartialImageType%20-%20Python%20SDK&description=OpenResponsesImageGenCallPartialImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------------------------- | ---------------------------------------------- | -| `RESPONSE_IMAGE_GENERATION_CALL_PARTIAL_IMAGE` | response.image_generation_call.partial_image | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinput.mdx b/client-sdks/python/components/openresponsesinput.mdx deleted file mode 100644 index 9b91baad..00000000 --- a/client-sdks/python/components/openresponsesinput.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesInput - Python SDK -description: OpenResponsesInput method reference -seoTitle: OpenResponsesInput | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesinput' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInput | OpenRouter Python SDK -'og:description': >- - OpenResponsesInput method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInput%20-%20Python%20SDK&description=OpenResponsesInput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Input for a response request - can be a string or array of items - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.OpenResponsesInput1]` - -```python lines -value: List[components.OpenResponsesInput1] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinput1.mdx b/client-sdks/python/components/openresponsesinput1.mdx deleted file mode 100644 index 8966bece..00000000 --- a/client-sdks/python/components/openresponsesinput1.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: OpenResponsesInput1 - Python SDK -description: OpenResponsesInput1 method reference -seoTitle: OpenResponsesInput1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesinput1' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInput1 | OpenRouter Python SDK -'og:description': >- - OpenResponsesInput1 method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInput1%20-%20Python%20SDK&description=OpenResponsesInput1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesReasoning` - -```python lines -value: components.OpenResponsesReasoning = /* values here */ -``` - -### `components.OpenResponsesEasyInputMessage` - -```python lines -value: components.OpenResponsesEasyInputMessage = /* values here */ -``` - -### `components.OpenResponsesInputMessageItem` - -```python lines -value: components.OpenResponsesInputMessageItem = /* values here */ -``` - -### `components.OpenResponsesFunctionToolCall` - -```python lines -value: components.OpenResponsesFunctionToolCall = /* values here */ -``` - -### `components.OpenResponsesFunctionCallOutput` - -```python lines -value: components.OpenResponsesFunctionCallOutput = /* values here */ -``` - -### `components.ResponsesOutputMessage` - -```python lines -value: components.ResponsesOutputMessage = /* values here */ -``` - -### `components.ResponsesOutputItemReasoning` - -```python lines -value: components.ResponsesOutputItemReasoning = /* values here */ -``` - -### `components.ResponsesOutputItemFunctionCall` - -```python lines -value: components.ResponsesOutputItemFunctionCall = /* values here */ -``` - -### `components.ResponsesWebSearchCallOutput` - -```python lines -value: components.ResponsesWebSearchCallOutput = /* values here */ -``` - -### `components.ResponsesOutputItemFileSearchCall` - -```python lines -value: components.ResponsesOutputItemFileSearchCall = /* values here */ -``` - -### `components.ResponsesImageGenerationCall` - -```python lines -value: components.ResponsesImageGenerationCall = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitem.mdx b/client-sdks/python/components/openresponsesinputmessageitem.mdx deleted file mode 100644 index 2afd2fcd..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitem.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OpenResponsesInputMessageItem - Python SDK -description: OpenResponsesInputMessageItem method reference -seoTitle: OpenResponsesInputMessageItem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItem | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItem method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItem%20-%20Python%20SDK&description=OpenResponsesInputMessageItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `type` | [Optional[components.OpenResponsesInputMessageItemTypeMessage]](../components/openresponsesinputmessageitemtypemessage.md) | :heavy_minus_sign: | N/A | -| `role` | [components.OpenResponsesInputMessageItemRoleUnion](/client-sdks/python/components/openresponsesinputmessageitemroleunion) | :heavy_check_mark: | N/A | -| `content` | List[[components.OpenResponsesInputMessageItemContentUnion](/client-sdks/python/components/openresponsesinputmessageitemcontentunion)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemcontentinputimage.mdx b/client-sdks/python/components/openresponsesinputmessageitemcontentinputimage.mdx deleted file mode 100644 index 54b11252..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemcontentinputimage.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesInputMessageItemContentInputImage - Python SDK -description: OpenResponsesInputMessageItemContentInputImage method reference -seoTitle: OpenResponsesInputMessageItemContentInputImage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemcontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemContentInputImage | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemContentInputImage method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemContentInputImage%20-%20Python%20SDK&description=OpenResponsesInputMessageItemContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesInputMessageItemContentType](/client-sdks/python/components/openresponsesinputmessageitemcontenttype) | :heavy_check_mark: | N/A | -| `detail` | [components.OpenResponsesInputMessageItemDetail](/client-sdks/python/components/openresponsesinputmessageitemdetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemcontenttype.mdx b/client-sdks/python/components/openresponsesinputmessageitemcontenttype.mdx deleted file mode 100644 index 0b61bb4a..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemcontenttype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesInputMessageItemContentType - Python SDK -description: OpenResponsesInputMessageItemContentType method reference -seoTitle: OpenResponsesInputMessageItemContentType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemcontenttype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemContentType | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemContentType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemContentType%20-%20Python%20SDK&description=OpenResponsesInputMessageItemContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemcontentunion.mdx b/client-sdks/python/components/openresponsesinputmessageitemcontentunion.mdx deleted file mode 100644 index 81674c66..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemcontentunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesInputMessageItemContentUnion - Python SDK -description: OpenResponsesInputMessageItemContentUnion method reference -seoTitle: OpenResponsesInputMessageItemContentUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemcontentunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemContentUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemContentUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemContentUnion%20-%20Python%20SDK&description=OpenResponsesInputMessageItemContentUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseInputText` - -```python lines -value: components.ResponseInputText = /* values here */ -``` - -### `components.OpenResponsesInputMessageItemContentInputImage` - -```python lines -value: components.OpenResponsesInputMessageItemContentInputImage = /* values here */ -``` - -### `components.ResponseInputFile` - -```python lines -value: components.ResponseInputFile = /* values here */ -``` - -### `components.ResponseInputAudio` - -```python lines -value: components.ResponseInputAudio = /* values here */ -``` - -### `components.ResponseInputVideo` - -```python lines -value: components.ResponseInputVideo = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemdetail.mdx b/client-sdks/python/components/openresponsesinputmessageitemdetail.mdx deleted file mode 100644 index 8b1e8270..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemdetail.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesInputMessageItemDetail - Python SDK -description: OpenResponsesInputMessageItemDetail method reference -seoTitle: OpenResponsesInputMessageItemDetail | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemdetail -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemDetail | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemDetail method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemDetail%20-%20Python%20SDK&description=OpenResponsesInputMessageItemDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemroledeveloper.mdx b/client-sdks/python/components/openresponsesinputmessageitemroledeveloper.mdx deleted file mode 100644 index 9682aa2f..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleDeveloper - Python SDK -description: OpenResponsesInputMessageItemRoleDeveloper method reference -seoTitle: OpenResponsesInputMessageItemRoleDeveloper | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleDeveloper | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemRoleDeveloper method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleDeveloper%20-%20Python%20SDK&description=OpenResponsesInputMessageItemRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `DEVELOPER` | developer | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemrolesystem.mdx b/client-sdks/python/components/openresponsesinputmessageitemrolesystem.mdx deleted file mode 100644 index c4f54d91..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemrolesystem.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleSystem - Python SDK -description: OpenResponsesInputMessageItemRoleSystem method reference -seoTitle: OpenResponsesInputMessageItemRoleSystem | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleSystem | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemRoleSystem method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleSystem%20-%20Python%20SDK&description=OpenResponsesInputMessageItemRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `SYSTEM` | system | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemroleunion.mdx b/client-sdks/python/components/openresponsesinputmessageitemroleunion.mdx deleted file mode 100644 index 3fe71afd..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemroleunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleUnion - Python SDK -description: OpenResponsesInputMessageItemRoleUnion method reference -seoTitle: OpenResponsesInputMessageItemRoleUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemRoleUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleUnion%20-%20Python%20SDK&description=OpenResponsesInputMessageItemRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesInputMessageItemRoleUser` - -```python lines -value: components.OpenResponsesInputMessageItemRoleUser = /* values here */ -``` - -### `components.OpenResponsesInputMessageItemRoleSystem` - -```python lines -value: components.OpenResponsesInputMessageItemRoleSystem = /* values here */ -``` - -### `components.OpenResponsesInputMessageItemRoleDeveloper` - -```python lines -value: components.OpenResponsesInputMessageItemRoleDeveloper = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemroleuser.mdx b/client-sdks/python/components/openresponsesinputmessageitemroleuser.mdx deleted file mode 100644 index cdbc4a36..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemroleuser.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleUser - Python SDK -description: OpenResponsesInputMessageItemRoleUser method reference -seoTitle: OpenResponsesInputMessageItemRoleUser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleUser | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemRoleUser method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleUser%20-%20Python%20SDK&description=OpenResponsesInputMessageItemRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `USER` | user | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesinputmessageitemtypemessage.mdx b/client-sdks/python/components/openresponsesinputmessageitemtypemessage.mdx deleted file mode 100644 index 3568dc6e..00000000 --- a/client-sdks/python/components/openresponsesinputmessageitemtypemessage.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesInputMessageItemTypeMessage - Python SDK -description: OpenResponsesInputMessageItemTypeMessage method reference -seoTitle: OpenResponsesInputMessageItemTypeMessage | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesinputmessageitemtypemessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemTypeMessage | OpenRouter Python SDK -'og:description': >- - OpenResponsesInputMessageItemTypeMessage method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemTypeMessage%20-%20Python%20SDK&description=OpenResponsesInputMessageItemTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseslogprobs.mdx b/client-sdks/python/components/openresponseslogprobs.mdx deleted file mode 100644 index 1add6397..00000000 --- a/client-sdks/python/components/openresponseslogprobs.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OpenResponsesLogProbs - Python SDK -description: OpenResponsesLogProbs method reference -seoTitle: OpenResponsesLogProbs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponseslogprobs' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesLogProbs | OpenRouter Python SDK -'og:description': >- - OpenResponsesLogProbs method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesLogProbs%20-%20Python%20SDK&description=OpenResponsesLogProbs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Log probability information for a token - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `logprob` | *float* | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | N/A | -| `top_logprobs` | List[[components.OpenResponsesTopLogprobs](/client-sdks/python/components/openresponsestoplogprobs)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesnonstreamingresponse.mdx b/client-sdks/python/components/openresponsesnonstreamingresponse.mdx deleted file mode 100644 index 969f5290..00000000 --- a/client-sdks/python/components/openresponsesnonstreamingresponse.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponse - Python SDK -description: OpenResponsesNonStreamingResponse method reference -seoTitle: OpenResponsesNonStreamingResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesnonstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponse | OpenRouter Python SDK -'og:description': >- - OpenResponsesNonStreamingResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponse%20-%20Python%20SDK&description=OpenResponsesNonStreamingResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Complete non-streaming response from the Responses API - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `object` | [components.Object](/client-sdks/python/components/object) | :heavy_check_mark: | N/A | | -| `created_at` | *float* | :heavy_check_mark: | N/A | | -| `model` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.OpenAIResponsesResponseStatus](/client-sdks/python/api-reference/components/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | | -| `completed_at` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `output` | List[[components.ResponsesOutputItem](/client-sdks/python/components/responsesoutputitem)] | :heavy_check_mark: | N/A | | -| `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `output_text` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `error` | [Nullable[components.ResponsesErrorField]](../components/responseserrorfield.md) | :heavy_check_mark: | Error information returned from the API | `{"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."}` | -| `incomplete_details` | [Nullable[components.OpenAIResponsesIncompleteDetails]](../components/openairesponsesincompletedetails.md) | :heavy_check_mark: | N/A | | -| `usage` | [OptionalNullable[components.OpenResponsesUsage]](../components/openresponsesusage.md) | :heavy_minus_sign: | Token usage information for the response | `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"cost": 0.0012,
"cost_details": `{"upstream_inference_cost": null,"upstream_inference_input_cost": 0.0008,"upstream_inference_output_cost": 0.0004}`
} | -| `max_tool_calls` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `max_output_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `temperature` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `top_p` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `presence_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `frequency_penalty` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `instructions` | [Nullable[components.OpenAIResponsesInputUnion]](../components/openairesponsesinputunion.md) | :heavy_check_mark: | N/A | | -| `metadata` | Dict[str, *str*] | :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. | `{"user_id": "123","session_id": "abc-def-ghi"}` | -| `tools` | List[[components.OpenResponsesNonStreamingResponseToolUnion](/client-sdks/python/components/openresponsesnonstreamingresponsetoolunion)] | :heavy_check_mark: | N/A | | -| `tool_choice` | [components.OpenAIResponsesToolChoiceUnion](/client-sdks/python/api-reference/components/openairesponsestoolchoiceunion) | :heavy_check_mark: | N/A | | -| `parallel_tool_calls` | *bool* | :heavy_check_mark: | N/A | | -| `prompt` | [OptionalNullable[components.OpenAIResponsesPrompt]](../components/openairesponsesprompt.md) | :heavy_minus_sign: | N/A | | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `reasoning` | [OptionalNullable[components.OpenAIResponsesReasoningConfig]](../components/openairesponsesreasoningconfig.md) | :heavy_minus_sign: | N/A | | -| `service_tier` | [OptionalNullable[components.OpenAIResponsesServiceTier]](../components/openairesponsesservicetier.md) | :heavy_minus_sign: | N/A | | -| `store` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `truncation` | [OptionalNullable[components.OpenAIResponsesTruncation]](../components/openairesponsestruncation.md) | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.ResponseTextConfig]](../components/responsetextconfig.md) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
} | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesnonstreamingresponsetoolfunction.mdx b/client-sdks/python/components/openresponsesnonstreamingresponsetoolfunction.mdx deleted file mode 100644 index d8c896c1..00000000 --- a/client-sdks/python/components/openresponsesnonstreamingresponsetoolfunction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponseToolFunction - Python SDK -description: OpenResponsesNonStreamingResponseToolFunction method reference -seoTitle: OpenResponsesNonStreamingResponseToolFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesnonstreamingresponsetoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponseToolFunction | OpenRouter Python SDK -'og:description': >- - OpenResponsesNonStreamingResponseToolFunction method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponseToolFunction%20-%20Python%20SDK&description=OpenResponsesNonStreamingResponseToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesNonStreamingResponseType](/client-sdks/python/components/openresponsesnonstreamingresponsetype) | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesnonstreamingresponsetoolunion.mdx b/client-sdks/python/components/openresponsesnonstreamingresponsetoolunion.mdx deleted file mode 100644 index df136515..00000000 --- a/client-sdks/python/components/openresponsesnonstreamingresponsetoolunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponseToolUnion - Python SDK -description: OpenResponsesNonStreamingResponseToolUnion method reference -seoTitle: OpenResponsesNonStreamingResponseToolUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesnonstreamingresponsetoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponseToolUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesNonStreamingResponseToolUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponseToolUnion%20-%20Python%20SDK&description=OpenResponsesNonStreamingResponseToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesNonStreamingResponseToolFunction` - -```python lines -value: components.OpenResponsesNonStreamingResponseToolFunction = /* values here */ -``` - -### `components.OpenResponsesWebSearchPreviewTool` - -```python lines -value: components.OpenResponsesWebSearchPreviewTool = /* values here */ -``` - -### `components.OpenResponsesWebSearchPreview20250311Tool` - -```python lines -value: components.OpenResponsesWebSearchPreview20250311Tool = /* values here */ -``` - -### `components.OpenResponsesWebSearchTool` - -```python lines -value: components.OpenResponsesWebSearchTool = /* values here */ -``` - -### `components.OpenResponsesWebSearch20250826Tool` - -```python lines -value: components.OpenResponsesWebSearch20250826Tool = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesnonstreamingresponsetype.mdx b/client-sdks/python/components/openresponsesnonstreamingresponsetype.mdx deleted file mode 100644 index b78efb6d..00000000 --- a/client-sdks/python/components/openresponsesnonstreamingresponsetype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponseType - Python SDK -description: OpenResponsesNonStreamingResponseType method reference -seoTitle: OpenResponsesNonStreamingResponseType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesnonstreamingresponsetype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponseType | OpenRouter Python SDK -'og:description': >- - OpenResponsesNonStreamingResponseType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponseType%20-%20Python%20SDK&description=OpenResponsesNonStreamingResponseType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoning.mdx b/client-sdks/python/components/openresponsesreasoning.mdx deleted file mode 100644 index c6d290e4..00000000 --- a/client-sdks/python/components/openresponsesreasoning.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesReasoning - Python SDK -description: OpenResponsesReasoning method reference -seoTitle: OpenResponsesReasoning | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesreasoning' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoning | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoning method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoning%20-%20Python%20SDK&description=OpenResponsesReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Reasoning output item with signature and format extensions - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesReasoningType](/client-sdks/python/components/openresponsesreasoningtype) | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `content` | List[[components.ReasoningTextContent](/client-sdks/python/api-reference/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | -| `summary` | List[[components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext)] | :heavy_check_mark: | N/A | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `status` | [Optional[components.OpenResponsesReasoningStatusUnion]](../components/openresponsesreasoningstatusunion.md) | :heavy_minus_sign: | N/A | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `format_` | [OptionalNullable[components.OpenResponsesReasoningFormat]](../components/openresponsesreasoningformat.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningconfig.mdx b/client-sdks/python/components/openresponsesreasoningconfig.mdx deleted file mode 100644 index 736dbc7e..00000000 --- a/client-sdks/python/components/openresponsesreasoningconfig.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesReasoningConfig - Python SDK -description: OpenResponsesReasoningConfig method reference -seoTitle: OpenResponsesReasoningConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesreasoningconfig' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningConfig | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningConfig%20-%20Python%20SDK&description=OpenResponsesReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Configuration for reasoning mode in the response - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.OpenAIResponsesReasoningEffort]](../components/openairesponsesreasoningeffort.md) | :heavy_minus_sign: | N/A | -| `summary` | [Optional[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.md) | :heavy_minus_sign: | N/A | -| `max_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | -| `enabled` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningdeltaevent.mdx b/client-sdks/python/components/openresponsesreasoningdeltaevent.mdx deleted file mode 100644 index 3d0c9af2..00000000 --- a/client-sdks/python/components/openresponsesreasoningdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningDeltaEvent - Python SDK -description: OpenResponsesReasoningDeltaEvent method reference -seoTitle: OpenResponsesReasoningDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDeltaEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningDeltaEvent method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDeltaEvent%20-%20Python%20SDK&description=OpenResponsesReasoningDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesReasoningDeltaEventType](/client-sdks/python/components/openresponsesreasoningdeltaeventtype) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningdeltaeventtype.mdx b/client-sdks/python/components/openresponsesreasoningdeltaeventtype.mdx deleted file mode 100644 index 59db6441..00000000 --- a/client-sdks/python/components/openresponsesreasoningdeltaeventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningDeltaEventType - Python SDK -description: OpenResponsesReasoningDeltaEventType method reference -seoTitle: OpenResponsesReasoningDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDeltaEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningDeltaEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDeltaEventType%20-%20Python%20SDK&description=OpenResponsesReasoningDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `RESPONSE_REASONING_TEXT_DELTA` | response.reasoning_text.delta | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningdoneevent.mdx b/client-sdks/python/components/openresponsesreasoningdoneevent.mdx deleted file mode 100644 index 7b2a30ef..00000000 --- a/client-sdks/python/components/openresponsesreasoningdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningDoneEvent - Python SDK -description: OpenResponsesReasoningDoneEvent method reference -seoTitle: OpenResponsesReasoningDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningdoneevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDoneEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningDoneEvent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDoneEvent%20-%20Python%20SDK&description=OpenResponsesReasoningDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesReasoningDoneEventType](/client-sdks/python/components/openresponsesreasoningdoneeventtype) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningdoneeventtype.mdx b/client-sdks/python/components/openresponsesreasoningdoneeventtype.mdx deleted file mode 100644 index c0b8f731..00000000 --- a/client-sdks/python/components/openresponsesreasoningdoneeventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningDoneEventType - Python SDK -description: OpenResponsesReasoningDoneEventType method reference -seoTitle: OpenResponsesReasoningDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDoneEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningDoneEventType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDoneEventType%20-%20Python%20SDK&description=OpenResponsesReasoningDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------ | ------------------------------ | -| `RESPONSE_REASONING_TEXT_DONE` | response.reasoning_text.done | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningformat.mdx b/client-sdks/python/components/openresponsesreasoningformat.mdx deleted file mode 100644 index c7b62c93..00000000 --- a/client-sdks/python/components/openresponsesreasoningformat.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesReasoningFormat - Python SDK -description: OpenResponsesReasoningFormat method reference -seoTitle: OpenResponsesReasoningFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesreasoningformat' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningFormat | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningFormat method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningFormat%20-%20Python%20SDK&description=OpenResponsesReasoningFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `UNKNOWN` | unknown | -| `OPENAI_RESPONSES_V1` | openai-responses-v1 | -| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 | -| `XAI_RESPONSES_V1` | xai-responses-v1 | -| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 | -| `GOOGLE_GEMINI_V1` | google-gemini-v1 | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningstatuscompleted.mdx b/client-sdks/python/components/openresponsesreasoningstatuscompleted.mdx deleted file mode 100644 index d9c32aad..00000000 --- a/client-sdks/python/components/openresponsesreasoningstatuscompleted.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningStatusCompleted - Python SDK -description: OpenResponsesReasoningStatusCompleted method reference -seoTitle: OpenResponsesReasoningStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusCompleted | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningStatusCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusCompleted%20-%20Python%20SDK&description=OpenResponsesReasoningStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningstatusincomplete.mdx b/client-sdks/python/components/openresponsesreasoningstatusincomplete.mdx deleted file mode 100644 index 61c0f4c6..00000000 --- a/client-sdks/python/components/openresponsesreasoningstatusincomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningStatusIncomplete - Python SDK -description: OpenResponsesReasoningStatusIncomplete method reference -seoTitle: OpenResponsesReasoningStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningStatusIncomplete method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusIncomplete%20-%20Python%20SDK&description=OpenResponsesReasoningStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningstatusinprogress.mdx b/client-sdks/python/components/openresponsesreasoningstatusinprogress.mdx deleted file mode 100644 index 012cf6c1..00000000 --- a/client-sdks/python/components/openresponsesreasoningstatusinprogress.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningStatusInProgress - Python SDK -description: OpenResponsesReasoningStatusInProgress method reference -seoTitle: OpenResponsesReasoningStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusInProgress | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningStatusInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusInProgress%20-%20Python%20SDK&description=OpenResponsesReasoningStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningstatusunion.mdx b/client-sdks/python/components/openresponsesreasoningstatusunion.mdx deleted file mode 100644 index a4323dcd..00000000 --- a/client-sdks/python/components/openresponsesreasoningstatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesReasoningStatusUnion - Python SDK -description: OpenResponsesReasoningStatusUnion method reference -seoTitle: OpenResponsesReasoningStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningStatusUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusUnion%20-%20Python%20SDK&description=OpenResponsesReasoningStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesReasoningStatusCompleted` - -```python lines -value: components.OpenResponsesReasoningStatusCompleted = /* values here */ -``` - -### `components.OpenResponsesReasoningStatusIncomplete` - -```python lines -value: components.OpenResponsesReasoningStatusIncomplete = /* values here */ -``` - -### `components.OpenResponsesReasoningStatusInProgress` - -```python lines -value: components.OpenResponsesReasoningStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarypartaddedevent.mdx b/client-sdks/python/components/openresponsesreasoningsummarypartaddedevent.mdx deleted file mode 100644 index 69294b75..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarypartaddedevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryPartAddedEvent - Python SDK -description: OpenResponsesReasoningSummaryPartAddedEvent method reference -seoTitle: OpenResponsesReasoningSummaryPartAddedEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarypartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryPartAddedEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryPartAddedEvent method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryPartAddedEvent%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryPartAddedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is added - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesReasoningSummaryPartAddedEventType](/client-sdks/python/components/openresponsesreasoningsummarypartaddedeventtype) | :heavy_check_mark: | N/A | | -| `output_index` | *float* | :heavy_check_mark: | N/A | | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `summary_index` | *float* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"type": "summary_text","text": "Analyzed the problem using first principles"}` | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarypartaddedeventtype.mdx b/client-sdks/python/components/openresponsesreasoningsummarypartaddedeventtype.mdx deleted file mode 100644 index 5d9a3bd6..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarypartaddedeventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryPartAddedEventType - Python SDK -description: OpenResponsesReasoningSummaryPartAddedEventType method reference -seoTitle: OpenResponsesReasoningSummaryPartAddedEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarypartaddedeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryPartAddedEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryPartAddedEventType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryPartAddedEventType%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryPartAddedEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_PART_ADDED` | response.reasoning_summary_part.added | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarytextdeltaevent.mdx b/client-sdks/python/components/openresponsesreasoningsummarytextdeltaevent.mdx deleted file mode 100644 index 006a3639..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarytextdeltaevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDeltaEvent - Python SDK -description: OpenResponsesReasoningSummaryTextDeltaEvent method reference -seoTitle: OpenResponsesReasoningSummaryTextDeltaEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarytextdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDeltaEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDeltaEvent method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDeltaEvent%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryTextDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesReasoningSummaryTextDeltaEventType](/client-sdks/python/components/openresponsesreasoningsummarytextdeltaeventtype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `summary_index` | *float* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarytextdeltaeventtype.mdx b/client-sdks/python/components/openresponsesreasoningsummarytextdeltaeventtype.mdx deleted file mode 100644 index 1c1e45cb..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarytextdeltaeventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDeltaEventType - Python SDK -description: OpenResponsesReasoningSummaryTextDeltaEventType method reference -seoTitle: OpenResponsesReasoningSummaryTextDeltaEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarytextdeltaeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDeltaEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDeltaEventType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDeltaEventType%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryTextDeltaEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_TEXT_DELTA` | response.reasoning_summary_text.delta | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarytextdoneevent.mdx b/client-sdks/python/components/openresponsesreasoningsummarytextdoneevent.mdx deleted file mode 100644 index fd2da66a..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarytextdoneevent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDoneEvent - Python SDK -description: OpenResponsesReasoningSummaryTextDoneEvent method reference -seoTitle: OpenResponsesReasoningSummaryTextDoneEvent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarytextdoneevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDoneEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDoneEvent method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDoneEvent%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryTextDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesReasoningSummaryTextDoneEventType](/client-sdks/python/components/openresponsesreasoningsummarytextdoneeventtype) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `summary_index` | *float* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningsummarytextdoneeventtype.mdx b/client-sdks/python/components/openresponsesreasoningsummarytextdoneeventtype.mdx deleted file mode 100644 index 184d60c1..00000000 --- a/client-sdks/python/components/openresponsesreasoningsummarytextdoneeventtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDoneEventType - Python SDK -description: OpenResponsesReasoningSummaryTextDoneEventType method reference -seoTitle: OpenResponsesReasoningSummaryTextDoneEventType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesreasoningsummarytextdoneeventtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDoneEventType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDoneEventType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDoneEventType%20-%20Python%20SDK&description=OpenResponsesReasoningSummaryTextDoneEventType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_TEXT_DONE` | response.reasoning_summary_text.done | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesreasoningtype.mdx b/client-sdks/python/components/openresponsesreasoningtype.mdx deleted file mode 100644 index bc984772..00000000 --- a/client-sdks/python/components/openresponsesreasoningtype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OpenResponsesReasoningType - Python SDK -description: OpenResponsesReasoningType method reference -seoTitle: OpenResponsesReasoningType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesreasoningtype' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningType | OpenRouter Python SDK -'og:description': >- - OpenResponsesReasoningType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningType%20-%20Python%20SDK&description=OpenResponsesReasoningType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `REASONING` | reasoning | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequest.mdx b/client-sdks/python/components/openresponsesrequest.mdx deleted file mode 100644 index 0c6aeda8..00000000 --- a/client-sdks/python/components/openresponsesrequest.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: OpenResponsesRequest - Python SDK -description: OpenResponsesRequest method reference -seoTitle: OpenResponsesRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequest' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequest | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequest%20-%20Python%20SDK&description=OpenResponsesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request schema for Responses endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | [Optional[components.OpenResponsesInput]](../components/openresponsesinput.md) | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
`{"role": "user","content": "What is the weather today?"}`
] | -| `instructions` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `metadata` | Dict[str, *str*] | :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. | `{"user_id": "123","session_id": "abc-def-ghi"}` | -| `tools` | List[[components.OpenResponsesRequestToolUnion](/client-sdks/python/components/openresponsesrequesttoolunion)] | :heavy_minus_sign: | N/A | | -| `tool_choice` | [Optional[components.OpenAIResponsesToolChoiceUnion]](../components/openairesponsestoolchoiceunion.md) | :heavy_minus_sign: | N/A | | -| `parallel_tool_calls` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `model` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `models` | List[*str*] | :heavy_minus_sign: | N/A | | -| `text` | [Optional[components.OpenResponsesResponseText]](../components/openresponsesresponsetext.md) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
} | -| `reasoning` | [OptionalNullable[components.OpenResponsesReasoningConfig]](../components/openresponsesreasoningconfig.md) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"summary": "auto","enabled": true}` | -| `max_output_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `temperature` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `top_p` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `top_logprobs` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `max_tool_calls` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | | -| `presence_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `frequency_penalty` | *OptionalNullable[float]* | :heavy_minus_sign: | N/A | | -| `top_k` | *Optional[float]* | :heavy_minus_sign: | N/A | | -| `image_config` | Dict[str, [components.OpenResponsesRequestImageConfig](/client-sdks/python/components/openresponsesrequestimageconfig)] | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/features/multimodal/image-generation for more details. | `{"aspect_ratio": "16:9"}` | -| `modalities` | List[[components.ResponsesOutputModality](/client-sdks/python/components/responsesoutputmodality)] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `prompt_cache_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `previous_response_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `prompt` | [OptionalNullable[components.OpenAIResponsesPrompt]](../components/openairesponsesprompt.md) | :heavy_minus_sign: | N/A | | -| `include` | List[[components.OpenAIResponsesIncludable](/client-sdks/python/components/openairesponsesincludable)] | :heavy_minus_sign: | N/A | | -| `background` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | | -| `safety_identifier` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `store` | *Optional[Literal[False]]* | :heavy_minus_sign: | N/A | | -| `service_tier` | [Optional[components.ServiceTier]](../components/servicetier.md) | :heavy_minus_sign: | N/A | | -| `truncation` | [OptionalNullable[components.Truncation]](../components/truncation.md) | :heavy_minus_sign: | N/A | auto | -| `stream` | *Optional[bool]* | :heavy_minus_sign: | N/A | | -| `provider` | [OptionalNullable[components.OpenResponsesRequestProvider]](../components/openresponsesrequestprovider.md) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | | -| `plugins` | List[[components.OpenResponsesRequestPluginUnion](/client-sdks/python/components/openresponsesrequestpluginunion)] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `user` | *Optional[str]* | :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 128 characters. | | -| `session_id` | *Optional[str]* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestignore.mdx b/client-sdks/python/components/openresponsesrequestignore.mdx deleted file mode 100644 index c9dc0568..00000000 --- a/client-sdks/python/components/openresponsesrequestignore.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestIgnore - Python SDK -description: OpenResponsesRequestIgnore method reference -seoTitle: OpenResponsesRequestIgnore | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestignore' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestIgnore | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestIgnore method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestIgnore%20-%20Python%20SDK&description=OpenResponsesRequestIgnore%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestimageconfig.mdx b/client-sdks/python/components/openresponsesrequestimageconfig.mdx deleted file mode 100644 index 38384d63..00000000 --- a/client-sdks/python/components/openresponsesrequestimageconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesRequestImageConfig - Python SDK -description: OpenResponsesRequestImageConfig method reference -seoTitle: OpenResponsesRequestImageConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestimageconfig -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestImageConfig | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestImageConfig method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestImageConfig%20-%20Python%20SDK&description=OpenResponsesRequestImageConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `float` - -```python lines -value: float = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestmaxprice.mdx b/client-sdks/python/components/openresponsesrequestmaxprice.mdx deleted file mode 100644 index 51db1325..00000000 --- a/client-sdks/python/components/openresponsesrequestmaxprice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesRequestMaxPrice - Python SDK -description: OpenResponsesRequestMaxPrice method reference -seoTitle: OpenResponsesRequestMaxPrice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestMaxPrice | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestMaxPrice method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestMaxPrice%20-%20Python%20SDK&description=OpenResponsesRequestMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `completion` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestonly.mdx b/client-sdks/python/components/openresponsesrequestonly.mdx deleted file mode 100644 index d17004ce..00000000 --- a/client-sdks/python/components/openresponsesrequestonly.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestOnly - Python SDK -description: OpenResponsesRequestOnly method reference -seoTitle: OpenResponsesRequestOnly | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestonly' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestOnly | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestOnly method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestOnly%20-%20Python%20SDK&description=OpenResponsesRequestOnly%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestorder.mdx b/client-sdks/python/components/openresponsesrequestorder.mdx deleted file mode 100644 index c1d97133..00000000 --- a/client-sdks/python/components/openresponsesrequestorder.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestOrder - Python SDK -description: OpenResponsesRequestOrder method reference -seoTitle: OpenResponsesRequestOrder | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestorder' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestOrder | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestOrder method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestOrder%20-%20Python%20SDK&description=OpenResponsesRequestOrder%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginautorouter.mdx b/client-sdks/python/components/openresponsesrequestpluginautorouter.mdx deleted file mode 100644 index 79412292..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginautorouter.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesRequestPluginAutoRouter - Python SDK -description: OpenResponsesRequestPluginAutoRouter method reference -seoTitle: OpenResponsesRequestPluginAutoRouter | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginautorouter -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginAutoRouter | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginAutoRouter method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginAutoRouter%20-%20Python%20SDK&description=OpenResponsesRequestPluginAutoRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | [components.IDAutoRouter](/client-sdks/python/components/idautorouter) | :heavy_check_mark: | N/A | | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `allowed_models` | List[*str*] | :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/*"
] | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginfileparser.mdx b/client-sdks/python/components/openresponsesrequestpluginfileparser.mdx deleted file mode 100644 index c90d2902..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginfileparser.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesRequestPluginFileParser - Python SDK -description: OpenResponsesRequestPluginFileParser method reference -seoTitle: OpenResponsesRequestPluginFileParser | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginfileparser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginFileParser | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginFileParser method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginFileParser%20-%20Python%20SDK&description=OpenResponsesRequestPluginFileParser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `id` | [components.IDFileParser](/client-sdks/python/components/idfileparser) | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | -| `pdf` | [Optional[components.PDFParserOptions]](../components/pdfparseroptions.md) | :heavy_minus_sign: | Options for PDF parsing. | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginmoderation.mdx b/client-sdks/python/components/openresponsesrequestpluginmoderation.mdx deleted file mode 100644 index 83ebdb27..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginmoderation.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesRequestPluginModeration - Python SDK -description: OpenResponsesRequestPluginModeration method reference -seoTitle: OpenResponsesRequestPluginModeration | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginmoderation -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginModeration | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginModeration method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginModeration%20-%20Python%20SDK&description=OpenResponsesRequestPluginModeration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | [components.IDModeration](/client-sdks/python/components/idmoderation) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginresponsehealing.mdx b/client-sdks/python/components/openresponsesrequestpluginresponsehealing.mdx deleted file mode 100644 index 6050657c..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginresponsehealing.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OpenResponsesRequestPluginResponseHealing - Python SDK -description: OpenResponsesRequestPluginResponseHealing method reference -seoTitle: OpenResponsesRequestPluginResponseHealing | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginresponsehealing -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginResponseHealing | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginResponseHealing method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginResponseHealing%20-%20Python%20SDK&description=OpenResponsesRequestPluginResponseHealing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `id` | [components.IDResponseHealing](/client-sdks/python/components/idresponsehealing) | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginunion.mdx b/client-sdks/python/components/openresponsesrequestpluginunion.mdx deleted file mode 100644 index 8a63ac58..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesRequestPluginUnion - Python SDK -description: OpenResponsesRequestPluginUnion method reference -seoTitle: OpenResponsesRequestPluginUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginUnion%20-%20Python%20SDK&description=OpenResponsesRequestPluginUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesRequestPluginAutoRouter` - -```python lines -value: components.OpenResponsesRequestPluginAutoRouter = /* values here */ -``` - -### `components.OpenResponsesRequestPluginModeration` - -```python lines -value: components.OpenResponsesRequestPluginModeration = /* values here */ -``` - -### `components.OpenResponsesRequestPluginWeb` - -```python lines -value: components.OpenResponsesRequestPluginWeb = /* values here */ -``` - -### `components.OpenResponsesRequestPluginFileParser` - -```python lines -value: components.OpenResponsesRequestPluginFileParser = /* values here */ -``` - -### `components.OpenResponsesRequestPluginResponseHealing` - -```python lines -value: components.OpenResponsesRequestPluginResponseHealing = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestpluginweb.mdx b/client-sdks/python/components/openresponsesrequestpluginweb.mdx deleted file mode 100644 index ddbc40e9..00000000 --- a/client-sdks/python/components/openresponsesrequestpluginweb.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesRequestPluginWeb - Python SDK -description: OpenResponsesRequestPluginWeb method reference -seoTitle: OpenResponsesRequestPluginWeb | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequestpluginweb -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginWeb | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestPluginWeb method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginWeb%20-%20Python%20SDK&description=OpenResponsesRequestPluginWeb%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `id` | [components.IDWeb](/client-sdks/python/components/idweb) | :heavy_check_mark: | N/A | -| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | -| `max_results` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `search_prompt` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `engine` | [Optional[components.WebSearchEngine]](../components/websearchengine.md) | :heavy_minus_sign: | The search engine to use for web search. | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestprovider.mdx b/client-sdks/python/components/openresponsesrequestprovider.mdx deleted file mode 100644 index 50470543..00000000 --- a/client-sdks/python/components/openresponsesrequestprovider.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenResponsesRequestProvider - Python SDK -description: OpenResponsesRequestProvider method reference -seoTitle: OpenResponsesRequestProvider | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestprovider' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestProvider | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestProvider method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestProvider%20-%20Python%20SDK&description=OpenResponsesRequestProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -When multiple model providers are available, optionally indicate your routing preference. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| | -| `require_parameters` | *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. | | -| `data_collection` | [OptionalNullable[components.DataCollection]](../components/datacollection.md) | :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 | -| `zdr` | *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 | -| `enforce_distillable_text` | *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 | -| `order` | List[[components.OpenResponsesRequestOrder](/client-sdks/python/components/openresponsesrequestorder)] | :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. | | -| `only` | List[[components.OpenResponsesRequestOnly](/client-sdks/python/components/openresponsesrequestonly)] | :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. | | -| `ignore` | List[[components.OpenResponsesRequestIgnore](/client-sdks/python/components/openresponsesrequestignore)] | :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. | | -| `quantizations` | List[[components.Quantization](/client-sdks/python/api-reference/components/quantization)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `sort` | [OptionalNullable[components.OpenResponsesRequestSort]](../components/openresponsesrequestsort.md) | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `max_price` | [Optional[components.OpenResponsesRequestMaxPrice]](../components/openresponsesrequestmaxprice.md) | :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. | | -| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../components/preferredminthroughput.md) | :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 | -| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../components/preferredmaxlatency.md) | :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 | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequestsort.mdx b/client-sdks/python/components/openresponsesrequestsort.mdx deleted file mode 100644 index 615ae73e..00000000 --- a/client-sdks/python/components/openresponsesrequestsort.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenResponsesRequestSort - Python SDK -description: OpenResponsesRequestSort method reference -seoTitle: OpenResponsesRequestSort | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequestsort' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestSort | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestSort method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestSort%20-%20Python%20SDK&description=OpenResponsesRequestSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `components.ProviderSort` - -```python lines -value: components.ProviderSort = /* values here */ -``` - -### `components.ProviderSortConfig` - -```python lines -value: components.ProviderSortConfig = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequesttoolfunction.mdx b/client-sdks/python/components/openresponsesrequesttoolfunction.mdx deleted file mode 100644 index 4b41dc02..00000000 --- a/client-sdks/python/components/openresponsesrequesttoolfunction.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: OpenResponsesRequestToolFunction - Python SDK -description: OpenResponsesRequestToolFunction method reference -seoTitle: OpenResponsesRequestToolFunction | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequesttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestToolFunction | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestToolFunction method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestToolFunction%20-%20Python%20SDK&description=OpenResponsesRequestToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesRequestType](/client-sdks/python/components/openresponsesrequesttype) | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `parameters` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequesttoolunion.mdx b/client-sdks/python/components/openresponsesrequesttoolunion.mdx deleted file mode 100644 index 6468a7d8..00000000 --- a/client-sdks/python/components/openresponsesrequesttoolunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesRequestToolUnion - Python SDK -description: OpenResponsesRequestToolUnion method reference -seoTitle: OpenResponsesRequestToolUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestToolUnion | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestToolUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestToolUnion%20-%20Python%20SDK&description=OpenResponsesRequestToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesRequestToolFunction` - -```python lines -value: components.OpenResponsesRequestToolFunction = /* values here */ -``` - -### `components.OpenResponsesWebSearchPreviewTool` - -```python lines -value: components.OpenResponsesWebSearchPreviewTool = /* values here */ -``` - -### `components.OpenResponsesWebSearchPreview20250311Tool` - -```python lines -value: components.OpenResponsesWebSearchPreview20250311Tool = /* values here */ -``` - -### `components.OpenResponsesWebSearchTool` - -```python lines -value: components.OpenResponsesWebSearchTool = /* values here */ -``` - -### `components.OpenResponsesWebSearch20250826Tool` - -```python lines -value: components.OpenResponsesWebSearch20250826Tool = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesrequesttype.mdx b/client-sdks/python/components/openresponsesrequesttype.mdx deleted file mode 100644 index 17150774..00000000 --- a/client-sdks/python/components/openresponsesrequesttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OpenResponsesRequestType - Python SDK -description: OpenResponsesRequestType method reference -seoTitle: OpenResponsesRequestType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesrequesttype' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestType | OpenRouter Python SDK -'og:description': >- - OpenResponsesRequestType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestType%20-%20Python%20SDK&description=OpenResponsesRequestType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FUNCTION` | function | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesresponsetext.mdx b/client-sdks/python/components/openresponsesresponsetext.mdx deleted file mode 100644 index 14ac5b32..00000000 --- a/client-sdks/python/components/openresponsesresponsetext.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesResponseText - Python SDK -description: OpenResponsesResponseText method reference -seoTitle: OpenResponsesResponseText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesresponsetext' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResponseText | OpenRouter Python SDK -'og:description': >- - OpenResponsesResponseText method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResponseText%20-%20Python%20SDK&description=OpenResponsesResponseText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `format_` | [Optional[components.ResponseFormatTextConfig]](../components/responseformattextconfig.md) | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [OptionalNullable[components.OpenResponsesResponseTextVerbosity]](../components/openresponsesresponsetextverbosity.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesresponsetextverbosity.mdx b/client-sdks/python/components/openresponsesresponsetextverbosity.mdx deleted file mode 100644 index 34fa3348..00000000 --- a/client-sdks/python/components/openresponsesresponsetextverbosity.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesResponseTextVerbosity - Python SDK -description: OpenResponsesResponseTextVerbosity method reference -seoTitle: OpenResponsesResponseTextVerbosity | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesresponsetextverbosity -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResponseTextVerbosity | OpenRouter Python SDK -'og:description': >- - OpenResponsesResponseTextVerbosity method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResponseTextVerbosity%20-%20Python%20SDK&description=OpenResponsesResponseTextVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `HIGH` | high | -| `LOW` | low | -| `MEDIUM` | medium | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreamevent.mdx b/client-sdks/python/components/openresponsesstreamevent.mdx deleted file mode 100644 index 84a19ac2..00000000 --- a/client-sdks/python/components/openresponsesstreamevent.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: OpenResponsesStreamEvent - Python SDK -description: OpenResponsesStreamEvent method reference -seoTitle: OpenResponsesStreamEvent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesstreamevent' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEvent | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEvent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEvent%20-%20Python%20SDK&description=OpenResponsesStreamEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Union of all possible event types emitted during response streaming - -## Supported Types - -### `components.OpenResponsesStreamEventResponseCreated` - -```python lines -value: components.OpenResponsesStreamEventResponseCreated = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseInProgress` - -```python lines -value: components.OpenResponsesStreamEventResponseInProgress = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseCompleted` - -```python lines -value: components.OpenResponsesStreamEventResponseCompleted = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseIncomplete` - -```python lines -value: components.OpenResponsesStreamEventResponseIncomplete = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseFailed` - -```python lines -value: components.OpenResponsesStreamEventResponseFailed = /* values here */ -``` - -### `components.OpenResponsesErrorEvent` - -```python lines -value: components.OpenResponsesErrorEvent = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseOutputItemAdded` - -```python lines -value: components.OpenResponsesStreamEventResponseOutputItemAdded = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseOutputItemDone` - -```python lines -value: components.OpenResponsesStreamEventResponseOutputItemDone = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseContentPartAdded` - -```python lines -value: components.OpenResponsesStreamEventResponseContentPartAdded = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseContentPartDone` - -```python lines -value: components.OpenResponsesStreamEventResponseContentPartDone = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseOutputTextDelta` - -```python lines -value: components.OpenResponsesStreamEventResponseOutputTextDelta = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseOutputTextDone` - -```python lines -value: components.OpenResponsesStreamEventResponseOutputTextDone = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseRefusalDelta` - -```python lines -value: components.OpenResponsesStreamEventResponseRefusalDelta = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseRefusalDone` - -```python lines -value: components.OpenResponsesStreamEventResponseRefusalDone = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseOutputTextAnnotationAdded` - -```python lines -value: components.OpenResponsesStreamEventResponseOutputTextAnnotationAdded = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseFunctionCallArgumentsDelta` - -```python lines -value: components.OpenResponsesStreamEventResponseFunctionCallArgumentsDelta = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseFunctionCallArgumentsDone` - -```python lines -value: components.OpenResponsesStreamEventResponseFunctionCallArgumentsDone = /* values here */ -``` - -### `components.OpenResponsesReasoningDeltaEvent` - -```python lines -value: components.OpenResponsesReasoningDeltaEvent = /* values here */ -``` - -### `components.OpenResponsesReasoningDoneEvent` - -```python lines -value: components.OpenResponsesReasoningDoneEvent = /* values here */ -``` - -### `components.OpenResponsesReasoningSummaryPartAddedEvent` - -```python lines -value: components.OpenResponsesReasoningSummaryPartAddedEvent = /* values here */ -``` - -### `components.OpenResponsesStreamEventResponseReasoningSummaryPartDone` - -```python lines -value: components.OpenResponsesStreamEventResponseReasoningSummaryPartDone = /* values here */ -``` - -### `components.OpenResponsesReasoningSummaryTextDeltaEvent` - -```python lines -value: components.OpenResponsesReasoningSummaryTextDeltaEvent = /* values here */ -``` - -### `components.OpenResponsesReasoningSummaryTextDoneEvent` - -```python lines -value: components.OpenResponsesReasoningSummaryTextDoneEvent = /* values here */ -``` - -### `components.OpenResponsesImageGenCallInProgress` - -```python lines -value: components.OpenResponsesImageGenCallInProgress = /* values here */ -``` - -### `components.OpenResponsesImageGenCallGenerating` - -```python lines -value: components.OpenResponsesImageGenCallGenerating = /* values here */ -``` - -### `components.OpenResponsesImageGenCallPartialImage` - -```python lines -value: components.OpenResponsesImageGenCallPartialImage = /* values here */ -``` - -### `components.OpenResponsesImageGenCallCompleted` - -```python lines -value: components.OpenResponsesImageGenCallCompleted = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsecompleted.mdx b/client-sdks/python/components/openresponsesstreameventresponsecompleted.mdx deleted file mode 100644 index c3f81552..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsecompleted.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseCompleted - Python SDK -description: OpenResponsesStreamEventResponseCompleted method reference -seoTitle: OpenResponsesStreamEventResponseCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsecompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseCompleted | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseCompleted method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseCompleted%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has completed successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseCompleted](/client-sdks/python/components/typeresponsecompleted) | :heavy_check_mark: | N/A | | -| `response` | [components.OpenResponsesNonStreamingResponse](/client-sdks/python/components/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsecontentpartadded.mdx b/client-sdks/python/components/openresponsesstreameventresponsecontentpartadded.mdx deleted file mode 100644 index 8aad6585..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsecontentpartadded.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseContentPartAdded - Python SDK -description: OpenResponsesStreamEventResponseContentPartAdded method reference -seoTitle: OpenResponsesStreamEventResponseContentPartAdded | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsecontentpartadded -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseContentPartAdded | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseContentPartAdded method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseContentPartAdded%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseContentPartAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a new content part is added to an output item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseContentPartAdded](/client-sdks/python/components/typeresponsecontentpartadded) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `part` | [components.Part1](/client-sdks/python/components/part1) | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsecontentpartdone.mdx b/client-sdks/python/components/openresponsesstreameventresponsecontentpartdone.mdx deleted file mode 100644 index b939e827..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsecontentpartdone.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseContentPartDone - Python SDK -description: OpenResponsesStreamEventResponseContentPartDone method reference -seoTitle: OpenResponsesStreamEventResponseContentPartDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsecontentpartdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseContentPartDone | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseContentPartDone method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseContentPartDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseContentPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a content part is complete - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseContentPartDone](/client-sdks/python/components/typeresponsecontentpartdone) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `part` | [components.Part2](/client-sdks/python/components/part2) | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsecreated.mdx b/client-sdks/python/components/openresponsesstreameventresponsecreated.mdx deleted file mode 100644 index e12e47ef..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsecreated.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseCreated - Python SDK -description: OpenResponsesStreamEventResponseCreated method reference -seoTitle: OpenResponsesStreamEventResponseCreated | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsecreated -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseCreated | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseCreated method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseCreated%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseCreated%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is created - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseCreated](/client-sdks/python/components/typeresponsecreated) | :heavy_check_mark: | N/A | | -| `response` | [components.OpenResponsesNonStreamingResponse](/client-sdks/python/components/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsefailed.mdx b/client-sdks/python/components/openresponsesstreameventresponsefailed.mdx deleted file mode 100644 index 8c611ee8..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsefailed.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFailed - Python SDK -description: OpenResponsesStreamEventResponseFailed method reference -seoTitle: OpenResponsesStreamEventResponseFailed | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsefailed -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseFailed | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseFailed method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFailed%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseFailed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has failed - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseFailed](/client-sdks/python/components/typeresponsefailed) | :heavy_check_mark: | N/A | | -| `response` | [components.OpenResponsesNonStreamingResponse](/client-sdks/python/components/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx b/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx deleted file mode 100644 index 636cfb2c..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFunctionCallArgumentsDelta - Python SDK -description: OpenResponsesStreamEventResponseFunctionCallArgumentsDelta method reference -seoTitle: >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta | OpenRouter Python - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdelta -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta | OpenRouter Python - SDK -'og:description': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta method - documentation for the OpenRouter Python SDK. Learn how to use this API - endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFunctionCallArgumentsDelta%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseFunctionCallArgumentsDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments are being streamed - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [components.TypeResponseFunctionCallArgumentsDelta](/client-sdks/python/components/typeresponsefunctioncallargumentsdelta) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdone.mdx b/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdone.mdx deleted file mode 100644 index c38b7da4..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdone.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFunctionCallArgumentsDone - Python SDK -description: OpenResponsesStreamEventResponseFunctionCallArgumentsDone method reference -seoTitle: >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone | OpenRouter Python - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsefunctioncallargumentsdone -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone | OpenRouter Python - SDK -'og:description': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone method documentation - for the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFunctionCallArgumentsDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseFunctionCallArgumentsDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseFunctionCallArgumentsDone](/client-sdks/python/components/typeresponsefunctioncallargumentsdone) | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseincomplete.mdx b/client-sdks/python/components/openresponsesstreameventresponseincomplete.mdx deleted file mode 100644 index 5a1eab5d..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseincomplete.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseIncomplete - Python SDK -description: OpenResponsesStreamEventResponseIncomplete method reference -seoTitle: OpenResponsesStreamEventResponseIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseincomplete -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseIncomplete | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseIncomplete method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseIncomplete%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is incomplete - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseIncomplete](/client-sdks/python/components/typeresponseincomplete) | :heavy_check_mark: | N/A | | -| `response` | [components.OpenResponsesNonStreamingResponse](/client-sdks/python/components/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseinprogress.mdx b/client-sdks/python/components/openresponsesstreameventresponseinprogress.mdx deleted file mode 100644 index 78c06066..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseinprogress.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseInProgress - Python SDK -description: OpenResponsesStreamEventResponseInProgress method reference -seoTitle: OpenResponsesStreamEventResponseInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseInProgress | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseInProgress method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseInProgress%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is in progress - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseInProgress](/client-sdks/python/components/typeresponseinprogress) | :heavy_check_mark: | N/A | | -| `response` | [components.OpenResponsesNonStreamingResponse](/client-sdks/python/components/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseoutputitemadded.mdx b/client-sdks/python/components/openresponsesstreameventresponseoutputitemadded.mdx deleted file mode 100644 index e3d7c747..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseoutputitemadded.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputItemAdded - Python SDK -description: OpenResponsesStreamEventResponseOutputItemAdded method reference -seoTitle: OpenResponsesStreamEventResponseOutputItemAdded | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseoutputitemadded -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputItemAdded | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputItemAdded method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputItemAdded%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseOutputItemAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a new output item is added to the response - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseOutputItemAdded](/client-sdks/python/components/typeresponseoutputitemadded) | :heavy_check_mark: | N/A | | -| `output_index` | *float* | :heavy_check_mark: | N/A | | -| `item` | [components.ResponsesOutputItem](/client-sdks/python/components/responsesoutputitem) | :heavy_check_mark: | An output item from the response | `{"id": "msg-abc123","role": "assistant","type": "message","status": "completed","content": [{"type": "output_text","text": "Hello! How can I help you today?"}`
]
} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseoutputitemdone.mdx b/client-sdks/python/components/openresponsesstreameventresponseoutputitemdone.mdx deleted file mode 100644 index 9b946a1c..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseoutputitemdone.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputItemDone - Python SDK -description: OpenResponsesStreamEventResponseOutputItemDone method reference -seoTitle: OpenResponsesStreamEventResponseOutputItemDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseoutputitemdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputItemDone | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputItemDone method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputItemDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseOutputItemDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when an output item is complete - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseOutputItemDone](/client-sdks/python/components/typeresponseoutputitemdone) | :heavy_check_mark: | N/A | | -| `output_index` | *float* | :heavy_check_mark: | N/A | | -| `item` | [components.ResponsesOutputItem](/client-sdks/python/components/responsesoutputitem) | :heavy_check_mark: | An output item from the response | `{"id": "msg-abc123","role": "assistant","type": "message","status": "completed","content": [{"type": "output_text","text": "Hello! How can I help you today?"}`
]
} | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseoutputtextannotationadded.mdx b/client-sdks/python/components/openresponsesstreameventresponseoutputtextannotationadded.mdx deleted file mode 100644 index f10fafda..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseoutputtextannotationadded.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextAnnotationAdded - Python SDK -description: OpenResponsesStreamEventResponseOutputTextAnnotationAdded method reference -seoTitle: >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded | OpenRouter Python - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseoutputtextannotationadded -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded | OpenRouter Python - SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded method documentation - for the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextAnnotationAdded%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseOutputTextAnnotationAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a text annotation is added to output - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseOutputTextAnnotationAdded](/client-sdks/python/components/typeresponseoutputtextannotationadded) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | -| `annotation_index` | *float* | :heavy_check_mark: | N/A | -| `annotation` | [components.OpenAIResponsesAnnotation](/client-sdks/python/api-reference/components/openairesponsesannotation) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseoutputtextdelta.mdx b/client-sdks/python/components/openresponsesstreameventresponseoutputtextdelta.mdx deleted file mode 100644 index b21359cf..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseoutputtextdelta.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextDelta - Python SDK -description: OpenResponsesStreamEventResponseOutputTextDelta method reference -seoTitle: OpenResponsesStreamEventResponseOutputTextDelta | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseoutputtextdelta -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputTextDelta | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextDelta method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextDelta%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseOutputTextDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a text delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseOutputTextDelta](/client-sdks/python/components/typeresponseoutputtextdelta) | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.OpenResponsesLogProbs](/client-sdks/python/components/openresponseslogprobs)] | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponseoutputtextdone.mdx b/client-sdks/python/components/openresponsesstreameventresponseoutputtextdone.mdx deleted file mode 100644 index da2c0e5c..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponseoutputtextdone.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextDone - Python SDK -description: OpenResponsesStreamEventResponseOutputTextDone method reference -seoTitle: OpenResponsesStreamEventResponseOutputTextDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponseoutputtextdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputTextDone | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextDone method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseOutputTextDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when text streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | [components.TypeResponseOutputTextDone](/client-sdks/python/components/typeresponseoutputtextdone) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | -| `logprobs` | List[[components.OpenResponsesLogProbs](/client-sdks/python/components/openresponseslogprobs)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponsereasoningsummarypartdone.mdx b/client-sdks/python/components/openresponsesstreameventresponsereasoningsummarypartdone.mdx deleted file mode 100644 index fdacbf06..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponsereasoningsummarypartdone.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseReasoningSummaryPartDone - Python SDK -description: OpenResponsesStreamEventResponseReasoningSummaryPartDone method reference -seoTitle: >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone | OpenRouter Python - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponsereasoningsummarypartdone -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone | OpenRouter Python - SDK -'og:description': >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone method documentation - for the OpenRouter Python SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseReasoningSummaryPartDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseReasoningSummaryPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is complete - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseReasoningSummaryPartDone](/client-sdks/python/components/typeresponsereasoningsummarypartdone) | :heavy_check_mark: | N/A | | -| `output_index` | *float* | :heavy_check_mark: | N/A | | -| `item_id` | *str* | :heavy_check_mark: | N/A | | -| `summary_index` | *float* | :heavy_check_mark: | N/A | | -| `part` | [components.ReasoningSummaryText](/client-sdks/python/components/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"type": "summary_text","text": "Analyzed the problem using first principles"}` | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponserefusaldelta.mdx b/client-sdks/python/components/openresponsesstreameventresponserefusaldelta.mdx deleted file mode 100644 index baf43ffe..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponserefusaldelta.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseRefusalDelta - Python SDK -description: OpenResponsesStreamEventResponseRefusalDelta method reference -seoTitle: OpenResponsesStreamEventResponseRefusalDelta | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponserefusaldelta -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseRefusalDelta | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseRefusalDelta method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseRefusalDelta%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseRefusalDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when a refusal delta is streamed - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.TypeResponseRefusalDelta](/client-sdks/python/components/typeresponserefusaldelta) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `delta` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesstreameventresponserefusaldone.mdx b/client-sdks/python/components/openresponsesstreameventresponserefusaldone.mdx deleted file mode 100644 index e44930b7..00000000 --- a/client-sdks/python/components/openresponsesstreameventresponserefusaldone.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseRefusalDone - Python SDK -description: OpenResponsesStreamEventResponseRefusalDone method reference -seoTitle: OpenResponsesStreamEventResponseRefusalDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponsesstreameventresponserefusaldone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseRefusalDone | OpenRouter Python SDK -'og:description': >- - OpenResponsesStreamEventResponseRefusalDone method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseRefusalDone%20-%20Python%20SDK&description=OpenResponsesStreamEventResponseRefusalDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Event emitted when refusal streaming is complete - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | [components.TypeResponseRefusalDone](/client-sdks/python/components/typeresponserefusaldone) | :heavy_check_mark: | N/A | -| `output_index` | *float* | :heavy_check_mark: | N/A | -| `item_id` | *str* | :heavy_check_mark: | N/A | -| `content_index` | *float* | :heavy_check_mark: | N/A | -| `refusal` | *str* | :heavy_check_mark: | N/A | -| `sequence_number` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsestoplogprobs.mdx b/client-sdks/python/components/openresponsestoplogprobs.mdx deleted file mode 100644 index 7ba4a69f..00000000 --- a/client-sdks/python/components/openresponsestoplogprobs.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: OpenResponsesTopLogprobs - Python SDK -description: OpenResponsesTopLogprobs method reference -seoTitle: OpenResponsesTopLogprobs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsestoplogprobs' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesTopLogprobs | OpenRouter Python SDK -'og:description': >- - OpenResponsesTopLogprobs method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesTopLogprobs%20-%20Python%20SDK&description=OpenResponsesTopLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Alternative token with its log probability - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `logprob` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponsesusage.mdx b/client-sdks/python/components/openresponsesusage.mdx deleted file mode 100644 index 8aabde3e..00000000 --- a/client-sdks/python/components/openresponsesusage.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesUsage - Python SDK -description: OpenResponsesUsage method reference -seoTitle: OpenResponsesUsage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponsesusage' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesUsage | OpenRouter Python SDK -'og:description': >- - OpenResponsesUsage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesUsage%20-%20Python%20SDK&description=OpenResponsesUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Token usage information for the response - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `input_tokens` | *float* | :heavy_check_mark: | N/A | -| `input_tokens_details` | [components.InputTokensDetails](/client-sdks/python/api-reference/components/inputtokensdetails) | :heavy_check_mark: | N/A | -| `output_tokens` | *float* | :heavy_check_mark: | N/A | -| `output_tokens_details` | [components.OutputTokensDetails](/client-sdks/python/api-reference/components/outputtokensdetails) | :heavy_check_mark: | N/A | -| `total_tokens` | *float* | :heavy_check_mark: | N/A | -| `cost` | *OptionalNullable[float]* | :heavy_minus_sign: | Cost of the completion | -| `is_byok` | *Optional[bool]* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | -| `cost_details` | [Optional[components.CostDetails]](../components/costdetails.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearch20250826tool.mdx b/client-sdks/python/components/openresponseswebsearch20250826tool.mdx deleted file mode 100644 index b2360395..00000000 --- a/client-sdks/python/components/openresponseswebsearch20250826tool.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: OpenResponsesWebSearch20250826Tool - Python SDK -description: OpenResponsesWebSearch20250826Tool method reference -seoTitle: OpenResponsesWebSearch20250826Tool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearch20250826tool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearch20250826Tool | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearch20250826Tool method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearch20250826Tool%20-%20Python%20SDK&description=OpenResponsesWebSearch20250826Tool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search tool configuration (2025-08-26 version) - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesWebSearch20250826ToolType](/client-sdks/python/components/openresponseswebsearch20250826tooltype) | :heavy_check_mark: | N/A | | -| `filters` | [OptionalNullable[components.OpenResponsesWebSearch20250826ToolFilters]](../components/openresponseswebsearch20250826toolfilters.md) | :heavy_minus_sign: | N/A | | -| `search_context_size` | [Optional[components.ResponsesSearchContextSize]](../components/responsessearchcontextsize.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `user_location` | [OptionalNullable[components.ResponsesWebSearchUserLocation]](../components/responseswebsearchuserlocation.md) | :heavy_minus_sign: | User location information for web search | `{"type": "approximate","city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles"}` | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearch20250826toolfilters.mdx b/client-sdks/python/components/openresponseswebsearch20250826toolfilters.mdx deleted file mode 100644 index 2744f1d5..00000000 --- a/client-sdks/python/components/openresponseswebsearch20250826toolfilters.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearch20250826ToolFilters - Python SDK -description: OpenResponsesWebSearch20250826ToolFilters method reference -seoTitle: OpenResponsesWebSearch20250826ToolFilters | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearch20250826toolfilters -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearch20250826ToolFilters | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearch20250826ToolFilters method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearch20250826ToolFilters%20-%20Python%20SDK&description=OpenResponsesWebSearch20250826ToolFilters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearch20250826tooltype.mdx b/client-sdks/python/components/openresponseswebsearch20250826tooltype.mdx deleted file mode 100644 index c2f44469..00000000 --- a/client-sdks/python/components/openresponseswebsearch20250826tooltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearch20250826ToolType - Python SDK -description: OpenResponsesWebSearch20250826ToolType method reference -seoTitle: OpenResponsesWebSearch20250826ToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearch20250826tooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearch20250826ToolType | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearch20250826ToolType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearch20250826ToolType%20-%20Python%20SDK&description=OpenResponsesWebSearch20250826ToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `WEB_SEARCH_2025_08_26` | web_search_2025_08_26 | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchpreview20250311tool.mdx b/client-sdks/python/components/openresponseswebsearchpreview20250311tool.mdx deleted file mode 100644 index 1949b5ff..00000000 --- a/client-sdks/python/components/openresponseswebsearchpreview20250311tool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesWebSearchPreview20250311Tool - Python SDK -description: OpenResponsesWebSearchPreview20250311Tool method reference -seoTitle: OpenResponsesWebSearchPreview20250311Tool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchpreview20250311tool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreview20250311Tool | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchPreview20250311Tool method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreview20250311Tool%20-%20Python%20SDK&description=OpenResponsesWebSearchPreview20250311Tool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration (2025-03-11 version) - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesWebSearchPreview20250311ToolType](/client-sdks/python/components/openresponseswebsearchpreview20250311tooltype) | :heavy_check_mark: | N/A | | -| `search_context_size` | [Optional[components.ResponsesSearchContextSize]](../components/responsessearchcontextsize.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `user_location` | [OptionalNullable[components.WebSearchPreviewToolUserLocation]](../components/websearchpreviewtooluserlocation.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchpreview20250311tooltype.mdx b/client-sdks/python/components/openresponseswebsearchpreview20250311tooltype.mdx deleted file mode 100644 index bd0cf21d..00000000 --- a/client-sdks/python/components/openresponseswebsearchpreview20250311tooltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearchPreview20250311ToolType - Python SDK -description: OpenResponsesWebSearchPreview20250311ToolType method reference -seoTitle: OpenResponsesWebSearchPreview20250311ToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchpreview20250311tooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreview20250311ToolType | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchPreview20250311ToolType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreview20250311ToolType%20-%20Python%20SDK&description=OpenResponsesWebSearchPreview20250311ToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------------- | ------------------------------- | -| `WEB_SEARCH_PREVIEW_2025_03_11` | web_search_preview_2025_03_11 | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchpreviewtool.mdx b/client-sdks/python/components/openresponseswebsearchpreviewtool.mdx deleted file mode 100644 index e8e3bc3f..00000000 --- a/client-sdks/python/components/openresponseswebsearchpreviewtool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesWebSearchPreviewTool - Python SDK -description: OpenResponsesWebSearchPreviewTool method reference -seoTitle: OpenResponsesWebSearchPreviewTool | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchpreviewtool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreviewTool | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchPreviewTool method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreviewTool%20-%20Python%20SDK&description=OpenResponsesWebSearchPreviewTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.OpenResponsesWebSearchPreviewToolType](/client-sdks/python/components/openresponseswebsearchpreviewtooltype) | :heavy_check_mark: | N/A | | -| `search_context_size` | [Optional[components.ResponsesSearchContextSize]](../components/responsessearchcontextsize.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `user_location` | [OptionalNullable[components.WebSearchPreviewToolUserLocation]](../components/websearchpreviewtooluserlocation.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchpreviewtooltype.mdx b/client-sdks/python/components/openresponseswebsearchpreviewtooltype.mdx deleted file mode 100644 index abf66eec..00000000 --- a/client-sdks/python/components/openresponseswebsearchpreviewtooltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearchPreviewToolType - Python SDK -description: OpenResponsesWebSearchPreviewToolType method reference -seoTitle: OpenResponsesWebSearchPreviewToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchpreviewtooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreviewToolType | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchPreviewToolType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreviewToolType%20-%20Python%20SDK&description=OpenResponsesWebSearchPreviewToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `WEB_SEARCH_PREVIEW` | web_search_preview | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchtool.mdx b/client-sdks/python/components/openresponseswebsearchtool.mdx deleted file mode 100644 index cfd72385..00000000 --- a/client-sdks/python/components/openresponseswebsearchtool.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: OpenResponsesWebSearchTool - Python SDK -description: OpenResponsesWebSearchTool method reference -seoTitle: OpenResponsesWebSearchTool | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/openresponseswebsearchtool' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchTool | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchTool method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchTool%20-%20Python%20SDK&description=OpenResponsesWebSearchTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Web search tool configuration - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [components.OpenResponsesWebSearchToolType](/client-sdks/python/components/openresponseswebsearchtooltype) | :heavy_check_mark: | N/A | | -| `filters` | [OptionalNullable[components.OpenResponsesWebSearchToolFilters]](../components/openresponseswebsearchtoolfilters.md) | :heavy_minus_sign: | N/A | | -| `search_context_size` | [Optional[components.ResponsesSearchContextSize]](../components/responsessearchcontextsize.md) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `user_location` | [OptionalNullable[components.ResponsesWebSearchUserLocation]](../components/responseswebsearchuserlocation.md) | :heavy_minus_sign: | User location information for web search | `{"type": "approximate","city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles"}` | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchtoolfilters.mdx b/client-sdks/python/components/openresponseswebsearchtoolfilters.mdx deleted file mode 100644 index ab03fbfd..00000000 --- a/client-sdks/python/components/openresponseswebsearchtoolfilters.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearchToolFilters - Python SDK -description: OpenResponsesWebSearchToolFilters method reference -seoTitle: OpenResponsesWebSearchToolFilters | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchtoolfilters -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchToolFilters | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchToolFilters method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchToolFilters%20-%20Python%20SDK&description=OpenResponsesWebSearchToolFilters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowed_domains` | List[*str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/openresponseswebsearchtooltype.mdx b/client-sdks/python/components/openresponseswebsearchtooltype.mdx deleted file mode 100644 index 847b8952..00000000 --- a/client-sdks/python/components/openresponseswebsearchtooltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OpenResponsesWebSearchToolType - Python SDK -description: OpenResponsesWebSearchToolType method reference -seoTitle: OpenResponsesWebSearchToolType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/openresponseswebsearchtooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchToolType | OpenRouter Python SDK -'og:description': >- - OpenResponsesWebSearchToolType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchToolType%20-%20Python%20SDK&description=OpenResponsesWebSearchToolType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `WEB_SEARCH` | web_search | \ No newline at end of file diff --git a/client-sdks/python/components/outputitemimagegenerationcall.mdx b/client-sdks/python/components/outputitemimagegenerationcall.mdx deleted file mode 100644 index 8090d205..00000000 --- a/client-sdks/python/components/outputitemimagegenerationcall.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OutputItemImageGenerationCall - Python SDK -description: OutputItemImageGenerationCall method reference -seoTitle: OutputItemImageGenerationCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/outputitemimagegenerationcall -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCall | OpenRouter Python SDK -'og:description': >- - OutputItemImageGenerationCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCall%20-%20Python%20SDK&description=OutputItemImageGenerationCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [components.OutputItemImageGenerationCallType](/client-sdks/python/api-reference/components/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](/client-sdks/python/api-reference/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/outputitemimagegenerationcalltype.mdx b/client-sdks/python/components/outputitemimagegenerationcalltype.mdx deleted file mode 100644 index c6bbe95c..00000000 --- a/client-sdks/python/components/outputitemimagegenerationcalltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OutputItemImageGenerationCallType - Python SDK -description: OutputItemImageGenerationCallType method reference -seoTitle: OutputItemImageGenerationCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/outputitemimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCallType | OpenRouter Python SDK -'og:description': >- - OutputItemImageGenerationCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCallType%20-%20Python%20SDK&description=OutputItemImageGenerationCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `IMAGE_GENERATION_CALL` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessage.mdx b/client-sdks/python/components/outputmessage.mdx deleted file mode 100644 index 9985be1c..00000000 --- a/client-sdks/python/components/outputmessage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: OutputMessage - Python SDK -description: OutputMessage method reference -seoTitle: OutputMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessage' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessage | OpenRouter Python SDK -'og:description': >- - OutputMessage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessage%20-%20Python%20SDK&description=OutputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.OutputMessageRole](/client-sdks/python/api-reference/components/outputmessagerole) | :heavy_check_mark: | N/A | -| `type` | [components.OutputMessageType](/client-sdks/python/api-reference/components/outputmessagetype) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.OutputMessageStatusUnion]](../components/outputmessagestatusunion.md) | :heavy_minus_sign: | N/A | -| `content` | List[[components.OutputMessageContent](/client-sdks/python/api-reference/components/outputmessagecontent)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagecontent.mdx b/client-sdks/python/components/outputmessagecontent.mdx deleted file mode 100644 index 1283e184..00000000 --- a/client-sdks/python/components/outputmessagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMessageContent - Python SDK -description: OutputMessageContent method reference -seoTitle: OutputMessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageContent | OpenRouter Python SDK -'og:description': >- - OutputMessageContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageContent%20-%20Python%20SDK&description=OutputMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagerole.mdx b/client-sdks/python/components/outputmessagerole.mdx deleted file mode 100644 index 61a364eb..00000000 --- a/client-sdks/python/components/outputmessagerole.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OutputMessageRole - Python SDK -description: OutputMessageRole method reference -seoTitle: OutputMessageRole | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageRole | OpenRouter Python SDK -'og:description': >- - OutputMessageRole method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageRole%20-%20Python%20SDK&description=OutputMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagestatuscompleted.mdx b/client-sdks/python/components/outputmessagestatuscompleted.mdx deleted file mode 100644 index e9494b33..00000000 --- a/client-sdks/python/components/outputmessagestatuscompleted.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OutputMessageStatusCompleted - Python SDK -description: OutputMessageStatusCompleted method reference -seoTitle: OutputMessageStatusCompleted | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessagestatuscompleted' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusCompleted | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusCompleted method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusCompleted%20-%20Python%20SDK&description=OutputMessageStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagestatusincomplete.mdx b/client-sdks/python/components/outputmessagestatusincomplete.mdx deleted file mode 100644 index 2713bcc9..00000000 --- a/client-sdks/python/components/outputmessagestatusincomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OutputMessageStatusIncomplete - Python SDK -description: OutputMessageStatusIncomplete method reference -seoTitle: OutputMessageStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/outputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusIncomplete | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusIncomplete method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusIncomplete%20-%20Python%20SDK&description=OutputMessageStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagestatusinprogress.mdx b/client-sdks/python/components/outputmessagestatusinprogress.mdx deleted file mode 100644 index ded6a62f..00000000 --- a/client-sdks/python/components/outputmessagestatusinprogress.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OutputMessageStatusInProgress - Python SDK -description: OutputMessageStatusInProgress method reference -seoTitle: OutputMessageStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/outputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusInProgress | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusInProgress method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusInProgress%20-%20Python%20SDK&description=OutputMessageStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagestatusunion.mdx b/client-sdks/python/components/outputmessagestatusunion.mdx deleted file mode 100644 index 59890926..00000000 --- a/client-sdks/python/components/outputmessagestatusunion.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OutputMessageStatusUnion - Python SDK -description: OutputMessageStatusUnion method reference -seoTitle: OutputMessageStatusUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessagestatusunion' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusUnion | OpenRouter Python SDK -'og:description': >- - OutputMessageStatusUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusUnion%20-%20Python%20SDK&description=OutputMessageStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OutputMessageStatusCompleted` - -```python lines -value: components.OutputMessageStatusCompleted = /* values here */ -``` - -### `components.OutputMessageStatusIncomplete` - -```python lines -value: components.OutputMessageStatusIncomplete = /* values here */ -``` - -### `components.OutputMessageStatusInProgress` - -```python lines -value: components.OutputMessageStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/outputmessagetype.mdx b/client-sdks/python/components/outputmessagetype.mdx deleted file mode 100644 index b641ccc7..00000000 --- a/client-sdks/python/components/outputmessagetype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OutputMessageType - Python SDK -description: OutputMessageType method reference -seoTitle: OutputMessageType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmessagetype' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageType | OpenRouter Python SDK -'og:description': >- - OutputMessageType method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageType%20-%20Python%20SDK&description=OutputMessageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/outputmodality.mdx b/client-sdks/python/components/outputmodality.mdx deleted file mode 100644 index 28b17791..00000000 --- a/client-sdks/python/components/outputmodality.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: OutputModality - Python SDK -description: OutputModality method reference -seoTitle: OutputModality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputmodality' -'og:site_name': OpenRouter Documentation -'og:title': OutputModality | OpenRouter Python SDK -'og:description': >- - OutputModality method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModality%20-%20Python%20SDK&description=OutputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `TEXT` | text | -| `IMAGE` | image | -| `EMBEDDINGS` | embeddings | \ No newline at end of file diff --git a/client-sdks/python/components/outputtokensdetails.mdx b/client-sdks/python/components/outputtokensdetails.mdx deleted file mode 100644 index 4e6ccde4..00000000 --- a/client-sdks/python/components/outputtokensdetails.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: OutputTokensDetails - Python SDK -description: OutputTokensDetails method reference -seoTitle: OutputTokensDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/outputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': OutputTokensDetails | OpenRouter Python SDK -'og:description': >- - OutputTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTokensDetails%20-%20Python%20SDK&description=OutputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoning_tokens` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/parameter.mdx b/client-sdks/python/components/parameter.mdx deleted file mode 100644 index 803ea994..00000000 --- a/client-sdks/python/components/parameter.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Parameter - Python SDK -description: Parameter method reference -seoTitle: Parameter | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/parameter' -'og:site_name': OpenRouter Documentation -'og:title': Parameter | OpenRouter Python SDK -'og:description': >- - Parameter method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Parameter%20-%20Python%20SDK&description=Parameter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `TEMPERATURE` | temperature | -| `TOP_P` | top_p | -| `TOP_K` | top_k | -| `MIN_P` | min_p | -| `TOP_A` | top_a | -| `FREQUENCY_PENALTY` | frequency_penalty | -| `PRESENCE_PENALTY` | presence_penalty | -| `REPETITION_PENALTY` | repetition_penalty | -| `MAX_TOKENS` | max_tokens | -| `LOGIT_BIAS` | logit_bias | -| `LOGPROBS` | logprobs | -| `TOP_LOGPROBS` | top_logprobs | -| `SEED` | seed | -| `RESPONSE_FORMAT` | response_format | -| `STRUCTURED_OUTPUTS` | structured_outputs | -| `STOP` | stop | -| `TOOLS` | tools | -| `TOOL_CHOICE` | tool_choice | -| `PARALLEL_TOOL_CALLS` | parallel_tool_calls | -| `INCLUDE_REASONING` | include_reasoning | -| `REASONING` | reasoning | -| `REASONING_EFFORT` | reasoning_effort | -| `WEB_SEARCH_OPTIONS` | web_search_options | -| `VERBOSITY` | verbosity | \ No newline at end of file diff --git a/client-sdks/python/components/part1.mdx b/client-sdks/python/components/part1.mdx deleted file mode 100644 index 1df292be..00000000 --- a/client-sdks/python/components/part1.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Part1 - Python SDK -description: Part1 method reference -seoTitle: Part1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/part1' -'og:site_name': OpenRouter Documentation -'og:title': Part1 | OpenRouter Python SDK -'og:description': >- - Part1 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Part1%20-%20Python%20SDK&description=Part1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.ReasoningTextContent` - -```python lines -value: components.ReasoningTextContent = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/part2.mdx b/client-sdks/python/components/part2.mdx deleted file mode 100644 index 661ca806..00000000 --- a/client-sdks/python/components/part2.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Part2 - Python SDK -description: Part2 method reference -seoTitle: Part2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/part2' -'og:site_name': OpenRouter Documentation -'og:title': Part2 | OpenRouter Python SDK -'og:description': >- - Part2 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Part2%20-%20Python%20SDK&description=Part2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.ReasoningTextContent` - -```python lines -value: components.ReasoningTextContent = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/partition.mdx b/client-sdks/python/components/partition.mdx deleted file mode 100644 index 7cb6cc57..00000000 --- a/client-sdks/python/components/partition.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Partition - Python SDK -description: Partition method reference -seoTitle: Partition | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/partition' -'og:site_name': OpenRouter Documentation -'og:title': Partition | OpenRouter Python SDK -'og:description': >- - Partition method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Partition%20-%20Python%20SDK&description=Partition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `MODEL` | model | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/components/payloadtoolargeresponseerrordata.mdx b/client-sdks/python/components/payloadtoolargeresponseerrordata.mdx deleted file mode 100644 index 9f00cf48..00000000 --- a/client-sdks/python/components/payloadtoolargeresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PayloadTooLargeResponseErrorData - Python SDK -description: PayloadTooLargeResponseErrorData method reference -seoTitle: PayloadTooLargeResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/payloadtoolargeresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseErrorData | OpenRouter Python SDK -'og:description': >- - PayloadTooLargeResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseErrorData%20-%20Python%20SDK&description=PayloadTooLargeResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for PayloadTooLargeResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/paymentrequiredresponseerrordata.mdx b/client-sdks/python/components/paymentrequiredresponseerrordata.mdx deleted file mode 100644 index a7ec4c4e..00000000 --- a/client-sdks/python/components/paymentrequiredresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PaymentRequiredResponseErrorData - Python SDK -description: PaymentRequiredResponseErrorData method reference -seoTitle: PaymentRequiredResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/paymentrequiredresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseErrorData | OpenRouter Python SDK -'og:description': >- - PaymentRequiredResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseErrorData%20-%20Python%20SDK&description=PaymentRequiredResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for PaymentRequiredResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/pdf.mdx b/client-sdks/python/components/pdf.mdx deleted file mode 100644 index ff717f90..00000000 --- a/client-sdks/python/components/pdf.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Pdf - Python SDK -description: Pdf method reference -seoTitle: Pdf | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/pdf' -'og:site_name': OpenRouter Documentation -'og:title': Pdf | OpenRouter Python SDK -'og:description': >- - Pdf method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pdf%20-%20Python%20SDK&description=Pdf%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `engine` | [Optional[components.PdfEngine]](../components/pdfengine.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/pdfengine.mdx b/client-sdks/python/components/pdfengine.mdx deleted file mode 100644 index 825f2570..00000000 --- a/client-sdks/python/components/pdfengine.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PdfEngine - Python SDK -description: PdfEngine method reference -seoTitle: PdfEngine | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/pdfengine' -'og:site_name': OpenRouter Documentation -'og:title': PdfEngine | OpenRouter Python SDK -'og:description': >- - PdfEngine method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PdfEngine%20-%20Python%20SDK&description=PdfEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `MISTRAL_OCR` | mistral-ocr | -| `PDF_TEXT` | pdf-text | -| `NATIVE` | native | \ No newline at end of file diff --git a/client-sdks/python/components/pdfparserengine.mdx b/client-sdks/python/components/pdfparserengine.mdx deleted file mode 100644 index 85b4b7e3..00000000 --- a/client-sdks/python/components/pdfparserengine.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: PDFParserEngine - Python SDK -description: PDFParserEngine method reference -seoTitle: PDFParserEngine | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/pdfparserengine' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngine | OpenRouter Python SDK -'og:description': >- - PDFParserEngine method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngine%20-%20Python%20SDK&description=PDFParserEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The engine to use for parsing PDF files. - -## Values - -| Name | Value | -| ------------- | ------------- | -| `MISTRAL_OCR` | mistral-ocr | -| `PDF_TEXT` | pdf-text | -| `NATIVE` | native | \ No newline at end of file diff --git a/client-sdks/python/components/pdfparseroptions.mdx b/client-sdks/python/components/pdfparseroptions.mdx deleted file mode 100644 index 76c73128..00000000 --- a/client-sdks/python/components/pdfparseroptions.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: PDFParserOptions - Python SDK -description: PDFParserOptions method reference -seoTitle: PDFParserOptions | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/pdfparseroptions' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserOptions | OpenRouter Python SDK -'og:description': >- - PDFParserOptions method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserOptions%20-%20Python%20SDK&description=PDFParserOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Options for PDF parsing. - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `engine` | [Optional[components.PDFParserEngine]](../components/pdfparserengine.md) | :heavy_minus_sign: | The engine to use for parsing PDF files. | \ No newline at end of file diff --git a/client-sdks/python/components/percentilelatencycutoffs.mdx b/client-sdks/python/components/percentilelatencycutoffs.mdx deleted file mode 100644 index ea2b94c6..00000000 --- a/client-sdks/python/components/percentilelatencycutoffs.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PercentileLatencyCutoffs - Python SDK -description: PercentileLatencyCutoffs method reference -seoTitle: PercentileLatencyCutoffs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/percentilelatencycutoffs' -'og:site_name': OpenRouter Documentation -'og:title': PercentileLatencyCutoffs | OpenRouter Python SDK -'og:description': >- - PercentileLatencyCutoffs method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileLatencyCutoffs%20-%20Python%20SDK&description=PercentileLatencyCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Percentile-based latency cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/client-sdks/python/components/percentilestats.mdx b/client-sdks/python/components/percentilestats.mdx deleted file mode 100644 index a04deb33..00000000 --- a/client-sdks/python/components/percentilestats.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PercentileStats - Python SDK -description: PercentileStats method reference -seoTitle: PercentileStats | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/percentilestats' -'og:site_name': OpenRouter Documentation -'og:title': PercentileStats | OpenRouter Python SDK -'og:description': >- - PercentileStats method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileStats%20-%20Python%20SDK&description=PercentileStats%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `p50` | *float* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *float* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *float* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *float* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/client-sdks/python/components/percentilethroughputcutoffs.mdx b/client-sdks/python/components/percentilethroughputcutoffs.mdx deleted file mode 100644 index f1fb3f9f..00000000 --- a/client-sdks/python/components/percentilethroughputcutoffs.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: PercentileThroughputCutoffs - Python SDK -description: PercentileThroughputCutoffs method reference -seoTitle: PercentileThroughputCutoffs | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/percentilethroughputcutoffs' -'og:site_name': OpenRouter Documentation -'og:title': PercentileThroughputCutoffs | OpenRouter Python SDK -'og:description': >- - PercentileThroughputCutoffs method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileThroughputCutoffs%20-%20Python%20SDK&description=PercentileThroughputCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Percentile-based throughput cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `p50` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *OptionalNullable[float]* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/client-sdks/python/components/perrequestlimits.mdx b/client-sdks/python/components/perrequestlimits.mdx deleted file mode 100644 index 2f186f92..00000000 --- a/client-sdks/python/components/perrequestlimits.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PerRequestLimits - Python SDK -description: PerRequestLimits method reference -seoTitle: PerRequestLimits | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/perrequestlimits' -'og:site_name': OpenRouter Documentation -'og:title': PerRequestLimits | OpenRouter Python SDK -'og:description': >- - PerRequestLimits method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PerRequestLimits%20-%20Python%20SDK&description=PerRequestLimits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Per-request token limits - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `prompt_tokens` | *float* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | -| `completion_tokens` | *float* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | \ No newline at end of file diff --git a/client-sdks/python/components/preferredmaxlatency.mdx b/client-sdks/python/components/preferredmaxlatency.mdx deleted file mode 100644 index 8c180bdd..00000000 --- a/client-sdks/python/components/preferredmaxlatency.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PreferredMaxLatency - Python SDK -description: PreferredMaxLatency method reference -seoTitle: PreferredMaxLatency | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/preferredmaxlatency' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMaxLatency | OpenRouter Python SDK -'og:description': >- - PreferredMaxLatency method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMaxLatency%20-%20Python%20SDK&description=PreferredMaxLatency%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.PercentileLatencyCutoffs` - -```python lines -value: components.PercentileLatencyCutoffs = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/preferredminthroughput.mdx b/client-sdks/python/components/preferredminthroughput.mdx deleted file mode 100644 index 0395fffb..00000000 --- a/client-sdks/python/components/preferredminthroughput.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PreferredMinThroughput - Python SDK -description: PreferredMinThroughput method reference -seoTitle: PreferredMinThroughput | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/preferredminthroughput' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMinThroughput | OpenRouter Python SDK -'og:description': >- - PreferredMinThroughput method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMinThroughput%20-%20Python%20SDK&description=PreferredMinThroughput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `float` - -```python lines -value: float = /* values here */ -``` - -### `components.PercentileThroughputCutoffs` - -```python lines -value: components.PercentileThroughputCutoffs = /* values here */ -``` - -### `Any` - -```python lines -value: Any = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/pricing.mdx b/client-sdks/python/components/pricing.mdx deleted file mode 100644 index c04e7cef..00000000 --- a/client-sdks/python/components/pricing.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Pricing - Python SDK -description: Pricing method reference -seoTitle: Pricing | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/pricing' -'og:site_name': OpenRouter Documentation -'og:title': Pricing | OpenRouter Python SDK -'og:description': >- - Pricing method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pricing%20-%20Python%20SDK&description=Pricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `completion` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/prompt.mdx b/client-sdks/python/components/prompt.mdx deleted file mode 100644 index c0a38840..00000000 --- a/client-sdks/python/components/prompt.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Prompt - Python SDK -description: Prompt method reference -seoTitle: Prompt | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/prompt' -'og:site_name': OpenRouter Documentation -'og:title': Prompt | OpenRouter Python SDK -'og:description': >- - Prompt method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Prompt%20-%20Python%20SDK&description=Prompt%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `List[float]` - -```python lines -value: List[float] = /* values here */ -``` - -### `List[List[float]]` - -```python lines -value: List[List[float]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/prompttokensdetails.mdx b/client-sdks/python/components/prompttokensdetails.mdx deleted file mode 100644 index e6171849..00000000 --- a/client-sdks/python/components/prompttokensdetails.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PromptTokensDetails - Python SDK -description: PromptTokensDetails method reference -seoTitle: PromptTokensDetails | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/prompttokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails | OpenRouter Python SDK -'og:description': >- - PromptTokensDetails method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20Python%20SDK&description=PromptTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `cached_tokens` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `cache_write_tokens` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `audio_tokens` | *Optional[float]* | :heavy_minus_sign: | N/A | -| `video_tokens` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/providername.mdx b/client-sdks/python/components/providername.mdx deleted file mode 100644 index 16607b13..00000000 --- a/client-sdks/python/components/providername.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: ProviderName - Python SDK -description: ProviderName method reference -seoTitle: ProviderName | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providername' -'og:site_name': OpenRouter Documentation -'og:title': ProviderName | OpenRouter Python SDK -'og:description': >- - ProviderName method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderName%20-%20Python%20SDK&description=ProviderName%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `AI21` | AI21 | -| `AION_LABS` | AionLabs | -| `ALIBABA` | Alibaba | -| `AMAZON_BEDROCK` | Amazon Bedrock | -| `AMAZON_NOVA` | Amazon Nova | -| `ANTHROPIC` | Anthropic | -| `ARCEE_AI` | Arcee AI | -| `ATLAS_CLOUD` | AtlasCloud | -| `AVIAN` | Avian | -| `AZURE` | Azure | -| `BASE_TEN` | BaseTen | -| `BYTE_PLUS` | BytePlus | -| `BLACK_FOREST_LABS` | Black Forest Labs | -| `CEREBRAS` | Cerebras | -| `CHUTES` | Chutes | -| `CIRRASCALE` | Cirrascale | -| `CLARIFAI` | Clarifai | -| `CLOUDFLARE` | Cloudflare | -| `COHERE` | Cohere | -| `CRUSOE` | Crusoe | -| `DEEP_INFRA` | DeepInfra | -| `DEEP_SEEK` | DeepSeek | -| `FEATHERLESS` | Featherless | -| `FIREWORKS` | Fireworks | -| `FRIENDLI` | Friendli | -| `GMI_CLOUD` | GMICloud | -| `GOOGLE` | Google | -| `GOOGLE_AI_STUDIO` | Google AI Studio | -| `GROQ` | Groq | -| `HYPERBOLIC` | Hyperbolic | -| `INCEPTION` | Inception | -| `INCEPTRON` | Inceptron | -| `INFERENCE_NET` | InferenceNet | -| `INFERMATIC` | Infermatic | -| `INFLECTION` | Inflection | -| `LIQUID` | Liquid | -| `MARA` | Mara | -| `MANCER_2` | Mancer 2 | -| `MINIMAX` | Minimax | -| `MODEL_RUN` | ModelRun | -| `MISTRAL` | Mistral | -| `MODULAR` | Modular | -| `MOONSHOT_AI` | Moonshot AI | -| `MORPH` | Morph | -| `N_COMPASS` | NCompass | -| `NEBIUS` | Nebius | -| `NEXT_BIT` | NextBit | -| `NOVITA` | Novita | -| `NVIDIA` | Nvidia | -| `OPEN_AI` | OpenAI | -| `OPEN_INFERENCE` | OpenInference | -| `PARASAIL` | Parasail | -| `PERPLEXITY` | Perplexity | -| `PHALA` | Phala | -| `RELACE` | Relace | -| `SAMBA_NOVA` | SambaNova | -| `SEED` | Seed | -| `SILICON_FLOW` | SiliconFlow | -| `SOURCEFUL` | Sourceful | -| `STEALTH` | Stealth | -| `STREAM_LAKE` | StreamLake | -| `SWITCHPOINT` | Switchpoint | -| `TOGETHER` | Together | -| `UPSTAGE` | Upstage | -| `VENICE` | Venice | -| `WAND_B` | WandB | -| `XIAOMI` | Xiaomi | -| `X_AI` | xAI | -| `Z_AI` | Z.AI | -| `FAKE_PROVIDER` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/python/components/provideroverloadedresponseerrordata.mdx b/client-sdks/python/components/provideroverloadedresponseerrordata.mdx deleted file mode 100644 index d0333cf3..00000000 --- a/client-sdks/python/components/provideroverloadedresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ProviderOverloadedResponseErrorData - Python SDK -description: ProviderOverloadedResponseErrorData method reference -seoTitle: ProviderOverloadedResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/provideroverloadedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseErrorData | OpenRouter Python SDK -'og:description': >- - ProviderOverloadedResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseErrorData%20-%20Python%20SDK&description=ProviderOverloadedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ProviderOverloadedResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferences.mdx b/client-sdks/python/components/providerpreferences.mdx deleted file mode 100644 index c931254a..00000000 --- a/client-sdks/python/components/providerpreferences.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ProviderPreferences - Python SDK -description: ProviderPreferences method reference -seoTitle: ProviderPreferences | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferences' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferences | OpenRouter Python SDK -'og:description': >- - ProviderPreferences method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferences%20-%20Python%20SDK&description=ProviderPreferences%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider routing preferences for the request. - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allow_fallbacks` | *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.
| | -| `require_parameters` | *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. | | -| `data_collection` | [OptionalNullable[components.DataCollection]](../components/datacollection.md) | :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 | -| `zdr` | *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 | -| `enforce_distillable_text` | *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 | -| `order` | List[[components.ProviderPreferencesOrder](/client-sdks/python/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. | | -| `only` | List[[components.ProviderPreferencesOnly](/client-sdks/python/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. | | -| `ignore` | List[[components.ProviderPreferencesIgnore](/client-sdks/python/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. | | -| `quantizations` | List[[components.Quantization](/client-sdks/python/api-reference/components/quantization)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `sort` | [OptionalNullable[components.ProviderPreferencesSortUnion]](../components/providerpreferencessortunion.md) | :heavy_minus_sign: | N/A | | -| `max_price` | [Optional[components.ProviderPreferencesMaxPrice]](../components/providerpreferencesmaxprice.md) | :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. | | -| `preferred_min_throughput` | [OptionalNullable[components.PreferredMinThroughput]](../components/preferredminthroughput.md) | :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 | -| `preferred_max_latency` | [OptionalNullable[components.PreferredMaxLatency]](../components/preferredmaxlatency.md) | :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 | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesignore.mdx b/client-sdks/python/components/providerpreferencesignore.mdx deleted file mode 100644 index a37663cd..00000000 --- a/client-sdks/python/components/providerpreferencesignore.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesIgnore - Python SDK -description: ProviderPreferencesIgnore method reference -seoTitle: ProviderPreferencesIgnore | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencesignore' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesIgnore | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesIgnore method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesIgnore%20-%20Python%20SDK&description=ProviderPreferencesIgnore%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesmaxprice.mdx b/client-sdks/python/components/providerpreferencesmaxprice.mdx deleted file mode 100644 index 38e65a7e..00000000 --- a/client-sdks/python/components/providerpreferencesmaxprice.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ProviderPreferencesMaxPrice - Python SDK -description: ProviderPreferencesMaxPrice method reference -seoTitle: ProviderPreferencesMaxPrice | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencesmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesMaxPrice | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesMaxPrice method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesMaxPrice%20-%20Python%20SDK&description=ProviderPreferencesMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `completion` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesonly.mdx b/client-sdks/python/components/providerpreferencesonly.mdx deleted file mode 100644 index 7fd6345c..00000000 --- a/client-sdks/python/components/providerpreferencesonly.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesOnly - Python SDK -description: ProviderPreferencesOnly method reference -seoTitle: ProviderPreferencesOnly | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencesonly' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesOnly | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesOnly method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesOnly%20-%20Python%20SDK&description=ProviderPreferencesOnly%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesorder.mdx b/client-sdks/python/components/providerpreferencesorder.mdx deleted file mode 100644 index 41158766..00000000 --- a/client-sdks/python/components/providerpreferencesorder.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesOrder - Python SDK -description: ProviderPreferencesOrder method reference -seoTitle: ProviderPreferencesOrder | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencesorder' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesOrder | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesOrder method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesOrder%20-%20Python%20SDK&description=ProviderPreferencesOrder%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderName` - -```python lines -value: components.ProviderName = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencespartition.mdx b/client-sdks/python/components/providerpreferencespartition.mdx deleted file mode 100644 index f18e69ec..00000000 --- a/client-sdks/python/components/providerpreferencespartition.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ProviderPreferencesPartition - Python SDK -description: ProviderPreferencesPartition method reference -seoTitle: ProviderPreferencesPartition | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencespartition' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesPartition | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesPartition method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesPartition%20-%20Python%20SDK&description=ProviderPreferencesPartition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `MODEL` | model | -| `NONE` | none | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesprovidersort.mdx b/client-sdks/python/components/providerpreferencesprovidersort.mdx deleted file mode 100644 index f0588926..00000000 --- a/client-sdks/python/components/providerpreferencesprovidersort.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ProviderPreferencesProviderSort - Python SDK -description: ProviderPreferencesProviderSort method reference -seoTitle: ProviderPreferencesProviderSort | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/providerpreferencesprovidersort -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesProviderSort | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesProviderSort method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesProviderSort%20-%20Python%20SDK&description=ProviderPreferencesProviderSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencesprovidersortconfig.mdx b/client-sdks/python/components/providerpreferencesprovidersortconfig.mdx deleted file mode 100644 index 3f2eadb7..00000000 --- a/client-sdks/python/components/providerpreferencesprovidersortconfig.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ProviderPreferencesProviderSortConfig - Python SDK -description: ProviderPreferencesProviderSortConfig method reference -seoTitle: ProviderPreferencesProviderSortConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/providerpreferencesprovidersortconfig -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesProviderSortConfig | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesProviderSortConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesProviderSortConfig%20-%20Python%20SDK&description=ProviderPreferencesProviderSortConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `by` | [OptionalNullable[components.ProviderSort]](../components/providersort.md) | :heavy_minus_sign: | N/A | price | -| `partition` | [OptionalNullable[components.ProviderPreferencesPartition]](../components/providerpreferencespartition.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/providerpreferencessortunion.mdx b/client-sdks/python/components/providerpreferencessortunion.mdx deleted file mode 100644 index d54c5960..00000000 --- a/client-sdks/python/components/providerpreferencessortunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ProviderPreferencesSortUnion - Python SDK -description: ProviderPreferencesSortUnion method reference -seoTitle: ProviderPreferencesSortUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providerpreferencessortunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesSortUnion | OpenRouter Python SDK -'og:description': >- - ProviderPreferencesSortUnion method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesSortUnion%20-%20Python%20SDK&description=ProviderPreferencesSortUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `components.ProviderPreferencesProviderSort` - -```python lines -value: components.ProviderPreferencesProviderSort = /* values here */ -``` - -### `components.ProviderSortConfigUnion` - -```python lines -value: components.ProviderSortConfigUnion = /* values here */ -``` - -### `components.SortEnum` - -```python lines -value: components.SortEnum = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/providersort.mdx b/client-sdks/python/components/providersort.mdx deleted file mode 100644 index 03fb16b1..00000000 --- a/client-sdks/python/components/providersort.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ProviderSort - Python SDK -description: ProviderSort method reference -seoTitle: ProviderSort | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providersort' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSort | OpenRouter Python SDK -'og:description': >- - ProviderSort method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSort%20-%20Python%20SDK&description=ProviderSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | \ No newline at end of file diff --git a/client-sdks/python/components/providersortconfig.mdx b/client-sdks/python/components/providersortconfig.mdx deleted file mode 100644 index eb9c32de..00000000 --- a/client-sdks/python/components/providersortconfig.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ProviderSortConfig - Python SDK -description: ProviderSortConfig method reference -seoTitle: ProviderSortConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providersortconfig' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfig | OpenRouter Python SDK -'og:description': >- - ProviderSortConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfig%20-%20Python%20SDK&description=ProviderSortConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `by` | [OptionalNullable[components.ProviderSort]](../components/providersort.md) | :heavy_minus_sign: | N/A | price | -| `partition` | [OptionalNullable[components.Partition]](../components/partition.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/providersortconfigenum.mdx b/client-sdks/python/components/providersortconfigenum.mdx deleted file mode 100644 index 01a162ff..00000000 --- a/client-sdks/python/components/providersortconfigenum.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ProviderSortConfigEnum - Python SDK -description: ProviderSortConfigEnum method reference -seoTitle: ProviderSortConfigEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providersortconfigenum' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfigEnum | OpenRouter Python SDK -'og:description': >- - ProviderSortConfigEnum method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfigEnum%20-%20Python%20SDK&description=ProviderSortConfigEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | \ No newline at end of file diff --git a/client-sdks/python/components/providersortconfigunion.mdx b/client-sdks/python/components/providersortconfigunion.mdx deleted file mode 100644 index 98281d00..00000000 --- a/client-sdks/python/components/providersortconfigunion.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderSortConfigUnion - Python SDK -description: ProviderSortConfigUnion method reference -seoTitle: ProviderSortConfigUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providersortconfigunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfigUnion | OpenRouter Python SDK -'og:description': >- - ProviderSortConfigUnion method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfigUnion%20-%20Python%20SDK&description=ProviderSortConfigUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderPreferencesProviderSortConfig` - -```python lines -value: components.ProviderPreferencesProviderSortConfig = /* values here */ -``` - -### `components.ProviderSortConfigEnum` - -```python lines -value: components.ProviderSortConfigEnum = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/providersortunion.mdx b/client-sdks/python/components/providersortunion.mdx deleted file mode 100644 index b93cbfee..00000000 --- a/client-sdks/python/components/providersortunion.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderSortUnion - Python SDK -description: ProviderSortUnion method reference -seoTitle: ProviderSortUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/providersortunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortUnion | OpenRouter Python SDK -'og:description': >- - ProviderSortUnion method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortUnion%20-%20Python%20SDK&description=ProviderSortUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ProviderSort` - -```python lines -value: components.ProviderSort = /* values here */ -``` - -### `components.ProviderSortConfig` - -```python lines -value: components.ProviderSortConfig = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/publicendpoint.mdx b/client-sdks/python/components/publicendpoint.mdx deleted file mode 100644 index a44224a9..00000000 --- a/client-sdks/python/components/publicendpoint.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PublicEndpoint - Python SDK -description: PublicEndpoint method reference -seoTitle: PublicEndpoint | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/publicendpoint' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpoint | OpenRouter Python SDK -'og:description': >- - PublicEndpoint method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpoint%20-%20Python%20SDK&description=PublicEndpoint%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about a specific model endpoint - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | N/A | | -| `model_name` | *str* | :heavy_check_mark: | N/A | | -| `context_length` | *float* | :heavy_check_mark: | N/A | | -| `pricing` | [components.Pricing](/client-sdks/python/api-reference/components/pricing) | :heavy_check_mark: | N/A | | -| `provider_name` | [components.ProviderName](/client-sdks/python/api-reference/components/providername) | :heavy_check_mark: | N/A | OpenAI | -| `tag` | *str* | :heavy_check_mark: | N/A | | -| `quantization` | [Nullable[components.PublicEndpointQuantization]](../components/publicendpointquantization.md) | :heavy_check_mark: | N/A | fp16 | -| `max_completion_tokens` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `max_prompt_tokens` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `supported_parameters` | List[[components.Parameter](/client-sdks/python/api-reference/components/parameter)] | :heavy_check_mark: | N/A | | -| `status` | [Optional[components.EndpointStatus]](../components/endpointstatus.md) | :heavy_minus_sign: | N/A | 0 | -| `uptime_last_30m` | *Nullable[float]* | :heavy_check_mark: | N/A | | -| `supports_implicit_caching` | *bool* | :heavy_check_mark: | N/A | | -| `latency_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.md) | :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. | | -| `throughput_last_30m` | [Nullable[components.PercentileStats]](../components/percentilestats.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/publicendpointquantization.mdx b/client-sdks/python/components/publicendpointquantization.mdx deleted file mode 100644 index eabfdd75..00000000 --- a/client-sdks/python/components/publicendpointquantization.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: PublicEndpointQuantization - Python SDK -description: PublicEndpointQuantization method reference -seoTitle: PublicEndpointQuantization | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/publicendpointquantization' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpointQuantization | OpenRouter Python SDK -'og:description': >- - PublicEndpointQuantization method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpointQuantization%20-%20Python%20SDK&description=PublicEndpointQuantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `INT4` | int4 | -| `INT8` | int8 | -| `FP4` | fp4 | -| `FP6` | fp6 | -| `FP8` | fp8 | -| `FP16` | fp16 | -| `BF16` | bf16 | -| `FP32` | fp32 | -| `UNKNOWN` | unknown | \ No newline at end of file diff --git a/client-sdks/python/components/publicpricing.mdx b/client-sdks/python/components/publicpricing.mdx deleted file mode 100644 index 338b86bb..00000000 --- a/client-sdks/python/components/publicpricing.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PublicPricing - Python SDK -description: PublicPricing method reference -seoTitle: PublicPricing | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/publicpricing' -'og:site_name': OpenRouter Documentation -'og:title': PublicPricing | OpenRouter Python SDK -'og:description': >- - PublicPricing method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicPricing%20-%20Python%20SDK&description=PublicPricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Pricing information for the model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `completion` | *str* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `request` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image_token` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image_output` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_audio_cache` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `web_search` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `internal_reasoning` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_cache_read` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `input_cache_write` | *Optional[str]* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `discount` | *Optional[float]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/quantization.mdx b/client-sdks/python/components/quantization.mdx deleted file mode 100644 index 5dd4184c..00000000 --- a/client-sdks/python/components/quantization.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Quantization - Python SDK -description: Quantization method reference -seoTitle: Quantization | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/quantization' -'og:site_name': OpenRouter Documentation -'og:title': Quantization | OpenRouter Python SDK -'og:description': >- - Quantization method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantization%20-%20Python%20SDK&description=Quantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `INT4` | int4 | -| `INT8` | int8 | -| `FP4` | fp4 | -| `FP6` | fp6 | -| `FP8` | fp8 | -| `FP16` | fp16 | -| `BF16` | bf16 | -| `FP32` | fp32 | -| `UNKNOWN` | unknown | \ No newline at end of file diff --git a/client-sdks/python/components/quantizations.mdx b/client-sdks/python/components/quantizations.mdx deleted file mode 100644 index db4c3739..00000000 --- a/client-sdks/python/components/quantizations.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Quantizations - Python SDK -description: Quantizations method reference -seoTitle: Quantizations | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/quantizations' -'og:site_name': OpenRouter Documentation -'og:title': Quantizations | OpenRouter Python SDK -'og:description': >- - Quantizations method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantizations%20-%20Python%20SDK&description=Quantizations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `INT4` | int4 | -| `INT8` | int8 | -| `FP4` | fp4 | -| `FP6` | fp6 | -| `FP8` | fp8 | -| `FP16` | fp16 | -| `BF16` | bf16 | -| `FP32` | fp32 | -| `UNKNOWN` | unknown | \ No newline at end of file diff --git a/client-sdks/python/components/reason.mdx b/client-sdks/python/components/reason.mdx deleted file mode 100644 index 21237cbe..00000000 --- a/client-sdks/python/components/reason.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Reason - Python SDK -description: Reason method reference -seoTitle: Reason | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reason' -'og:site_name': OpenRouter Documentation -'og:title': Reason | OpenRouter Python SDK -'og:description': >- - Reason method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reason%20-%20Python%20SDK&description=Reason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `MAX_OUTPUT_TOKENS` | max_output_tokens | -| `CONTENT_FILTER` | content_filter | \ No newline at end of file diff --git a/client-sdks/python/components/reasoning.mdx b/client-sdks/python/components/reasoning.mdx deleted file mode 100644 index d8ff297a..00000000 --- a/client-sdks/python/components/reasoning.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Reasoning - Python SDK -description: Reasoning method reference -seoTitle: Reasoning | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoning' -'og:site_name': OpenRouter Documentation -'og:title': Reasoning | OpenRouter Python SDK -'og:description': >- - Reasoning method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reasoning%20-%20Python%20SDK&description=Reasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `effort` | [OptionalNullable[components.Effort]](../components/effort.md) | :heavy_minus_sign: | N/A | -| `summary` | [OptionalNullable[components.ReasoningSummaryVerbosity]](../components/reasoningsummaryverbosity.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/reasoningsummarytext.mdx b/client-sdks/python/components/reasoningsummarytext.mdx deleted file mode 100644 index e0c37841..00000000 --- a/client-sdks/python/components/reasoningsummarytext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ReasoningSummaryText - Python SDK -description: ReasoningSummaryText method reference -seoTitle: ReasoningSummaryText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoningsummarytext' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryText | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryText%20-%20Python%20SDK&description=ReasoningSummaryText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ReasoningSummaryTextType](/client-sdks/python/api-reference/components/reasoningsummarytexttype) | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/reasoningsummarytexttype.mdx b/client-sdks/python/components/reasoningsummarytexttype.mdx deleted file mode 100644 index 57c4696d..00000000 --- a/client-sdks/python/components/reasoningsummarytexttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ReasoningSummaryTextType - Python SDK -description: ReasoningSummaryTextType method reference -seoTitle: ReasoningSummaryTextType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoningsummarytexttype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextType | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextType%20-%20Python%20SDK&description=ReasoningSummaryTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `SUMMARY_TEXT` | summary_text | \ No newline at end of file diff --git a/client-sdks/python/components/reasoningsummaryverbosity.mdx b/client-sdks/python/components/reasoningsummaryverbosity.mdx deleted file mode 100644 index 7637e0ab..00000000 --- a/client-sdks/python/components/reasoningsummaryverbosity.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ReasoningSummaryVerbosity - Python SDK -description: ReasoningSummaryVerbosity method reference -seoTitle: ReasoningSummaryVerbosity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoningsummaryverbosity' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryVerbosity | OpenRouter Python SDK -'og:description': >- - ReasoningSummaryVerbosity method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryVerbosity%20-%20Python%20SDK&description=ReasoningSummaryVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `CONCISE` | concise | -| `DETAILED` | detailed | \ No newline at end of file diff --git a/client-sdks/python/components/reasoningtextcontent.mdx b/client-sdks/python/components/reasoningtextcontent.mdx deleted file mode 100644 index a85ba23c..00000000 --- a/client-sdks/python/components/reasoningtextcontent.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ReasoningTextContent - Python SDK -description: ReasoningTextContent method reference -seoTitle: ReasoningTextContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoningtextcontent' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContent | OpenRouter Python SDK -'og:description': >- - ReasoningTextContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContent%20-%20Python%20SDK&description=ReasoningTextContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ReasoningTextContentType](/client-sdks/python/api-reference/components/reasoningtextcontenttype) | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/reasoningtextcontenttype.mdx b/client-sdks/python/components/reasoningtextcontenttype.mdx deleted file mode 100644 index b3184854..00000000 --- a/client-sdks/python/components/reasoningtextcontenttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ReasoningTextContentType - Python SDK -description: ReasoningTextContentType method reference -seoTitle: ReasoningTextContentType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/reasoningtextcontenttype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContentType | OpenRouter Python SDK -'og:description': >- - ReasoningTextContentType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContentType%20-%20Python%20SDK&description=ReasoningTextContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------- | ---------------- | -| `REASONING_TEXT` | reasoning_text | \ No newline at end of file diff --git a/client-sdks/python/components/requesttimeoutresponseerrordata.mdx b/client-sdks/python/components/requesttimeoutresponseerrordata.mdx deleted file mode 100644 index a1379446..00000000 --- a/client-sdks/python/components/requesttimeoutresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: RequestTimeoutResponseErrorData - Python SDK -description: RequestTimeoutResponseErrorData method reference -seoTitle: RequestTimeoutResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/requesttimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseErrorData | OpenRouter Python SDK -'og:description': >- - RequestTimeoutResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseErrorData%20-%20Python%20SDK&description=RequestTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for RequestTimeoutResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseformatjsonschema.mdx b/client-sdks/python/components/responseformatjsonschema.mdx deleted file mode 100644 index a3f01d76..00000000 --- a/client-sdks/python/components/responseformatjsonschema.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponseFormatJSONSchema - Python SDK -description: ResponseFormatJSONSchema method reference -seoTitle: ResponseFormatJSONSchema | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseformatjsonschema' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatJSONSchema | OpenRouter Python SDK -'og:description': >- - ResponseFormatJSONSchema method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatJSONSchema%20-%20Python%20SDK&description=ResponseFormatJSONSchema%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | *Literal["json_schema"]* | :heavy_check_mark: | N/A | -| `json_schema` | [components.JSONSchemaConfig](/client-sdks/python/components/jsonschemaconfig) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseformattextconfig.mdx b/client-sdks/python/components/responseformattextconfig.mdx deleted file mode 100644 index 2f71b104..00000000 --- a/client-sdks/python/components/responseformattextconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ResponseFormatTextConfig - Python SDK -description: ResponseFormatTextConfig method reference -seoTitle: ResponseFormatTextConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseformattextconfig' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatTextConfig | OpenRouter Python SDK -'og:description': >- - ResponseFormatTextConfig method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatTextConfig%20-%20Python%20SDK&description=ResponseFormatTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text response format configuration - -## Supported Types - -### `components.ResponsesFormatText` - -```python lines -value: components.ResponsesFormatText = /* values here */ -``` - -### `components.ResponsesFormatJSONObject` - -```python lines -value: components.ResponsesFormatJSONObject = /* values here */ -``` - -### `components.ResponsesFormatTextJSONSchemaConfig` - -```python lines -value: components.ResponsesFormatTextJSONSchemaConfig = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responseformattextgrammar.mdx b/client-sdks/python/components/responseformattextgrammar.mdx deleted file mode 100644 index 0c6f84bb..00000000 --- a/client-sdks/python/components/responseformattextgrammar.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponseFormatTextGrammar - Python SDK -description: ResponseFormatTextGrammar method reference -seoTitle: ResponseFormatTextGrammar | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseformattextgrammar' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatTextGrammar | OpenRouter Python SDK -'og:description': >- - ResponseFormatTextGrammar method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatTextGrammar%20-%20Python%20SDK&description=ResponseFormatTextGrammar%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `type` | *Literal["grammar"]* | :heavy_check_mark: | N/A | -| `grammar` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputaudio.mdx b/client-sdks/python/components/responseinputaudio.mdx deleted file mode 100644 index e68cbcf3..00000000 --- a/client-sdks/python/components/responseinputaudio.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseInputAudio - Python SDK -description: ResponseInputAudio method reference -seoTitle: ResponseInputAudio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudio | OpenRouter Python SDK -'og:description': >- - ResponseInputAudio method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudio%20-%20Python%20SDK&description=ResponseInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Audio input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.ResponseInputAudioType](/client-sdks/python/components/responseinputaudiotype) | :heavy_check_mark: | N/A | -| `input_audio` | [components.ResponseInputAudioInputAudio](/client-sdks/python/components/responseinputaudioinputaudio) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputaudioformat.mdx b/client-sdks/python/components/responseinputaudioformat.mdx deleted file mode 100644 index 5ae690f5..00000000 --- a/client-sdks/python/components/responseinputaudioformat.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponseInputAudioFormat - Python SDK -description: ResponseInputAudioFormat method reference -seoTitle: ResponseInputAudioFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputaudioformat' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudioFormat | OpenRouter Python SDK -'og:description': >- - ResponseInputAudioFormat method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudioFormat%20-%20Python%20SDK&description=ResponseInputAudioFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----- | ----- | -| `MP3` | mp3 | -| `WAV` | wav | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputaudioinputaudio.mdx b/client-sdks/python/components/responseinputaudioinputaudio.mdx deleted file mode 100644 index f2cb46cf..00000000 --- a/client-sdks/python/components/responseinputaudioinputaudio.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponseInputAudioInputAudio - Python SDK -description: ResponseInputAudioInputAudio method reference -seoTitle: ResponseInputAudioInputAudio | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputaudioinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudioInputAudio | OpenRouter Python SDK -'og:description': >- - ResponseInputAudioInputAudio method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudioInputAudio%20-%20Python%20SDK&description=ResponseInputAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | *str* | :heavy_check_mark: | N/A | -| `format_` | [components.ResponseInputAudioFormat](/client-sdks/python/components/responseinputaudioformat) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputaudiotype.mdx b/client-sdks/python/components/responseinputaudiotype.mdx deleted file mode 100644 index a2e50d42..00000000 --- a/client-sdks/python/components/responseinputaudiotype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseInputAudioType - Python SDK -description: ResponseInputAudioType method reference -seoTitle: ResponseInputAudioType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputaudiotype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudioType | OpenRouter Python SDK -'og:description': >- - ResponseInputAudioType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudioType%20-%20Python%20SDK&description=ResponseInputAudioType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_AUDIO` | input_audio | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputfile.mdx b/client-sdks/python/components/responseinputfile.mdx deleted file mode 100644 index 2fc8042b..00000000 --- a/client-sdks/python/components/responseinputfile.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ResponseInputFile - Python SDK -description: ResponseInputFile method reference -seoTitle: ResponseInputFile | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputfile' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputFile | OpenRouter Python SDK -'og:description': >- - ResponseInputFile method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputFile%20-%20Python%20SDK&description=ResponseInputFile%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -File input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.ResponseInputFileType](/client-sdks/python/components/responseinputfiletype) | :heavy_check_mark: | N/A | -| `file_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `file_data` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `filename` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `file_url` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputfiletype.mdx b/client-sdks/python/components/responseinputfiletype.mdx deleted file mode 100644 index fee14418..00000000 --- a/client-sdks/python/components/responseinputfiletype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseInputFileType - Python SDK -description: ResponseInputFileType method reference -seoTitle: ResponseInputFileType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputfiletype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputFileType | OpenRouter Python SDK -'og:description': >- - ResponseInputFileType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputFileType%20-%20Python%20SDK&description=ResponseInputFileType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INPUT_FILE` | input_file | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputimage.mdx b/client-sdks/python/components/responseinputimage.mdx deleted file mode 100644 index 841ca35e..00000000 --- a/client-sdks/python/components/responseinputimage.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponseInputImage - Python SDK -description: ResponseInputImage method reference -seoTitle: ResponseInputImage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputimage' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImage | OpenRouter Python SDK -'og:description': >- - ResponseInputImage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImage%20-%20Python%20SDK&description=ResponseInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [components.ResponseInputImageType](/client-sdks/python/components/responseinputimagetype) | :heavy_check_mark: | N/A | -| `detail` | [components.ResponseInputImageDetail](/client-sdks/python/components/responseinputimagedetail) | :heavy_check_mark: | N/A | -| `image_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputimagedetail.mdx b/client-sdks/python/components/responseinputimagedetail.mdx deleted file mode 100644 index 6ee5f630..00000000 --- a/client-sdks/python/components/responseinputimagedetail.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseInputImageDetail - Python SDK -description: ResponseInputImageDetail method reference -seoTitle: ResponseInputImageDetail | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputimagedetail' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImageDetail | OpenRouter Python SDK -'og:description': >- - ResponseInputImageDetail method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImageDetail%20-%20Python%20SDK&description=ResponseInputImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | -| `HIGH` | high | -| `LOW` | low | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputimagetype.mdx b/client-sdks/python/components/responseinputimagetype.mdx deleted file mode 100644 index 10ef6528..00000000 --- a/client-sdks/python/components/responseinputimagetype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseInputImageType - Python SDK -description: ResponseInputImageType method reference -seoTitle: ResponseInputImageType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputimagetype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImageType | OpenRouter Python SDK -'og:description': >- - ResponseInputImageType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImageType%20-%20Python%20SDK&description=ResponseInputImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_IMAGE` | input_image | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputtext.mdx b/client-sdks/python/components/responseinputtext.mdx deleted file mode 100644 index 02ad1ae0..00000000 --- a/client-sdks/python/components/responseinputtext.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseInputText - Python SDK -description: ResponseInputText method reference -seoTitle: ResponseInputText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputtext' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputText | OpenRouter Python SDK -'og:description': >- - ResponseInputText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputText%20-%20Python%20SDK&description=ResponseInputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text input content item - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [components.ResponseInputTextType](/client-sdks/python/components/responseinputtexttype) | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputtexttype.mdx b/client-sdks/python/components/responseinputtexttype.mdx deleted file mode 100644 index b9e2232c..00000000 --- a/client-sdks/python/components/responseinputtexttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseInputTextType - Python SDK -description: ResponseInputTextType method reference -seoTitle: ResponseInputTextType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputtexttype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputTextType | OpenRouter Python SDK -'og:description': >- - ResponseInputTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputTextType%20-%20Python%20SDK&description=ResponseInputTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INPUT_TEXT` | input_text | \ No newline at end of file diff --git a/client-sdks/python/components/responseinputvideo.mdx b/client-sdks/python/components/responseinputvideo.mdx deleted file mode 100644 index 00e56243..00000000 --- a/client-sdks/python/components/responseinputvideo.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseInputVideo - Python SDK -description: ResponseInputVideo method reference -seoTitle: ResponseInputVideo | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputvideo' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputVideo | OpenRouter Python SDK -'og:description': >- - ResponseInputVideo method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputVideo%20-%20Python%20SDK&description=ResponseInputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Video input content item - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [components.ResponseInputVideoType](/client-sdks/python/components/responseinputvideotype) | :heavy_check_mark: | N/A | -| `video_url` | *str* | :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/client-sdks/python/components/responseinputvideotype.mdx b/client-sdks/python/components/responseinputvideotype.mdx deleted file mode 100644 index dbf55941..00000000 --- a/client-sdks/python/components/responseinputvideotype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseInputVideoType - Python SDK -description: ResponseInputVideoType method reference -seoTitle: ResponseInputVideoType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseinputvideotype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputVideoType | OpenRouter Python SDK -'og:description': >- - ResponseInputVideoType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputVideoType%20-%20Python%20SDK&description=ResponseInputVideoType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `INPUT_VIDEO` | input_video | \ No newline at end of file diff --git a/client-sdks/python/components/responseoutputtext.mdx b/client-sdks/python/components/responseoutputtext.mdx deleted file mode 100644 index 007f24f5..00000000 --- a/client-sdks/python/components/responseoutputtext.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseOutputText - Python SDK -description: ResponseOutputText method reference -seoTitle: ResponseOutputText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseoutputtext' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputText | OpenRouter Python SDK -'og:description': >- - ResponseOutputText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputText%20-%20Python%20SDK&description=ResponseOutputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [components.ResponseOutputTextType](/client-sdks/python/api-reference/components/responseoutputtexttype) | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | -| `annotations` | List[[components.OpenAIResponsesAnnotation](/client-sdks/python/api-reference/components/openairesponsesannotation)] | :heavy_minus_sign: | N/A | -| `logprobs` | List[[components.Logprob](/client-sdks/python/api-reference/components/logprob)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseoutputtexttoplogprob.mdx b/client-sdks/python/components/responseoutputtexttoplogprob.mdx deleted file mode 100644 index 6085dd06..00000000 --- a/client-sdks/python/components/responseoutputtexttoplogprob.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseOutputTextTopLogprob - Python SDK -description: ResponseOutputTextTopLogprob method reference -seoTitle: ResponseOutputTextTopLogprob | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseoutputtexttoplogprob' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextTopLogprob | OpenRouter Python SDK -'og:description': >- - ResponseOutputTextTopLogprob method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextTopLogprob%20-%20Python%20SDK&description=ResponseOutputTextTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *str* | :heavy_check_mark: | N/A | -| `bytes_` | List[*float*] | :heavy_check_mark: | N/A | -| `logprob` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseoutputtexttype.mdx b/client-sdks/python/components/responseoutputtexttype.mdx deleted file mode 100644 index 197dbe62..00000000 --- a/client-sdks/python/components/responseoutputtexttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponseOutputTextType - Python SDK -description: ResponseOutputTextType method reference -seoTitle: ResponseOutputTextType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseoutputtexttype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextType | OpenRouter Python SDK -'og:description': >- - ResponseOutputTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextType%20-%20Python%20SDK&description=ResponseOutputTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `OUTPUT_TEXT` | output_text | \ No newline at end of file diff --git a/client-sdks/python/components/responseserrorfield.mdx b/client-sdks/python/components/responseserrorfield.mdx deleted file mode 100644 index 2e5d24bd..00000000 --- a/client-sdks/python/components/responseserrorfield.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponsesErrorField - Python SDK -description: ResponsesErrorField method reference -seoTitle: ResponsesErrorField | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseserrorfield' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesErrorField | OpenRouter Python SDK -'og:description': >- - ResponsesErrorField method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesErrorField%20-%20Python%20SDK&description=ResponsesErrorField%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error information returned from the API - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `code` | [components.CodeEnum](/client-sdks/python/components/codeenum) | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformatjsonobject.mdx b/client-sdks/python/components/responsesformatjsonobject.mdx deleted file mode 100644 index 5f58f108..00000000 --- a/client-sdks/python/components/responsesformatjsonobject.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesFormatJSONObject - Python SDK -description: ResponsesFormatJSONObject method reference -seoTitle: ResponsesFormatJSONObject | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesformatjsonobject' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatJSONObject | OpenRouter Python SDK -'og:description': >- - ResponsesFormatJSONObject method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatJSONObject%20-%20Python%20SDK&description=ResponsesFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON object response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `type` | [components.ResponsesFormatJSONObjectType](/client-sdks/python/components/responsesformatjsonobjecttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformatjsonobjecttype.mdx b/client-sdks/python/components/responsesformatjsonobjecttype.mdx deleted file mode 100644 index 2bec87f4..00000000 --- a/client-sdks/python/components/responsesformatjsonobjecttype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesFormatJSONObjectType - Python SDK -description: ResponsesFormatJSONObjectType method reference -seoTitle: ResponsesFormatJSONObjectType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesformatjsonobjecttype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatJSONObjectType | OpenRouter Python SDK -'og:description': >- - ResponsesFormatJSONObjectType method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatJSONObjectType%20-%20Python%20SDK&description=ResponsesFormatJSONObjectType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_OBJECT` | json_object | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformattext.mdx b/client-sdks/python/components/responsesformattext.mdx deleted file mode 100644 index e3abde59..00000000 --- a/client-sdks/python/components/responsesformattext.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesFormatText - Python SDK -description: ResponsesFormatText method reference -seoTitle: ResponsesFormatText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesformattext' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatText | OpenRouter Python SDK -'og:description': >- - ResponsesFormatText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatText%20-%20Python%20SDK&description=ResponsesFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Plain text response format - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | [components.ResponsesFormatTextType](/client-sdks/python/components/responsesformattexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformattextjsonschemaconfig.mdx b/client-sdks/python/components/responsesformattextjsonschemaconfig.mdx deleted file mode 100644 index cf1721fd..00000000 --- a/client-sdks/python/components/responsesformattextjsonschemaconfig.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ResponsesFormatTextJSONSchemaConfig - Python SDK -description: ResponsesFormatTextJSONSchemaConfig method reference -seoTitle: ResponsesFormatTextJSONSchemaConfig | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesformattextjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatTextJSONSchemaConfig | OpenRouter Python SDK -'og:description': >- - ResponsesFormatTextJSONSchemaConfig method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatTextJSONSchemaConfig%20-%20Python%20SDK&description=ResponsesFormatTextJSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -JSON schema constrained response format - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [components.ResponsesFormatTextJSONSchemaConfigType](/client-sdks/python/components/responsesformattextjsonschemaconfigtype) | :heavy_check_mark: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | -| `schema_` | Dict[str, *Nullable[Any]*] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformattextjsonschemaconfigtype.mdx b/client-sdks/python/components/responsesformattextjsonschemaconfigtype.mdx deleted file mode 100644 index 0135a426..00000000 --- a/client-sdks/python/components/responsesformattextjsonschemaconfigtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesFormatTextJSONSchemaConfigType - Python SDK -description: ResponsesFormatTextJSONSchemaConfigType method reference -seoTitle: ResponsesFormatTextJSONSchemaConfigType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesformattextjsonschemaconfigtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatTextJSONSchemaConfigType | OpenRouter Python SDK -'og:description': >- - ResponsesFormatTextJSONSchemaConfigType method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatTextJSONSchemaConfigType%20-%20Python%20SDK&description=ResponsesFormatTextJSONSchemaConfigType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `JSON_SCHEMA` | json_schema | \ No newline at end of file diff --git a/client-sdks/python/components/responsesformattexttype.mdx b/client-sdks/python/components/responsesformattexttype.mdx deleted file mode 100644 index b9b2c357..00000000 --- a/client-sdks/python/components/responsesformattexttype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponsesFormatTextType - Python SDK -description: ResponsesFormatTextType method reference -seoTitle: ResponsesFormatTextType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesformattexttype' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatTextType | OpenRouter Python SDK -'og:description': >- - ResponsesFormatTextType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatTextType%20-%20Python%20SDK&description=ResponsesFormatTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/components/responsesimagegenerationcall.mdx b/client-sdks/python/components/responsesimagegenerationcall.mdx deleted file mode 100644 index d90528e6..00000000 --- a/client-sdks/python/components/responsesimagegenerationcall.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponsesImageGenerationCall - Python SDK -description: ResponsesImageGenerationCall method reference -seoTitle: ResponsesImageGenerationCall | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesimagegenerationcall' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesImageGenerationCall | OpenRouter Python SDK -'og:description': >- - ResponsesImageGenerationCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesImageGenerationCall%20-%20Python%20SDK&description=ResponsesImageGenerationCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [components.ResponsesImageGenerationCallType](/client-sdks/python/components/responsesimagegenerationcalltype) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `result` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [components.ImageGenerationStatus](/client-sdks/python/api-reference/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responsesimagegenerationcalltype.mdx b/client-sdks/python/components/responsesimagegenerationcalltype.mdx deleted file mode 100644 index 80d3ac88..00000000 --- a/client-sdks/python/components/responsesimagegenerationcalltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesImageGenerationCallType - Python SDK -description: ResponsesImageGenerationCallType method reference -seoTitle: ResponsesImageGenerationCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesImageGenerationCallType | OpenRouter Python SDK -'og:description': >- - ResponsesImageGenerationCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesImageGenerationCallType%20-%20Python%20SDK&description=ResponsesImageGenerationCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `IMAGE_GENERATION_CALL` | image_generation_call | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitem.mdx b/client-sdks/python/components/responsesoutputitem.mdx deleted file mode 100644 index 4422ed74..00000000 --- a/client-sdks/python/components/responsesoutputitem.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: ResponsesOutputItem - Python SDK -description: ResponsesOutputItem method reference -seoTitle: ResponsesOutputItem | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputitem' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItem | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItem method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItem%20-%20Python%20SDK&description=ResponsesOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output item from the response - -## Supported Types - -### `components.ResponsesOutputMessage` - -```python lines -value: components.ResponsesOutputMessage = /* values here */ -``` - -### `components.ResponsesOutputItemReasoning` - -```python lines -value: components.ResponsesOutputItemReasoning = /* values here */ -``` - -### `components.ResponsesOutputItemFunctionCall` - -```python lines -value: components.ResponsesOutputItemFunctionCall = /* values here */ -``` - -### `components.ResponsesWebSearchCallOutput` - -```python lines -value: components.ResponsesWebSearchCallOutput = /* values here */ -``` - -### `components.ResponsesOutputItemFileSearchCall` - -```python lines -value: components.ResponsesOutputItemFileSearchCall = /* values here */ -``` - -### `components.ResponsesImageGenerationCall` - -```python lines -value: components.ResponsesImageGenerationCall = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfilesearchcall.mdx b/client-sdks/python/components/responsesoutputitemfilesearchcall.mdx deleted file mode 100644 index a6502378..00000000 --- a/client-sdks/python/components/responsesoutputitemfilesearchcall.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponsesOutputItemFileSearchCall - Python SDK -description: ResponsesOutputItemFileSearchCall method reference -seoTitle: ResponsesOutputItemFileSearchCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfilesearchcall -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFileSearchCall | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFileSearchCall method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFileSearchCall%20-%20Python%20SDK&description=ResponsesOutputItemFileSearchCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `type` | [components.ResponsesOutputItemFileSearchCallType](/client-sdks/python/components/responsesoutputitemfilesearchcalltype) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `queries` | List[*str*] | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](/client-sdks/python/components/websearchstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfilesearchcalltype.mdx b/client-sdks/python/components/responsesoutputitemfilesearchcalltype.mdx deleted file mode 100644 index 0ca7f3d2..00000000 --- a/client-sdks/python/components/responsesoutputitemfilesearchcalltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemFileSearchCallType - Python SDK -description: ResponsesOutputItemFileSearchCallType method reference -seoTitle: ResponsesOutputItemFileSearchCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfilesearchcalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFileSearchCallType | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFileSearchCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFileSearchCallType%20-%20Python%20SDK&description=ResponsesOutputItemFileSearchCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `FILE_SEARCH_CALL` | file_search_call | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncall.mdx b/client-sdks/python/components/responsesoutputitemfunctioncall.mdx deleted file mode 100644 index d5561795..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncall.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCall - Python SDK -description: ResponsesOutputItemFunctionCall method reference -seoTitle: ResponsesOutputItemFunctionCall | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncall -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCall | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCall method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCall%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.ResponsesOutputItemFunctionCallType](/client-sdks/python/components/responsesoutputitemfunctioncalltype) | :heavy_check_mark: | N/A | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `name` | *str* | :heavy_check_mark: | N/A | -| `arguments` | *str* | :heavy_check_mark: | N/A | -| `call_id` | *str* | :heavy_check_mark: | N/A | -| `status` | [Optional[components.ResponsesOutputItemFunctionCallStatusUnion]](../components/responsesoutputitemfunctioncallstatusunion.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncallstatuscompleted.mdx b/client-sdks/python/components/responsesoutputitemfunctioncallstatuscompleted.mdx deleted file mode 100644 index 5158446f..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncallstatuscompleted.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusCompleted - Python SDK -description: ResponsesOutputItemFunctionCallStatusCompleted method reference -seoTitle: ResponsesOutputItemFunctionCallStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncallstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusCompleted | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusCompleted method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusCompleted%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCallStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncallstatusincomplete.mdx b/client-sdks/python/components/responsesoutputitemfunctioncallstatusincomplete.mdx deleted file mode 100644 index 608874f3..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncallstatusincomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusIncomplete - Python SDK -description: ResponsesOutputItemFunctionCallStatusIncomplete method reference -seoTitle: ResponsesOutputItemFunctionCallStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncallstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusIncomplete | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusIncomplete method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusIncomplete%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCallStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncallstatusinprogress.mdx b/client-sdks/python/components/responsesoutputitemfunctioncallstatusinprogress.mdx deleted file mode 100644 index 13f070cf..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncallstatusinprogress.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusInProgress - Python SDK -description: ResponsesOutputItemFunctionCallStatusInProgress method reference -seoTitle: ResponsesOutputItemFunctionCallStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncallstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusInProgress | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusInProgress method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusInProgress%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCallStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncallstatusunion.mdx b/client-sdks/python/components/responsesoutputitemfunctioncallstatusunion.mdx deleted file mode 100644 index 27ff8646..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncallstatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusUnion - Python SDK -description: ResponsesOutputItemFunctionCallStatusUnion method reference -seoTitle: ResponsesOutputItemFunctionCallStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncallstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusUnion | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusUnion%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCallStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponsesOutputItemFunctionCallStatusCompleted` - -```python lines -value: components.ResponsesOutputItemFunctionCallStatusCompleted = /* values here */ -``` - -### `components.ResponsesOutputItemFunctionCallStatusIncomplete` - -```python lines -value: components.ResponsesOutputItemFunctionCallStatusIncomplete = /* values here */ -``` - -### `components.ResponsesOutputItemFunctionCallStatusInProgress` - -```python lines -value: components.ResponsesOutputItemFunctionCallStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemfunctioncalltype.mdx b/client-sdks/python/components/responsesoutputitemfunctioncalltype.mdx deleted file mode 100644 index f7ab5089..00000000 --- a/client-sdks/python/components/responsesoutputitemfunctioncalltype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallType - Python SDK -description: ResponsesOutputItemFunctionCallType method reference -seoTitle: ResponsesOutputItemFunctionCallType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemfunctioncalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallType | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemFunctionCallType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallType%20-%20Python%20SDK&description=ResponsesOutputItemFunctionCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------- | --------------- | -| `FUNCTION_CALL` | function_call | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoning.mdx b/client-sdks/python/components/responsesoutputitemreasoning.mdx deleted file mode 100644 index 7978bc07..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoning.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputItemReasoning - Python SDK -description: ResponsesOutputItemReasoning method reference -seoTitle: ResponsesOutputItemReasoning | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputitemreasoning' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoning | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoning method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoning%20-%20Python%20SDK&description=ResponsesOutputItemReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `type` | [components.ResponsesOutputItemReasoningType](/client-sdks/python/components/responsesoutputitemreasoningtype) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `content` | List[[components.ReasoningTextContent](/client-sdks/python/api-reference/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | -| `summary` | List[[components.ReasoningSummaryText](/client-sdks/python/api-reference/components/reasoningsummarytext)] | :heavy_check_mark: | N/A | | -| `encrypted_content` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `status` | [Optional[components.ResponsesOutputItemReasoningStatusUnion]](../components/responsesoutputitemreasoningstatusunion.md) | :heavy_minus_sign: | N/A | | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | -| `format_` | [OptionalNullable[components.ResponsesOutputItemReasoningFormat]](../components/responsesoutputitemreasoningformat.md) | :heavy_minus_sign: | The format of the reasoning content | anthropic-claude-v1 | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningformat.mdx b/client-sdks/python/components/responsesoutputitemreasoningformat.mdx deleted file mode 100644 index dcd9f292..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningformat.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponsesOutputItemReasoningFormat - Python SDK -description: ResponsesOutputItemReasoningFormat method reference -seoTitle: ResponsesOutputItemReasoningFormat | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningformat -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningFormat | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningFormat method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningFormat%20-%20Python%20SDK&description=ResponsesOutputItemReasoningFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The format of the reasoning content - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `UNKNOWN` | unknown | -| `OPENAI_RESPONSES_V1` | openai-responses-v1 | -| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 | -| `XAI_RESPONSES_V1` | xai-responses-v1 | -| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 | -| `GOOGLE_GEMINI_V1` | google-gemini-v1 | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningstatuscompleted.mdx b/client-sdks/python/components/responsesoutputitemreasoningstatuscompleted.mdx deleted file mode 100644 index 02bb2e2e..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningstatuscompleted.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusCompleted - Python SDK -description: ResponsesOutputItemReasoningStatusCompleted method reference -seoTitle: ResponsesOutputItemReasoningStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusCompleted | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningStatusCompleted method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusCompleted%20-%20Python%20SDK&description=ResponsesOutputItemReasoningStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningstatusincomplete.mdx b/client-sdks/python/components/responsesoutputitemreasoningstatusincomplete.mdx deleted file mode 100644 index 72fa3d8c..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningstatusincomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusIncomplete - Python SDK -description: ResponsesOutputItemReasoningStatusIncomplete method reference -seoTitle: ResponsesOutputItemReasoningStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusIncomplete | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningStatusIncomplete method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusIncomplete%20-%20Python%20SDK&description=ResponsesOutputItemReasoningStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningstatusinprogress.mdx b/client-sdks/python/components/responsesoutputitemreasoningstatusinprogress.mdx deleted file mode 100644 index 7dd26fc9..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningstatusinprogress.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusInProgress - Python SDK -description: ResponsesOutputItemReasoningStatusInProgress method reference -seoTitle: ResponsesOutputItemReasoningStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusInProgress | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningStatusInProgress method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusInProgress%20-%20Python%20SDK&description=ResponsesOutputItemReasoningStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningstatusunion.mdx b/client-sdks/python/components/responsesoutputitemreasoningstatusunion.mdx deleted file mode 100644 index 6905b4f8..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningstatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusUnion - Python SDK -description: ResponsesOutputItemReasoningStatusUnion method reference -seoTitle: ResponsesOutputItemReasoningStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusUnion | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningStatusUnion method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusUnion%20-%20Python%20SDK&description=ResponsesOutputItemReasoningStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponsesOutputItemReasoningStatusCompleted` - -```python lines -value: components.ResponsesOutputItemReasoningStatusCompleted = /* values here */ -``` - -### `components.ResponsesOutputItemReasoningStatusIncomplete` - -```python lines -value: components.ResponsesOutputItemReasoningStatusIncomplete = /* values here */ -``` - -### `components.ResponsesOutputItemReasoningStatusInProgress` - -```python lines -value: components.ResponsesOutputItemReasoningStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputitemreasoningtype.mdx b/client-sdks/python/components/responsesoutputitemreasoningtype.mdx deleted file mode 100644 index 75f20baf..00000000 --- a/client-sdks/python/components/responsesoutputitemreasoningtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputItemReasoningType - Python SDK -description: ResponsesOutputItemReasoningType method reference -seoTitle: ResponsesOutputItemReasoningType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputitemreasoningtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningType | OpenRouter Python SDK -'og:description': >- - ResponsesOutputItemReasoningType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningType%20-%20Python%20SDK&description=ResponsesOutputItemReasoningType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `REASONING` | reasoning | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessage.mdx b/client-sdks/python/components/responsesoutputmessage.mdx deleted file mode 100644 index a5718c51..00000000 --- a/client-sdks/python/components/responsesoutputmessage.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ResponsesOutputMessage - Python SDK -description: ResponsesOutputMessage method reference -seoTitle: ResponsesOutputMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputmessage' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessage | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessage method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessage%20-%20Python%20SDK&description=ResponsesOutputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -An output message item - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `role` | [components.ResponsesOutputMessageRole](/client-sdks/python/components/responsesoutputmessagerole) | :heavy_check_mark: | N/A | -| `type` | [components.ResponsesOutputMessageType](/client-sdks/python/components/responsesoutputmessagetype) | :heavy_check_mark: | N/A | -| `status` | [Optional[components.ResponsesOutputMessageStatusUnion]](../components/responsesoutputmessagestatusunion.md) | :heavy_minus_sign: | N/A | -| `content` | List[[components.ResponsesOutputMessageContent](/client-sdks/python/components/responsesoutputmessagecontent)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagecontent.mdx b/client-sdks/python/components/responsesoutputmessagecontent.mdx deleted file mode 100644 index 383b88d2..00000000 --- a/client-sdks/python/components/responsesoutputmessagecontent.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputMessageContent - Python SDK -description: ResponsesOutputMessageContent method reference -seoTitle: ResponsesOutputMessageContent | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageContent | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageContent method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageContent%20-%20Python%20SDK&description=ResponsesOutputMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponseOutputText` - -```python lines -value: components.ResponseOutputText = /* values here */ -``` - -### `components.OpenAIResponsesRefusalContent` - -```python lines -value: components.OpenAIResponsesRefusalContent = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagerole.mdx b/client-sdks/python/components/responsesoutputmessagerole.mdx deleted file mode 100644 index 81d848fd..00000000 --- a/client-sdks/python/components/responsesoutputmessagerole.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponsesOutputMessageRole - Python SDK -description: ResponsesOutputMessageRole method reference -seoTitle: ResponsesOutputMessageRole | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageRole | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageRole method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageRole%20-%20Python%20SDK&description=ResponsesOutputMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ASSISTANT` | assistant | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagestatuscompleted.mdx b/client-sdks/python/components/responsesoutputmessagestatuscompleted.mdx deleted file mode 100644 index a7554468..00000000 --- a/client-sdks/python/components/responsesoutputmessagestatuscompleted.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputMessageStatusCompleted - Python SDK -description: ResponsesOutputMessageStatusCompleted method reference -seoTitle: ResponsesOutputMessageStatusCompleted | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputmessagestatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusCompleted | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageStatusCompleted method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusCompleted%20-%20Python%20SDK&description=ResponsesOutputMessageStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `COMPLETED` | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagestatusincomplete.mdx b/client-sdks/python/components/responsesoutputmessagestatusincomplete.mdx deleted file mode 100644 index d59882ca..00000000 --- a/client-sdks/python/components/responsesoutputmessagestatusincomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputMessageStatusIncomplete - Python SDK -description: ResponsesOutputMessageStatusIncomplete method reference -seoTitle: ResponsesOutputMessageStatusIncomplete | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusIncomplete | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageStatusIncomplete method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusIncomplete%20-%20Python%20SDK&description=ResponsesOutputMessageStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagestatusinprogress.mdx b/client-sdks/python/components/responsesoutputmessagestatusinprogress.mdx deleted file mode 100644 index b7a6ede9..00000000 --- a/client-sdks/python/components/responsesoutputmessagestatusinprogress.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputMessageStatusInProgress - Python SDK -description: ResponsesOutputMessageStatusInProgress method reference -seoTitle: ResponsesOutputMessageStatusInProgress | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusInProgress | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageStatusInProgress method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusInProgress%20-%20Python%20SDK&description=ResponsesOutputMessageStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagestatusunion.mdx b/client-sdks/python/components/responsesoutputmessagestatusunion.mdx deleted file mode 100644 index 7b1156a1..00000000 --- a/client-sdks/python/components/responsesoutputmessagestatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesOutputMessageStatusUnion - Python SDK -description: ResponsesOutputMessageStatusUnion method reference -seoTitle: ResponsesOutputMessageStatusUnion | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responsesoutputmessagestatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusUnion | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageStatusUnion method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusUnion%20-%20Python%20SDK&description=ResponsesOutputMessageStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ResponsesOutputMessageStatusCompleted` - -```python lines -value: components.ResponsesOutputMessageStatusCompleted = /* values here */ -``` - -### `components.ResponsesOutputMessageStatusIncomplete` - -```python lines -value: components.ResponsesOutputMessageStatusIncomplete = /* values here */ -``` - -### `components.ResponsesOutputMessageStatusInProgress` - -```python lines -value: components.ResponsesOutputMessageStatusInProgress = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmessagetype.mdx b/client-sdks/python/components/responsesoutputmessagetype.mdx deleted file mode 100644 index ada3af81..00000000 --- a/client-sdks/python/components/responsesoutputmessagetype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ResponsesOutputMessageType - Python SDK -description: ResponsesOutputMessageType method reference -seoTitle: ResponsesOutputMessageType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputmessagetype' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageType | OpenRouter Python SDK -'og:description': >- - ResponsesOutputMessageType method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageType%20-%20Python%20SDK&description=ResponsesOutputMessageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------- | --------- | -| `MESSAGE` | message | \ No newline at end of file diff --git a/client-sdks/python/components/responsesoutputmodality.mdx b/client-sdks/python/components/responsesoutputmodality.mdx deleted file mode 100644 index 9646357e..00000000 --- a/client-sdks/python/components/responsesoutputmodality.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesOutputModality - Python SDK -description: ResponsesOutputModality method reference -seoTitle: ResponsesOutputModality | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsesoutputmodality' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputModality | OpenRouter Python SDK -'og:description': >- - ResponsesOutputModality method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputModality%20-%20Python%20SDK&description=ResponsesOutputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `TEXT` | text | -| `IMAGE` | image | \ No newline at end of file diff --git a/client-sdks/python/components/responsessearchcontextsize.mdx b/client-sdks/python/components/responsessearchcontextsize.mdx deleted file mode 100644 index 62877f0a..00000000 --- a/client-sdks/python/components/responsessearchcontextsize.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ResponsesSearchContextSize - Python SDK -description: ResponsesSearchContextSize method reference -seoTitle: ResponsesSearchContextSize | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsessearchcontextsize' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesSearchContextSize | OpenRouter Python SDK -'og:description': >- - ResponsesSearchContextSize method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesSearchContextSize%20-%20Python%20SDK&description=ResponsesSearchContextSize%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Size of the search context for web search tools - -## Values - -| Name | Value | -| -------- | -------- | -| `LOW` | low | -| `MEDIUM` | medium | -| `HIGH` | high | \ No newline at end of file diff --git a/client-sdks/python/components/responseswebsearchcalloutput.mdx b/client-sdks/python/components/responseswebsearchcalloutput.mdx deleted file mode 100644 index 97a8f9f0..00000000 --- a/client-sdks/python/components/responseswebsearchcalloutput.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponsesWebSearchCallOutput - Python SDK -description: ResponsesWebSearchCallOutput method reference -seoTitle: ResponsesWebSearchCallOutput | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responseswebsearchcalloutput' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchCallOutput | OpenRouter Python SDK -'og:description': >- - ResponsesWebSearchCallOutput method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchCallOutput%20-%20Python%20SDK&description=ResponsesWebSearchCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [components.ResponsesWebSearchCallOutputType](/client-sdks/python/components/responseswebsearchcalloutputtype) | :heavy_check_mark: | N/A | | -| `id` | *str* | :heavy_check_mark: | N/A | | -| `status` | [components.WebSearchStatus](/client-sdks/python/api-reference/components/websearchstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/python/components/responseswebsearchcalloutputtype.mdx b/client-sdks/python/components/responseswebsearchcalloutputtype.mdx deleted file mode 100644 index 1b2ec5f2..00000000 --- a/client-sdks/python/components/responseswebsearchcalloutputtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesWebSearchCallOutputType - Python SDK -description: ResponsesWebSearchCallOutputType method reference -seoTitle: ResponsesWebSearchCallOutputType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responseswebsearchcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchCallOutputType | OpenRouter Python SDK -'og:description': >- - ResponsesWebSearchCallOutputType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchCallOutputType%20-%20Python%20SDK&description=ResponsesWebSearchCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `WEB_SEARCH_CALL` | web_search_call | \ No newline at end of file diff --git a/client-sdks/python/components/responseswebsearchuserlocation.mdx b/client-sdks/python/components/responseswebsearchuserlocation.mdx deleted file mode 100644 index 8c395e4d..00000000 --- a/client-sdks/python/components/responseswebsearchuserlocation.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ResponsesWebSearchUserLocation - Python SDK -description: ResponsesWebSearchUserLocation method reference -seoTitle: ResponsesWebSearchUserLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responseswebsearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchUserLocation | OpenRouter Python SDK -'og:description': >- - ResponsesWebSearchUserLocation method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchUserLocation%20-%20Python%20SDK&description=ResponsesWebSearchUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -User location information for web search - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `type` | [Optional[components.ResponsesWebSearchUserLocationType]](../components/responseswebsearchuserlocationtype.md) | :heavy_minus_sign: | N/A | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/responseswebsearchuserlocationtype.mdx b/client-sdks/python/components/responseswebsearchuserlocationtype.mdx deleted file mode 100644 index 8ab71bf8..00000000 --- a/client-sdks/python/components/responseswebsearchuserlocationtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ResponsesWebSearchUserLocationType - Python SDK -description: ResponsesWebSearchUserLocationType method reference -seoTitle: ResponsesWebSearchUserLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/responseswebsearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchUserLocationType | OpenRouter Python SDK -'og:description': >- - ResponsesWebSearchUserLocationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchUserLocationType%20-%20Python%20SDK&description=ResponsesWebSearchUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/components/responsetextconfig.mdx b/client-sdks/python/components/responsetextconfig.mdx deleted file mode 100644 index bcd1e67d..00000000 --- a/client-sdks/python/components/responsetextconfig.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ResponseTextConfig - Python SDK -description: ResponseTextConfig method reference -seoTitle: ResponseTextConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsetextconfig' -'og:site_name': OpenRouter Documentation -'og:title': ResponseTextConfig | OpenRouter Python SDK -'og:description': >- - ResponseTextConfig method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseTextConfig%20-%20Python%20SDK&description=ResponseTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `format_` | [Optional[components.ResponseFormatTextConfig]](../components/responseformattextconfig.md) | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [OptionalNullable[components.ResponseTextConfigVerbosity]](../components/responsetextconfigverbosity.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/components/responsetextconfigverbosity.mdx b/client-sdks/python/components/responsetextconfigverbosity.mdx deleted file mode 100644 index 254976f4..00000000 --- a/client-sdks/python/components/responsetextconfigverbosity.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ResponseTextConfigVerbosity - Python SDK -description: ResponseTextConfigVerbosity method reference -seoTitle: ResponseTextConfigVerbosity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/responsetextconfigverbosity' -'og:site_name': OpenRouter Documentation -'og:title': ResponseTextConfigVerbosity | OpenRouter Python SDK -'og:description': >- - ResponseTextConfigVerbosity method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseTextConfigVerbosity%20-%20Python%20SDK&description=ResponseTextConfigVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `HIGH` | high | -| `LOW` | low | -| `MEDIUM` | medium | \ No newline at end of file diff --git a/client-sdks/python/components/route.mdx b/client-sdks/python/components/route.mdx deleted file mode 100644 index 3f5da7fd..00000000 --- a/client-sdks/python/components/route.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Route - Python SDK -description: Route method reference -seoTitle: Route | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/route' -'og:site_name': OpenRouter Documentation -'og:title': Route | OpenRouter Python SDK -'og:description': >- - Route method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Route%20-%20Python%20SDK&description=Route%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `FALLBACK` | fallback | -| `SORT` | sort | \ No newline at end of file diff --git a/client-sdks/python/components/schema0.mdx b/client-sdks/python/components/schema0.mdx deleted file mode 100644 index 55896b4f..00000000 --- a/client-sdks/python/components/schema0.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Schema0 - Python SDK -description: Schema0 method reference -seoTitle: Schema0 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema0' -'og:site_name': OpenRouter Documentation -'og:title': Schema0 | OpenRouter Python SDK -'og:description': >- - Schema0 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema0%20-%20Python%20SDK&description=Schema0%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.Schema0Enum` - -```python lines -value: components.Schema0Enum = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/schema0enum.mdx b/client-sdks/python/components/schema0enum.mdx deleted file mode 100644 index e3a4ea0b..00000000 --- a/client-sdks/python/components/schema0enum.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Schema0Enum - Python SDK -description: Schema0Enum method reference -seoTitle: Schema0Enum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema0enum' -'og:site_name': OpenRouter Documentation -'og:title': Schema0Enum | OpenRouter Python SDK -'og:description': >- - Schema0Enum method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema0Enum%20-%20Python%20SDK&description=Schema0Enum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------- | ------------------- | -| `AI21` | AI21 | -| `AION_LABS` | AionLabs | -| `ALIBABA` | Alibaba | -| `AMAZON_BEDROCK` | Amazon Bedrock | -| `AMAZON_NOVA` | Amazon Nova | -| `ANTHROPIC` | Anthropic | -| `ARCEE_AI` | Arcee AI | -| `ATLAS_CLOUD` | AtlasCloud | -| `AVIAN` | Avian | -| `AZURE` | Azure | -| `BASE_TEN` | BaseTen | -| `BYTE_PLUS` | BytePlus | -| `BLACK_FOREST_LABS` | Black Forest Labs | -| `CEREBRAS` | Cerebras | -| `CHUTES` | Chutes | -| `CIRRASCALE` | Cirrascale | -| `CLARIFAI` | Clarifai | -| `CLOUDFLARE` | Cloudflare | -| `COHERE` | Cohere | -| `CRUSOE` | Crusoe | -| `DEEP_INFRA` | DeepInfra | -| `DEEP_SEEK` | DeepSeek | -| `FEATHERLESS` | Featherless | -| `FIREWORKS` | Fireworks | -| `FRIENDLI` | Friendli | -| `GMI_CLOUD` | GMICloud | -| `GOOGLE` | Google | -| `GOOGLE_AI_STUDIO` | Google AI Studio | -| `GROQ` | Groq | -| `HYPERBOLIC` | Hyperbolic | -| `INCEPTION` | Inception | -| `INCEPTRON` | Inceptron | -| `INFERENCE_NET` | InferenceNet | -| `INFERMATIC` | Infermatic | -| `INFLECTION` | Inflection | -| `LIQUID` | Liquid | -| `MARA` | Mara | -| `MANCER_2` | Mancer 2 | -| `MINIMAX` | Minimax | -| `MODEL_RUN` | ModelRun | -| `MISTRAL` | Mistral | -| `MODULAR` | Modular | -| `MOONSHOT_AI` | Moonshot AI | -| `MORPH` | Morph | -| `N_COMPASS` | NCompass | -| `NEBIUS` | Nebius | -| `NEXT_BIT` | NextBit | -| `NOVITA` | Novita | -| `NVIDIA` | Nvidia | -| `OPEN_AI` | OpenAI | -| `OPEN_INFERENCE` | OpenInference | -| `PARASAIL` | Parasail | -| `PERPLEXITY` | Perplexity | -| `PHALA` | Phala | -| `RELACE` | Relace | -| `SAMBA_NOVA` | SambaNova | -| `SEED` | Seed | -| `SILICON_FLOW` | SiliconFlow | -| `SOURCEFUL` | Sourceful | -| `STEALTH` | Stealth | -| `STREAM_LAKE` | StreamLake | -| `SWITCHPOINT` | Switchpoint | -| `TOGETHER` | Together | -| `UPSTAGE` | Upstage | -| `VENICE` | Venice | -| `WAND_B` | WandB | -| `XIAOMI` | Xiaomi | -| `X_AI` | xAI | -| `Z_AI` | Z.AI | -| `FAKE_PROVIDER` | FakeProvider | \ No newline at end of file diff --git a/client-sdks/python/components/schema2.mdx b/client-sdks/python/components/schema2.mdx deleted file mode 100644 index 296c5a04..00000000 --- a/client-sdks/python/components/schema2.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Schema2 - Python SDK -description: Schema2 method reference -seoTitle: Schema2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema2' -'og:site_name': OpenRouter Documentation -'og:title': Schema2 | OpenRouter Python SDK -'og:description': >- - Schema2 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2%20-%20Python%20SDK&description=Schema2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.Schema2ReasoningSummary` - -```python lines -value: components.Schema2ReasoningSummary = /* values here */ -``` - -### `components.Schema2ReasoningEncrypted` - -```python lines -value: components.Schema2ReasoningEncrypted = /* values here */ -``` - -### `components.Schema2ReasoningText` - -```python lines -value: components.Schema2ReasoningText = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/schema2reasoningencrypted.mdx b/client-sdks/python/components/schema2reasoningencrypted.mdx deleted file mode 100644 index 9d106091..00000000 --- a/client-sdks/python/components/schema2reasoningencrypted.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Schema2ReasoningEncrypted - Python SDK -description: Schema2ReasoningEncrypted method reference -seoTitle: Schema2ReasoningEncrypted | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema2reasoningencrypted' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningEncrypted | OpenRouter Python SDK -'og:description': >- - Schema2ReasoningEncrypted method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningEncrypted%20-%20Python%20SDK&description=Schema2ReasoningEncrypted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | *Literal["reasoning.encrypted"]* | :heavy_check_mark: | N/A | -| `data` | *str* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `format_` | [OptionalNullable[components.Schema4]](../components/schema4.md) | :heavy_minus_sign: | N/A | -| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/schema2reasoningsummary.mdx b/client-sdks/python/components/schema2reasoningsummary.mdx deleted file mode 100644 index 7b392814..00000000 --- a/client-sdks/python/components/schema2reasoningsummary.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Schema2ReasoningSummary - Python SDK -description: Schema2ReasoningSummary method reference -seoTitle: Schema2ReasoningSummary | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema2reasoningsummary' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningSummary | OpenRouter Python SDK -'og:description': >- - Schema2ReasoningSummary method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningSummary%20-%20Python%20SDK&description=Schema2ReasoningSummary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | *Literal["reasoning.summary"]* | :heavy_check_mark: | N/A | -| `summary` | *str* | :heavy_check_mark: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `format_` | [OptionalNullable[components.Schema4]](../components/schema4.md) | :heavy_minus_sign: | N/A | -| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/schema2reasoningtext.mdx b/client-sdks/python/components/schema2reasoningtext.mdx deleted file mode 100644 index 436b7054..00000000 --- a/client-sdks/python/components/schema2reasoningtext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Schema2ReasoningText - Python SDK -description: Schema2ReasoningText method reference -seoTitle: Schema2ReasoningText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema2reasoningtext' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningText | OpenRouter Python SDK -'og:description': >- - Schema2ReasoningText method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningText%20-%20Python%20SDK&description=Schema2ReasoningText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `type` | *Literal["reasoning.text"]* | :heavy_check_mark: | N/A | -| `text` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `signature` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `format_` | [OptionalNullable[components.Schema4]](../components/schema4.md) | :heavy_minus_sign: | N/A | -| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/schema4.mdx b/client-sdks/python/components/schema4.mdx deleted file mode 100644 index e2f5c28b..00000000 --- a/client-sdks/python/components/schema4.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Schema4 - Python SDK -description: Schema4 method reference -seoTitle: Schema4 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/schema4' -'og:site_name': OpenRouter Documentation -'og:title': Schema4 | OpenRouter Python SDK -'og:description': >- - Schema4 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema4%20-%20Python%20SDK&description=Schema4%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `UNKNOWN` | unknown | -| `OPENAI_RESPONSES_V1` | openai-responses-v1 | -| `AZURE_OPENAI_RESPONSES_V1` | azure-openai-responses-v1 | -| `XAI_RESPONSES_V1` | xai-responses-v1 | -| `ANTHROPIC_CLAUDE_V1` | anthropic-claude-v1 | -| `GOOGLE_GEMINI_V1` | google-gemini-v1 | \ No newline at end of file diff --git a/client-sdks/python/components/security.mdx b/client-sdks/python/components/security.mdx deleted file mode 100644 index d767aae1..00000000 --- a/client-sdks/python/components/security.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Security - Python SDK -description: Security method reference -seoTitle: Security | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/security' -'og:site_name': OpenRouter Documentation -'og:title': Security | OpenRouter Python SDK -'og:description': >- - Security method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Security%20-%20Python%20SDK&description=Security%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/servicetier.mdx b/client-sdks/python/components/servicetier.mdx deleted file mode 100644 index 8ece7f5c..00000000 --- a/client-sdks/python/components/servicetier.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ServiceTier - Python SDK -description: ServiceTier method reference -seoTitle: ServiceTier | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/servicetier' -'og:site_name': OpenRouter Documentation -'og:title': ServiceTier | OpenRouter Python SDK -'og:description': >- - ServiceTier method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceTier%20-%20Python%20SDK&description=ServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `AUTO` | auto | \ No newline at end of file diff --git a/client-sdks/python/components/serviceunavailableresponseerrordata.mdx b/client-sdks/python/components/serviceunavailableresponseerrordata.mdx deleted file mode 100644 index eb29f4f5..00000000 --- a/client-sdks/python/components/serviceunavailableresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ServiceUnavailableResponseErrorData - Python SDK -description: ServiceUnavailableResponseErrorData method reference -seoTitle: ServiceUnavailableResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/serviceunavailableresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseErrorData | OpenRouter Python SDK -'og:description': >- - ServiceUnavailableResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseErrorData%20-%20Python%20SDK&description=ServiceUnavailableResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for ServiceUnavailableResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/sortenum.mdx b/client-sdks/python/components/sortenum.mdx deleted file mode 100644 index 4e5fe57c..00000000 --- a/client-sdks/python/components/sortenum.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SortEnum - Python SDK -description: SortEnum method reference -seoTitle: SortEnum | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/sortenum' -'og:site_name': OpenRouter Documentation -'og:title': SortEnum | OpenRouter Python SDK -'og:description': >- - SortEnum method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SortEnum%20-%20Python%20SDK&description=SortEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------ | ------------ | -| `PRICE` | price | -| `THROUGHPUT` | throughput | -| `LATENCY` | latency | \ No newline at end of file diff --git a/client-sdks/python/components/streamoptions.mdx b/client-sdks/python/components/streamoptions.mdx deleted file mode 100644 index dde8e12f..00000000 --- a/client-sdks/python/components/streamoptions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: StreamOptions - Python SDK -description: StreamOptions method reference -seoTitle: StreamOptions | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/streamoptions' -'og:site_name': OpenRouter Documentation -'og:title': StreamOptions | OpenRouter Python SDK -'og:description': >- - StreamOptions method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamOptions%20-%20Python%20SDK&description=StreamOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `include_usage` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/systemmessage.mdx b/client-sdks/python/components/systemmessage.mdx deleted file mode 100644 index 0c2bb1ae..00000000 --- a/client-sdks/python/components/systemmessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: SystemMessage - Python SDK -description: SystemMessage method reference -seoTitle: SystemMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/systemmessage' -'og:site_name': OpenRouter Documentation -'og:title': SystemMessage | OpenRouter Python SDK -'og:description': >- - SystemMessage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SystemMessage%20-%20Python%20SDK&description=SystemMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `role` | *Literal["system"]* | :heavy_check_mark: | N/A | -| `content` | [components.SystemMessageContent](/client-sdks/python/components/systemmessagecontent) | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/systemmessagecontent.mdx b/client-sdks/python/components/systemmessagecontent.mdx deleted file mode 100644 index 19d436a3..00000000 --- a/client-sdks/python/components/systemmessagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: SystemMessageContent - Python SDK -description: SystemMessageContent method reference -seoTitle: SystemMessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/systemmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': SystemMessageContent | OpenRouter Python SDK -'og:description': >- - SystemMessageContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SystemMessageContent%20-%20Python%20SDK&description=SystemMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatMessageContentItemText]` - -```python lines -value: List[components.ChatMessageContentItemText] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/tokenizer.mdx b/client-sdks/python/components/tokenizer.mdx deleted file mode 100644 index ffa96624..00000000 --- a/client-sdks/python/components/tokenizer.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Tokenizer - Python SDK -description: Tokenizer method reference -seoTitle: Tokenizer | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/tokenizer' -'og:site_name': OpenRouter Documentation -'og:title': Tokenizer | OpenRouter Python SDK -'og:description': >- - Tokenizer method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Tokenizer%20-%20Python%20SDK&description=Tokenizer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Values - -| Name | Value | -| ----------- | ----------- | -| `ROUTER` | Router | -| `MEDIA` | Media | -| `OTHER` | Other | -| `GPT` | GPT | -| `CLAUDE` | Claude | -| `GEMINI` | Gemini | -| `GROK` | Grok | -| `COHERE` | Cohere | -| `NOVA` | Nova | -| `QWEN` | Qwen | -| `YI` | Yi | -| `DEEP_SEEK` | DeepSeek | -| `MISTRAL` | Mistral | -| `LLAMA2` | Llama2 | -| `LLAMA3` | Llama3 | -| `LLAMA4` | Llama4 | -| `PA_LM` | PaLM | -| `RWKV` | RWKV | -| `QWEN3` | Qwen3 | \ No newline at end of file diff --git a/client-sdks/python/components/toolcallstatus.mdx b/client-sdks/python/components/toolcallstatus.mdx deleted file mode 100644 index e961d7d2..00000000 --- a/client-sdks/python/components/toolcallstatus.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolCallStatus - Python SDK -description: ToolCallStatus method reference -seoTitle: ToolCallStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/toolcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ToolCallStatus | OpenRouter Python SDK -'og:description': >- - ToolCallStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCallStatus%20-%20Python%20SDK&description=ToolCallStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `IN_PROGRESS` | in_progress | -| `COMPLETED` | completed | -| `INCOMPLETE` | incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/tooldefinitionjson.mdx b/client-sdks/python/components/tooldefinitionjson.mdx deleted file mode 100644 index c8f86301..00000000 --- a/client-sdks/python/components/tooldefinitionjson.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ToolDefinitionJSON - Python SDK -description: ToolDefinitionJSON method reference -seoTitle: ToolDefinitionJSON | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/tooldefinitionjson' -'og:site_name': OpenRouter Documentation -'og:title': ToolDefinitionJSON | OpenRouter Python SDK -'og:description': >- - ToolDefinitionJSON method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolDefinitionJSON%20-%20Python%20SDK&description=ToolDefinitionJSON%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `type` | *Literal["function"]* | :heavy_check_mark: | N/A | -| `function` | [components.ToolDefinitionJSONFunction](/client-sdks/python/components/tooldefinitionjsonfunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/tooldefinitionjsonfunction.mdx b/client-sdks/python/components/tooldefinitionjsonfunction.mdx deleted file mode 100644 index 6e4ca24f..00000000 --- a/client-sdks/python/components/tooldefinitionjsonfunction.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ToolDefinitionJSONFunction - Python SDK -description: ToolDefinitionJSONFunction method reference -seoTitle: ToolDefinitionJSONFunction | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/tooldefinitionjsonfunction' -'og:site_name': OpenRouter Documentation -'og:title': ToolDefinitionJSONFunction | OpenRouter Python SDK -'og:description': >- - ToolDefinitionJSONFunction method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolDefinitionJSONFunction%20-%20Python%20SDK&description=ToolDefinitionJSONFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `name` | *str* | :heavy_check_mark: | N/A | -| `description` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/toolresponsemessage.mdx b/client-sdks/python/components/toolresponsemessage.mdx deleted file mode 100644 index 1b4110e5..00000000 --- a/client-sdks/python/components/toolresponsemessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ToolResponseMessage - Python SDK -description: ToolResponseMessage method reference -seoTitle: ToolResponseMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/toolresponsemessage' -'og:site_name': OpenRouter Documentation -'og:title': ToolResponseMessage | OpenRouter Python SDK -'og:description': >- - ToolResponseMessage method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolResponseMessage%20-%20Python%20SDK&description=ToolResponseMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `role` | *Literal["tool"]* | :heavy_check_mark: | N/A | -| `content` | [components.ToolResponseMessageContent](/client-sdks/python/components/toolresponsemessagecontent) | :heavy_check_mark: | N/A | -| `tool_call_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/toolresponsemessagecontent.mdx b/client-sdks/python/components/toolresponsemessagecontent.mdx deleted file mode 100644 index 364de407..00000000 --- a/client-sdks/python/components/toolresponsemessagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ToolResponseMessageContent - Python SDK -description: ToolResponseMessageContent method reference -seoTitle: ToolResponseMessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/toolresponsemessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': ToolResponseMessageContent | OpenRouter Python SDK -'og:description': >- - ToolResponseMessageContent method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolResponseMessageContent%20-%20Python%20SDK&description=ToolResponseMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatMessageContentItem]` - -```python lines -value: List[components.ChatMessageContentItem] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/toomanyrequestsresponseerrordata.mdx b/client-sdks/python/components/toomanyrequestsresponseerrordata.mdx deleted file mode 100644 index 2f74cf29..00000000 --- a/client-sdks/python/components/toomanyrequestsresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TooManyRequestsResponseErrorData - Python SDK -description: TooManyRequestsResponseErrorData method reference -seoTitle: TooManyRequestsResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/toomanyrequestsresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseErrorData | OpenRouter Python SDK -'og:description': >- - TooManyRequestsResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseErrorData%20-%20Python%20SDK&description=TooManyRequestsResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for TooManyRequestsResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/topproviderinfo.mdx b/client-sdks/python/components/topproviderinfo.mdx deleted file mode 100644 index a8a4c2ad..00000000 --- a/client-sdks/python/components/topproviderinfo.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: TopProviderInfo - Python SDK -description: TopProviderInfo method reference -seoTitle: TopProviderInfo | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/topproviderinfo' -'og:site_name': OpenRouter Documentation -'og:title': TopProviderInfo | OpenRouter Python SDK -'og:description': >- - TopProviderInfo method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TopProviderInfo%20-%20Python%20SDK&description=TopProviderInfo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Information about the top provider for this model - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `context_length` | *OptionalNullable[float]* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `max_completion_tokens` | *OptionalNullable[float]* | :heavy_minus_sign: | Maximum completion tokens from the top provider | 4096 | -| `is_moderated` | *bool* | :heavy_check_mark: | Whether the top provider moderates content | true | \ No newline at end of file diff --git a/client-sdks/python/components/truncation.mdx b/client-sdks/python/components/truncation.mdx deleted file mode 100644 index 6354d582..00000000 --- a/client-sdks/python/components/truncation.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Truncation - Python SDK -description: Truncation method reference -seoTitle: Truncation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/truncation' -'og:site_name': OpenRouter Documentation -'og:title': Truncation | OpenRouter Python SDK -'og:description': >- - Truncation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Truncation%20-%20Python%20SDK&description=Truncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------- | ---------- | -| `AUTO` | auto | -| `DISABLED` | disabled | \ No newline at end of file diff --git a/client-sdks/python/components/ttl.mdx b/client-sdks/python/components/ttl.mdx deleted file mode 100644 index 9f31977e..00000000 --- a/client-sdks/python/components/ttl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TTL - Python SDK -description: TTL method reference -seoTitle: TTL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/ttl' -'og:site_name': OpenRouter Documentation -'og:title': TTL | OpenRouter Python SDK -'og:description': >- - TTL method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TTL%20-%20Python%20SDK&description=TTL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------- | ------- | -| `FIVEM` | 5m | -| `ONEH` | 1h | \ No newline at end of file diff --git a/client-sdks/python/components/type.mdx b/client-sdks/python/components/type.mdx deleted file mode 100644 index 288a15e7..00000000 --- a/client-sdks/python/components/type.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Type - Python SDK -description: Type method reference -seoTitle: Type | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/type' -'og:site_name': OpenRouter Documentation -'og:title': Type | OpenRouter Python SDK -'og:description': >- - Type method documentation for the OpenRouter Python SDK. Learn how to use this - API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Type%20-%20Python%20SDK&description=Type%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311` - -```python lines -value: components.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = /* values here */ -``` - -### `components.OpenAIResponsesToolChoiceTypeWebSearchPreview` - -```python lines -value: components.OpenAIResponsesToolChoiceTypeWebSearchPreview = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsecompleted.mdx b/client-sdks/python/components/typeresponsecompleted.mdx deleted file mode 100644 index 32d6e089..00000000 --- a/client-sdks/python/components/typeresponsecompleted.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseCompleted - Python SDK -description: TypeResponseCompleted method reference -seoTitle: TypeResponseCompleted | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponsecompleted' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseCompleted | OpenRouter Python SDK -'og:description': >- - TypeResponseCompleted method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseCompleted%20-%20Python%20SDK&description=TypeResponseCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------- | -------------------- | -| `RESPONSE_COMPLETED` | response.completed | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsecontentpartadded.mdx b/client-sdks/python/components/typeresponsecontentpartadded.mdx deleted file mode 100644 index 13bf06f3..00000000 --- a/client-sdks/python/components/typeresponsecontentpartadded.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseContentPartAdded - Python SDK -description: TypeResponseContentPartAdded method reference -seoTitle: TypeResponseContentPartAdded | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponsecontentpartadded' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseContentPartAdded | OpenRouter Python SDK -'og:description': >- - TypeResponseContentPartAdded method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseContentPartAdded%20-%20Python%20SDK&description=TypeResponseContentPartAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------------- | ----------------------------- | -| `RESPONSE_CONTENT_PART_ADDED` | response.content_part.added | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsecontentpartdone.mdx b/client-sdks/python/components/typeresponsecontentpartdone.mdx deleted file mode 100644 index 728b56c6..00000000 --- a/client-sdks/python/components/typeresponsecontentpartdone.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseContentPartDone - Python SDK -description: TypeResponseContentPartDone method reference -seoTitle: TypeResponseContentPartDone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponsecontentpartdone' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseContentPartDone | OpenRouter Python SDK -'og:description': >- - TypeResponseContentPartDone method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseContentPartDone%20-%20Python%20SDK&description=TypeResponseContentPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_CONTENT_PART_DONE` | response.content_part.done | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsecreated.mdx b/client-sdks/python/components/typeresponsecreated.mdx deleted file mode 100644 index 74323bba..00000000 --- a/client-sdks/python/components/typeresponsecreated.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseCreated - Python SDK -description: TypeResponseCreated method reference -seoTitle: TypeResponseCreated | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponsecreated' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseCreated | OpenRouter Python SDK -'og:description': >- - TypeResponseCreated method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseCreated%20-%20Python%20SDK&description=TypeResponseCreated%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------ | ------------------ | -| `RESPONSE_CREATED` | response.created | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsefailed.mdx b/client-sdks/python/components/typeresponsefailed.mdx deleted file mode 100644 index 382f1979..00000000 --- a/client-sdks/python/components/typeresponsefailed.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseFailed - Python SDK -description: TypeResponseFailed method reference -seoTitle: TypeResponseFailed | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponsefailed' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseFailed | OpenRouter Python SDK -'og:description': >- - TypeResponseFailed method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseFailed%20-%20Python%20SDK&description=TypeResponseFailed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------- | ----------------- | -| `RESPONSE_FAILED` | response.failed | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsefunctioncallargumentsdelta.mdx b/client-sdks/python/components/typeresponsefunctioncallargumentsdelta.mdx deleted file mode 100644 index 89b50c07..00000000 --- a/client-sdks/python/components/typeresponsefunctioncallargumentsdelta.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeResponseFunctionCallArgumentsDelta - Python SDK -description: TypeResponseFunctionCallArgumentsDelta method reference -seoTitle: TypeResponseFunctionCallArgumentsDelta | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/typeresponsefunctioncallargumentsdelta -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseFunctionCallArgumentsDelta | OpenRouter Python SDK -'og:description': >- - TypeResponseFunctionCallArgumentsDelta method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseFunctionCallArgumentsDelta%20-%20Python%20SDK&description=TypeResponseFunctionCallArgumentsDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------------------- | ---------------------------------------- | -| `RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA` | response.function_call_arguments.delta | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsefunctioncallargumentsdone.mdx b/client-sdks/python/components/typeresponsefunctioncallargumentsdone.mdx deleted file mode 100644 index 68d89374..00000000 --- a/client-sdks/python/components/typeresponsefunctioncallargumentsdone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeResponseFunctionCallArgumentsDone - Python SDK -description: TypeResponseFunctionCallArgumentsDone method reference -seoTitle: TypeResponseFunctionCallArgumentsDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/typeresponsefunctioncallargumentsdone -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseFunctionCallArgumentsDone | OpenRouter Python SDK -'og:description': >- - TypeResponseFunctionCallArgumentsDone method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseFunctionCallArgumentsDone%20-%20Python%20SDK&description=TypeResponseFunctionCallArgumentsDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE` | response.function_call_arguments.done | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseincomplete.mdx b/client-sdks/python/components/typeresponseincomplete.mdx deleted file mode 100644 index c75c4758..00000000 --- a/client-sdks/python/components/typeresponseincomplete.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseIncomplete - Python SDK -description: TypeResponseIncomplete method reference -seoTitle: TypeResponseIncomplete | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseincomplete' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseIncomplete | OpenRouter Python SDK -'og:description': >- - TypeResponseIncomplete method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseIncomplete%20-%20Python%20SDK&description=TypeResponseIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------- | --------------------- | -| `RESPONSE_INCOMPLETE` | response.incomplete | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseinprogress.mdx b/client-sdks/python/components/typeresponseinprogress.mdx deleted file mode 100644 index 33d4faf9..00000000 --- a/client-sdks/python/components/typeresponseinprogress.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseInProgress - Python SDK -description: TypeResponseInProgress method reference -seoTitle: TypeResponseInProgress | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseinprogress' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseInProgress | OpenRouter Python SDK -'og:description': >- - TypeResponseInProgress method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseInProgress%20-%20Python%20SDK&description=TypeResponseInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `RESPONSE_IN_PROGRESS` | response.in_progress | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseoutputitemadded.mdx b/client-sdks/python/components/typeresponseoutputitemadded.mdx deleted file mode 100644 index bdb42eac..00000000 --- a/client-sdks/python/components/typeresponseoutputitemadded.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseOutputItemAdded - Python SDK -description: TypeResponseOutputItemAdded method reference -seoTitle: TypeResponseOutputItemAdded | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseoutputitemadded' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseOutputItemAdded | OpenRouter Python SDK -'og:description': >- - TypeResponseOutputItemAdded method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseOutputItemAdded%20-%20Python%20SDK&description=TypeResponseOutputItemAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_OUTPUT_ITEM_ADDED` | response.output_item.added | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseoutputitemdone.mdx b/client-sdks/python/components/typeresponseoutputitemdone.mdx deleted file mode 100644 index aa505fe0..00000000 --- a/client-sdks/python/components/typeresponseoutputitemdone.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseOutputItemDone - Python SDK -description: TypeResponseOutputItemDone method reference -seoTitle: TypeResponseOutputItemDone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseoutputitemdone' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseOutputItemDone | OpenRouter Python SDK -'og:description': >- - TypeResponseOutputItemDone method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseOutputItemDone%20-%20Python%20SDK&description=TypeResponseOutputItemDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `RESPONSE_OUTPUT_ITEM_DONE` | response.output_item.done | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseoutputtextannotationadded.mdx b/client-sdks/python/components/typeresponseoutputtextannotationadded.mdx deleted file mode 100644 index 2e3546cd..00000000 --- a/client-sdks/python/components/typeresponseoutputtextannotationadded.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeResponseOutputTextAnnotationAdded - Python SDK -description: TypeResponseOutputTextAnnotationAdded method reference -seoTitle: TypeResponseOutputTextAnnotationAdded | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/typeresponseoutputtextannotationadded -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseOutputTextAnnotationAdded | OpenRouter Python SDK -'og:description': >- - TypeResponseOutputTextAnnotationAdded method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseOutputTextAnnotationAdded%20-%20Python%20SDK&description=TypeResponseOutputTextAnnotationAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------------------- | --------------------------------------- | -| `RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED` | response.output_text.annotation.added | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseoutputtextdelta.mdx b/client-sdks/python/components/typeresponseoutputtextdelta.mdx deleted file mode 100644 index 00261549..00000000 --- a/client-sdks/python/components/typeresponseoutputtextdelta.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseOutputTextDelta - Python SDK -description: TypeResponseOutputTextDelta method reference -seoTitle: TypeResponseOutputTextDelta | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseoutputtextdelta' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseOutputTextDelta | OpenRouter Python SDK -'og:description': >- - TypeResponseOutputTextDelta method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseOutputTextDelta%20-%20Python%20SDK&description=TypeResponseOutputTextDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ---------------------------- | ---------------------------- | -| `RESPONSE_OUTPUT_TEXT_DELTA` | response.output_text.delta | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponseoutputtextdone.mdx b/client-sdks/python/components/typeresponseoutputtextdone.mdx deleted file mode 100644 index 820f4d99..00000000 --- a/client-sdks/python/components/typeresponseoutputtextdone.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseOutputTextDone - Python SDK -description: TypeResponseOutputTextDone method reference -seoTitle: TypeResponseOutputTextDone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponseoutputtextdone' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseOutputTextDone | OpenRouter Python SDK -'og:description': >- - TypeResponseOutputTextDone method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseOutputTextDone%20-%20Python%20SDK&description=TypeResponseOutputTextDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| --------------------------- | --------------------------- | -| `RESPONSE_OUTPUT_TEXT_DONE` | response.output_text.done | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponsereasoningsummarypartdone.mdx b/client-sdks/python/components/typeresponsereasoningsummarypartdone.mdx deleted file mode 100644 index 2729ce0f..00000000 --- a/client-sdks/python/components/typeresponsereasoningsummarypartdone.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TypeResponseReasoningSummaryPartDone - Python SDK -description: TypeResponseReasoningSummaryPartDone method reference -seoTitle: TypeResponseReasoningSummaryPartDone | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/typeresponsereasoningsummarypartdone -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseReasoningSummaryPartDone | OpenRouter Python SDK -'og:description': >- - TypeResponseReasoningSummaryPartDone method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseReasoningSummaryPartDone%20-%20Python%20SDK&description=TypeResponseReasoningSummaryPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------------------------------- | -------------------------------------- | -| `RESPONSE_REASONING_SUMMARY_PART_DONE` | response.reasoning_summary_part.done | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponserefusaldelta.mdx b/client-sdks/python/components/typeresponserefusaldelta.mdx deleted file mode 100644 index 778b71eb..00000000 --- a/client-sdks/python/components/typeresponserefusaldelta.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseRefusalDelta - Python SDK -description: TypeResponseRefusalDelta method reference -seoTitle: TypeResponseRefusalDelta | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponserefusaldelta' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseRefusalDelta | OpenRouter Python SDK -'og:description': >- - TypeResponseRefusalDelta method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseRefusalDelta%20-%20Python%20SDK&description=TypeResponseRefusalDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `RESPONSE_REFUSAL_DELTA` | response.refusal.delta | \ No newline at end of file diff --git a/client-sdks/python/components/typeresponserefusaldone.mdx b/client-sdks/python/components/typeresponserefusaldone.mdx deleted file mode 100644 index 17fab49b..00000000 --- a/client-sdks/python/components/typeresponserefusaldone.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeResponseRefusalDone - Python SDK -description: TypeResponseRefusalDone method reference -seoTitle: TypeResponseRefusalDone | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/typeresponserefusaldone' -'og:site_name': OpenRouter Documentation -'og:title': TypeResponseRefusalDone | OpenRouter Python SDK -'og:description': >- - TypeResponseRefusalDone method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeResponseRefusalDone%20-%20Python%20SDK&description=TypeResponseRefusalDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `RESPONSE_REFUSAL_DONE` | response.refusal.done | \ No newline at end of file diff --git a/client-sdks/python/components/unauthorizedresponseerrordata.mdx b/client-sdks/python/components/unauthorizedresponseerrordata.mdx deleted file mode 100644 index 34ed7d27..00000000 --- a/client-sdks/python/components/unauthorizedresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: UnauthorizedResponseErrorData - Python SDK -description: UnauthorizedResponseErrorData method reference -seoTitle: UnauthorizedResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/unauthorizedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseErrorData | OpenRouter Python SDK -'og:description': >- - UnauthorizedResponseErrorData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseErrorData%20-%20Python%20SDK&description=UnauthorizedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for UnauthorizedResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/unprocessableentityresponseerrordata.mdx b/client-sdks/python/components/unprocessableentityresponseerrordata.mdx deleted file mode 100644 index 40c48bc6..00000000 --- a/client-sdks/python/components/unprocessableentityresponseerrordata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: UnprocessableEntityResponseErrorData - Python SDK -description: UnprocessableEntityResponseErrorData method reference -seoTitle: UnprocessableEntityResponseErrorData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/unprocessableentityresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseErrorData | OpenRouter Python SDK -'og:description': >- - UnprocessableEntityResponseErrorData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseErrorData%20-%20Python%20SDK&description=UnprocessableEntityResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Error data for UnprocessableEntityResponse - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `code` | *int* | :heavy_check_mark: | N/A | -| `message` | *str* | :heavy_check_mark: | N/A | -| `metadata` | Dict[str, *Nullable[Any]*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/urlcitation.mdx b/client-sdks/python/components/urlcitation.mdx deleted file mode 100644 index 27dc1920..00000000 --- a/client-sdks/python/components/urlcitation.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: URLCitation - Python SDK -description: URLCitation method reference -seoTitle: URLCitation | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/urlcitation' -'og:site_name': OpenRouter Documentation -'og:title': URLCitation | OpenRouter Python SDK -'og:description': >- - URLCitation method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitation%20-%20Python%20SDK&description=URLCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [components.URLCitationType](/client-sdks/python/api-reference/components/urlcitationtype) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | N/A | -| `title` | *str* | :heavy_check_mark: | N/A | -| `start_index` | *float* | :heavy_check_mark: | N/A | -| `end_index` | *float* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/urlcitationtype.mdx b/client-sdks/python/components/urlcitationtype.mdx deleted file mode 100644 index b171069b..00000000 --- a/client-sdks/python/components/urlcitationtype.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: URLCitationType - Python SDK -description: URLCitationType method reference -seoTitle: URLCitationType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/urlcitationtype' -'og:site_name': OpenRouter Documentation -'og:title': URLCitationType | OpenRouter Python SDK -'og:description': >- - URLCitationType method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitationType%20-%20Python%20SDK&description=URLCitationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------------- | -------------- | -| `URL_CITATION` | url_citation | \ No newline at end of file diff --git a/client-sdks/python/components/usermessage.mdx b/client-sdks/python/components/usermessage.mdx deleted file mode 100644 index ac1b088f..00000000 --- a/client-sdks/python/components/usermessage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UserMessage - Python SDK -description: UserMessage method reference -seoTitle: UserMessage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/usermessage' -'og:site_name': OpenRouter Documentation -'og:title': UserMessage | OpenRouter Python SDK -'og:description': >- - UserMessage method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserMessage%20-%20Python%20SDK&description=UserMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `role` | *Literal["user"]* | :heavy_check_mark: | N/A | -| `content` | [components.UserMessageContent](/client-sdks/python/components/usermessagecontent) | :heavy_check_mark: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/usermessagecontent.mdx b/client-sdks/python/components/usermessagecontent.mdx deleted file mode 100644 index 4c069dbf..00000000 --- a/client-sdks/python/components/usermessagecontent.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: UserMessageContent - Python SDK -description: UserMessageContent method reference -seoTitle: UserMessageContent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/usermessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': UserMessageContent | OpenRouter Python SDK -'og:description': >- - UserMessageContent method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserMessageContent%20-%20Python%20SDK&description=UserMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[components.ChatMessageContentItem]` - -```python lines -value: List[components.ChatMessageContentItem] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/variables.mdx b/client-sdks/python/components/variables.mdx deleted file mode 100644 index b2976b8d..00000000 --- a/client-sdks/python/components/variables.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Variables - Python SDK -description: Variables method reference -seoTitle: Variables | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/variables' -'og:site_name': OpenRouter Documentation -'og:title': Variables | OpenRouter Python SDK -'og:description': >- - Variables method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Variables%20-%20Python%20SDK&description=Variables%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `components.ResponseInputText` - -```python lines -value: components.ResponseInputText = /* values here */ -``` - -### `components.ResponseInputImage` - -```python lines -value: components.ResponseInputImage = /* values here */ -``` - -### `components.ResponseInputFile` - -```python lines -value: components.ResponseInputFile = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/components/videourl1.mdx b/client-sdks/python/components/videourl1.mdx deleted file mode 100644 index 07f379c8..00000000 --- a/client-sdks/python/components/videourl1.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: VideoURL1 - Python SDK -description: VideoURL1 method reference -seoTitle: VideoURL1 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/videourl1' -'og:site_name': OpenRouter Documentation -'og:title': VideoURL1 | OpenRouter Python SDK -'og:description': >- - VideoURL1 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoURL1%20-%20Python%20SDK&description=VideoURL1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/videourl2.mdx b/client-sdks/python/components/videourl2.mdx deleted file mode 100644 index 3a740842..00000000 --- a/client-sdks/python/components/videourl2.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: VideoURL2 - Python SDK -description: VideoURL2 method reference -seoTitle: VideoURL2 | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/videourl2' -'og:site_name': OpenRouter Documentation -'og:title': VideoURL2 | OpenRouter Python SDK -'og:description': >- - VideoURL2 method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoURL2%20-%20Python%20SDK&description=VideoURL2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/websearchengine.mdx b/client-sdks/python/components/websearchengine.mdx deleted file mode 100644 index 879c4891..00000000 --- a/client-sdks/python/components/websearchengine.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: WebSearchEngine - Python SDK -description: WebSearchEngine method reference -seoTitle: WebSearchEngine | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/websearchengine' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngine | OpenRouter Python SDK -'og:description': >- - WebSearchEngine method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngine%20-%20Python%20SDK&description=WebSearchEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The search engine to use for web search. - -## Values - -| Name | Value | -| -------- | -------- | -| `NATIVE` | native | -| `EXA` | exa | \ No newline at end of file diff --git a/client-sdks/python/components/websearchpreviewtooluserlocation.mdx b/client-sdks/python/components/websearchpreviewtooluserlocation.mdx deleted file mode 100644 index 092d6831..00000000 --- a/client-sdks/python/components/websearchpreviewtooluserlocation.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: WebSearchPreviewToolUserLocation - Python SDK -description: WebSearchPreviewToolUserLocation method reference -seoTitle: WebSearchPreviewToolUserLocation | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/websearchpreviewtooluserlocation -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPreviewToolUserLocation | OpenRouter Python SDK -'og:description': >- - WebSearchPreviewToolUserLocation method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPreviewToolUserLocation%20-%20Python%20SDK&description=WebSearchPreviewToolUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [components.WebSearchPreviewToolUserLocationType](/client-sdks/python/components/websearchpreviewtooluserlocationtype) | :heavy_check_mark: | N/A | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `country` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `region` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/components/websearchpreviewtooluserlocationtype.mdx b/client-sdks/python/components/websearchpreviewtooluserlocationtype.mdx deleted file mode 100644 index 8e4484c2..00000000 --- a/client-sdks/python/components/websearchpreviewtooluserlocationtype.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: WebSearchPreviewToolUserLocationType - Python SDK -description: WebSearchPreviewToolUserLocationType method reference -seoTitle: WebSearchPreviewToolUserLocationType | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/components/websearchpreviewtooluserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPreviewToolUserLocationType | OpenRouter Python SDK -'og:description': >- - WebSearchPreviewToolUserLocationType method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPreviewToolUserLocationType%20-%20Python%20SDK&description=WebSearchPreviewToolUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `APPROXIMATE` | approximate | \ No newline at end of file diff --git a/client-sdks/python/components/websearchstatus.mdx b/client-sdks/python/components/websearchstatus.mdx deleted file mode 100644 index 772b7c62..00000000 --- a/client-sdks/python/components/websearchstatus.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: WebSearchStatus - Python SDK -description: WebSearchStatus method reference -seoTitle: WebSearchStatus | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/components/websearchstatus' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchStatus | OpenRouter Python SDK -'og:description': >- - WebSearchStatus method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchStatus%20-%20Python%20SDK&description=WebSearchStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETED` | completed | -| `SEARCHING` | searching | -| `IN_PROGRESS` | in_progress | -| `FAILED` | failed | \ No newline at end of file diff --git a/client-sdks/python/errors/badgatewayresponseerror.mdx b/client-sdks/python/errors/badgatewayresponseerror.mdx deleted file mode 100644 index 0650f639..00000000 --- a/client-sdks/python/errors/badgatewayresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BadGatewayResponseError - Python SDK -description: BadGatewayResponseError method reference -seoTitle: BadGatewayResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/badgatewayresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseError | OpenRouter Python SDK -'og:description': >- - BadGatewayResponseError method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseError%20-%20Python%20SDK&description=BadGatewayResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Bad Gateway - Provider/upstream API failure - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadGatewayResponseErrorData](/client-sdks/python/api-reference/components/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | `{"code": 502,"message": "Provider returned error"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/badrequestresponseerror.mdx b/client-sdks/python/errors/badrequestresponseerror.mdx deleted file mode 100644 index 917ac4b0..00000000 --- a/client-sdks/python/errors/badrequestresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BadRequestResponseError - Python SDK -description: BadRequestResponseError method reference -seoTitle: BadRequestResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/badrequestresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseError | OpenRouter Python SDK -'og:description': >- - BadRequestResponseError method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseError%20-%20Python%20SDK&description=BadRequestResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Bad Request - Invalid request parameters or malformed input - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `error` | [components.BadRequestResponseErrorData](/client-sdks/python/api-reference/components/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | `{"code": 400,"message": "Invalid request parameters"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/chaterror.mdx b/client-sdks/python/errors/chaterror.mdx deleted file mode 100644 index 1b28fc7a..00000000 --- a/client-sdks/python/errors/chaterror.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ChatError - Python SDK -description: ChatError method reference -seoTitle: ChatError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/chaterror' -'og:site_name': OpenRouter Documentation -'og:title': ChatError | OpenRouter Python SDK -'og:description': >- - ChatError method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatError%20-%20Python%20SDK&description=ChatError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `error` | [components.ChatErrorError](/client-sdks/python/components/chaterrorerror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/errors/edgenetworktimeoutresponseerror.mdx b/client-sdks/python/errors/edgenetworktimeoutresponseerror.mdx deleted file mode 100644 index af835028..00000000 --- a/client-sdks/python/errors/edgenetworktimeoutresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseError - Python SDK -description: EdgeNetworkTimeoutResponseError method reference -seoTitle: EdgeNetworkTimeoutResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/edgenetworktimeoutresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseError | OpenRouter Python SDK -'og:description': >- - EdgeNetworkTimeoutResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseError%20-%20Python%20SDK&description=EdgeNetworkTimeoutResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Infrastructure Timeout - Provider request timed out at edge network - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.EdgeNetworkTimeoutResponseErrorData](/client-sdks/python/api-reference/components/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | `{"code": 524,"message": "Request timed out. Please try again later."}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/forbiddenresponseerror.mdx b/client-sdks/python/errors/forbiddenresponseerror.mdx deleted file mode 100644 index cd2379a4..00000000 --- a/client-sdks/python/errors/forbiddenresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ForbiddenResponseError - Python SDK -description: ForbiddenResponseError method reference -seoTitle: ForbiddenResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/forbiddenresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseError | OpenRouter Python SDK -'og:description': >- - ForbiddenResponseError method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseError%20-%20Python%20SDK&description=ForbiddenResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Forbidden - Authentication successful but insufficient permissions - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `error` | [components.ForbiddenResponseErrorData](/client-sdks/python/api-reference/components/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | `{"code": 403,"message": "Only provisioning keys can perform this operation"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/internalserverresponseerror.mdx b/client-sdks/python/errors/internalserverresponseerror.mdx deleted file mode 100644 index c50a5095..00000000 --- a/client-sdks/python/errors/internalserverresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: InternalServerResponseError - Python SDK -description: InternalServerResponseError method reference -seoTitle: InternalServerResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/internalserverresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseError | OpenRouter Python SDK -'og:description': >- - InternalServerResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseError%20-%20Python%20SDK&description=InternalServerResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Internal Server Error - Unexpected server error - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.InternalServerResponseErrorData](/client-sdks/python/api-reference/components/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | `{"code": 500,"message": "Internal Server Error"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/notfoundresponseerror.mdx b/client-sdks/python/errors/notfoundresponseerror.mdx deleted file mode 100644 index a0879850..00000000 --- a/client-sdks/python/errors/notfoundresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: NotFoundResponseError - Python SDK -description: NotFoundResponseError method reference -seoTitle: NotFoundResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/notfoundresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseError | OpenRouter Python SDK -'og:description': >- - NotFoundResponseError method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseError%20-%20Python%20SDK&description=NotFoundResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Not Found - Resource does not exist - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [components.NotFoundResponseErrorData](/client-sdks/python/api-reference/components/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | `{"code": 404,"message": "Resource not found"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/payloadtoolargeresponseerror.mdx b/client-sdks/python/errors/payloadtoolargeresponseerror.mdx deleted file mode 100644 index 405d8eb6..00000000 --- a/client-sdks/python/errors/payloadtoolargeresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PayloadTooLargeResponseError - Python SDK -description: PayloadTooLargeResponseError method reference -seoTitle: PayloadTooLargeResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/payloadtoolargeresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseError | OpenRouter Python SDK -'og:description': >- - PayloadTooLargeResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseError%20-%20Python%20SDK&description=PayloadTooLargeResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Payload Too Large - Request payload exceeds size limits - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PayloadTooLargeResponseErrorData](/client-sdks/python/api-reference/components/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | `{"code": 413,"message": "Request payload too large"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/paymentrequiredresponseerror.mdx b/client-sdks/python/errors/paymentrequiredresponseerror.mdx deleted file mode 100644 index d00531cc..00000000 --- a/client-sdks/python/errors/paymentrequiredresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: PaymentRequiredResponseError - Python SDK -description: PaymentRequiredResponseError method reference -seoTitle: PaymentRequiredResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/paymentrequiredresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseError | OpenRouter Python SDK -'og:description': >- - PaymentRequiredResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseError%20-%20Python%20SDK&description=PaymentRequiredResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Payment Required - Insufficient credits or quota to complete request - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.PaymentRequiredResponseErrorData](/client-sdks/python/api-reference/components/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | `{"code": 402,"message": "Insufficient credits. Add more using https://openrouter.ai/credits"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/provideroverloadedresponseerror.mdx b/client-sdks/python/errors/provideroverloadedresponseerror.mdx deleted file mode 100644 index 2738695e..00000000 --- a/client-sdks/python/errors/provideroverloadedresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ProviderOverloadedResponseError - Python SDK -description: ProviderOverloadedResponseError method reference -seoTitle: ProviderOverloadedResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/provideroverloadedresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseError | OpenRouter Python SDK -'og:description': >- - ProviderOverloadedResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseError%20-%20Python%20SDK&description=ProviderOverloadedResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Provider Overloaded - Provider is temporarily overloaded - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ProviderOverloadedResponseErrorData](/client-sdks/python/api-reference/components/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | `{"code": 529,"message": "Provider returned error"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/requesttimeoutresponseerror.mdx b/client-sdks/python/errors/requesttimeoutresponseerror.mdx deleted file mode 100644 index f0d48fb2..00000000 --- a/client-sdks/python/errors/requesttimeoutresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RequestTimeoutResponseError - Python SDK -description: RequestTimeoutResponseError method reference -seoTitle: RequestTimeoutResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/requesttimeoutresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseError | OpenRouter Python SDK -'og:description': >- - RequestTimeoutResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseError%20-%20Python%20SDK&description=RequestTimeoutResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Request Timeout - Operation exceeded time limit - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `error` | [components.RequestTimeoutResponseErrorData](/client-sdks/python/api-reference/components/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | `{"code": 408,"message": "Operation timed out. Please try again later."}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/serviceunavailableresponseerror.mdx b/client-sdks/python/errors/serviceunavailableresponseerror.mdx deleted file mode 100644 index b4af2c73..00000000 --- a/client-sdks/python/errors/serviceunavailableresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ServiceUnavailableResponseError - Python SDK -description: ServiceUnavailableResponseError method reference -seoTitle: ServiceUnavailableResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/serviceunavailableresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseError | OpenRouter Python SDK -'og:description': >- - ServiceUnavailableResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseError%20-%20Python%20SDK&description=ServiceUnavailableResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Service Unavailable - Service temporarily unavailable - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `error` | [components.ServiceUnavailableResponseErrorData](/client-sdks/python/api-reference/components/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | `{"code": 503,"message": "Service temporarily unavailable"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/toomanyrequestsresponseerror.mdx b/client-sdks/python/errors/toomanyrequestsresponseerror.mdx deleted file mode 100644 index 64f28d1e..00000000 --- a/client-sdks/python/errors/toomanyrequestsresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: TooManyRequestsResponseError - Python SDK -description: TooManyRequestsResponseError method reference -seoTitle: TooManyRequestsResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/toomanyrequestsresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseError | OpenRouter Python SDK -'og:description': >- - TooManyRequestsResponseError method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseError%20-%20Python%20SDK&description=TooManyRequestsResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Too Many Requests - Rate limit exceeded - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [components.TooManyRequestsResponseErrorData](/client-sdks/python/api-reference/components/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | `{"code": 429,"message": "Rate limit exceeded"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/unauthorizedresponseerror.mdx b/client-sdks/python/errors/unauthorizedresponseerror.mdx deleted file mode 100644 index 0de047d7..00000000 --- a/client-sdks/python/errors/unauthorizedresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UnauthorizedResponseError - Python SDK -description: UnauthorizedResponseError method reference -seoTitle: UnauthorizedResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/unauthorizedresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseError | OpenRouter Python SDK -'og:description': >- - UnauthorizedResponseError method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseError%20-%20Python%20SDK&description=UnauthorizedResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unauthorized - Authentication required or invalid credentials - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `error` | [components.UnauthorizedResponseErrorData](/client-sdks/python/api-reference/components/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | `{"code": 401,"message": "Missing Authentication header"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/errors/unprocessableentityresponseerror.mdx b/client-sdks/python/errors/unprocessableentityresponseerror.mdx deleted file mode 100644 index 57006847..00000000 --- a/client-sdks/python/errors/unprocessableentityresponseerror.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: UnprocessableEntityResponseError - Python SDK -description: UnprocessableEntityResponseError method reference -seoTitle: UnprocessableEntityResponseError | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/errors/unprocessableentityresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseError | OpenRouter Python SDK -'og:description': >- - UnprocessableEntityResponseError method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseError%20-%20Python%20SDK&description=UnprocessableEntityResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unprocessable Entity - Semantic validation failure - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `error` | [components.UnprocessableEntityResponseErrorData](/client-sdks/python/api-reference/components/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | `{"code": 422,"message": "Invalid argument"}` | -| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/models/globals.mdx b/client-sdks/python/models/globals.mdx deleted file mode 100644 index 2d987c27..00000000 --- a/client-sdks/python/models/globals.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Globals - Python SDK -description: Globals method reference -seoTitle: Globals | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/models/globals' -'og:site_name': OpenRouter Documentation -'og:title': Globals | OpenRouter Python SDK -'og:description': >- - Globals method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Globals%20-%20Python%20SDK&description=Globals%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `http_referer` | *Optional[str]* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `x_title` | *Optional[str]* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| \ No newline at end of file diff --git a/client-sdks/python/models/retryconfig.mdx b/client-sdks/python/models/retryconfig.mdx deleted file mode 100644 index a48ddfa8..00000000 --- a/client-sdks/python/models/retryconfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: RetryConfig - Python SDK -description: RetryConfig method reference -seoTitle: RetryConfig | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/models/retryconfig' -'og:site_name': OpenRouter Documentation -'og:title': RetryConfig | OpenRouter Python SDK -'og:description': >- - RetryConfig method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RetryConfig%20-%20Python%20SDK&description=RetryConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Allows customizing the default retry configuration. Only usable with methods that mention they support retries. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | --------------------------------------- | --------- | -| `strategy` | `*str*` | The retry strategy to use. | `backoff` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | Configuration for the backoff strategy. | | -| `retry_connection_errors` | `*bool*` | Whether to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | --------- | ----------------------------------------- | -------- | -| `initial_interval` | `*int*` | The initial interval in milliseconds. | `500` | -| `max_interval` | `*int*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*float*` | The exponent to use for the backoff. | `1.5` | -| `max_elapsed_time` | `*int*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/client-sdks/python/operations/apitype.mdx b/client-sdks/python/operations/apitype.mdx deleted file mode 100644 index 20ce2f93..00000000 --- a/client-sdks/python/operations/apitype.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: APIType - Python SDK -description: APIType method reference -seoTitle: APIType | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/apitype' -'og:site_name': OpenRouter Documentation -'og:title': APIType | OpenRouter Python SDK -'og:description': >- - APIType method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIType%20-%20Python%20SDK&description=APIType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Type of API used for the generation - -## Values - -| Name | Value | -| ------------- | ------------- | -| `COMPLETIONS` | completions | -| `EMBEDDINGS` | embeddings | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignkeystoguardrailrequest.mdx b/client-sdks/python/operations/bulkassignkeystoguardrailrequest.mdx deleted file mode 100644 index 0624e9cc..00000000 --- a/client-sdks/python/operations/bulkassignkeystoguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequest - Python SDK -description: BulkAssignKeysToGuardrailRequest method reference -seoTitle: BulkAssignKeysToGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignkeystoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysToGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequest%20-%20Python%20SDK&description=BulkAssignKeysToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `request_body` | [operations.BulkAssignKeysToGuardrailRequestBody](/client-sdks/python/operations/bulkassignkeystoguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignkeystoguardrailrequestbody.mdx b/client-sdks/python/operations/bulkassignkeystoguardrailrequestbody.mdx deleted file mode 100644 index ab0f73e0..00000000 --- a/client-sdks/python/operations/bulkassignkeystoguardrailrequestbody.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequestBody - Python SDK -description: BulkAssignKeysToGuardrailRequestBody method reference -seoTitle: BulkAssignKeysToGuardrailRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignkeystoguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequestBody | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysToGuardrailRequestBody method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequestBody%20-%20Python%20SDK&description=BulkAssignKeysToGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignkeystoguardrailresponse.mdx b/client-sdks/python/operations/bulkassignkeystoguardrailresponse.mdx deleted file mode 100644 index bc0febfc..00000000 --- a/client-sdks/python/operations/bulkassignkeystoguardrailresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailResponse - Python SDK -description: BulkAssignKeysToGuardrailResponse method reference -seoTitle: BulkAssignKeysToGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignkeystoguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailResponse | OpenRouter Python SDK -'og:description': >- - BulkAssignKeysToGuardrailResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailResponse%20-%20Python%20SDK&description=BulkAssignKeysToGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Assignment result - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assigned_count` | *float* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignmemberstoguardrailrequest.mdx b/client-sdks/python/operations/bulkassignmemberstoguardrailrequest.mdx deleted file mode 100644 index ae69dbed..00000000 --- a/client-sdks/python/operations/bulkassignmemberstoguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequest - Python SDK -description: BulkAssignMembersToGuardrailRequest method reference -seoTitle: BulkAssignMembersToGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignmemberstoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersToGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequest%20-%20Python%20SDK&description=BulkAssignMembersToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `request_body` | [operations.BulkAssignMembersToGuardrailRequestBody](/client-sdks/python/operations/bulkassignmemberstoguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignmemberstoguardrailrequestbody.mdx b/client-sdks/python/operations/bulkassignmemberstoguardrailrequestbody.mdx deleted file mode 100644 index 0bf57c15..00000000 --- a/client-sdks/python/operations/bulkassignmemberstoguardrailrequestbody.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequestBody - Python SDK -description: BulkAssignMembersToGuardrailRequestBody method reference -seoTitle: BulkAssignMembersToGuardrailRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignmemberstoguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequestBody | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersToGuardrailRequestBody method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequestBody%20-%20Python%20SDK&description=BulkAssignMembersToGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkassignmemberstoguardrailresponse.mdx b/client-sdks/python/operations/bulkassignmemberstoguardrailresponse.mdx deleted file mode 100644 index 02a54ba5..00000000 --- a/client-sdks/python/operations/bulkassignmemberstoguardrailresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailResponse - Python SDK -description: BulkAssignMembersToGuardrailResponse method reference -seoTitle: BulkAssignMembersToGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkassignmemberstoguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailResponse | OpenRouter Python SDK -'og:description': >- - BulkAssignMembersToGuardrailResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailResponse%20-%20Python%20SDK&description=BulkAssignMembersToGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Assignment result - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assigned_count` | *float* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignkeysfromguardrailrequest.mdx b/client-sdks/python/operations/bulkunassignkeysfromguardrailrequest.mdx deleted file mode 100644 index a1cebc73..00000000 --- a/client-sdks/python/operations/bulkunassignkeysfromguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequest - Python SDK -description: BulkUnassignKeysFromGuardrailRequest method reference -seoTitle: BulkUnassignKeysFromGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignkeysfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequest%20-%20Python%20SDK&description=BulkUnassignKeysFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `request_body` | [operations.BulkUnassignKeysFromGuardrailRequestBody](/client-sdks/python/operations/bulkunassignkeysfromguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignkeysfromguardrailrequestbody.mdx b/client-sdks/python/operations/bulkunassignkeysfromguardrailrequestbody.mdx deleted file mode 100644 index 88b1dd4a..00000000 --- a/client-sdks/python/operations/bulkunassignkeysfromguardrailrequestbody.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequestBody - Python SDK -description: BulkUnassignKeysFromGuardrailRequestBody method reference -seoTitle: BulkUnassignKeysFromGuardrailRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignkeysfromguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequestBody | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequestBody method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequestBody%20-%20Python%20SDK&description=BulkUnassignKeysFromGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `key_hashes` | List[*str*] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignkeysfromguardrailresponse.mdx b/client-sdks/python/operations/bulkunassignkeysfromguardrailresponse.mdx deleted file mode 100644 index c2faec7d..00000000 --- a/client-sdks/python/operations/bulkunassignkeysfromguardrailresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailResponse - Python SDK -description: BulkUnassignKeysFromGuardrailResponse method reference -seoTitle: BulkUnassignKeysFromGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignkeysfromguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailResponse | OpenRouter Python SDK -'og:description': >- - BulkUnassignKeysFromGuardrailResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailResponse%20-%20Python%20SDK&description=BulkUnassignKeysFromGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unassignment result - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassigned_count` | *float* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignmembersfromguardrailrequest.mdx b/client-sdks/python/operations/bulkunassignmembersfromguardrailrequest.mdx deleted file mode 100644 index bad76a10..00000000 --- a/client-sdks/python/operations/bulkunassignmembersfromguardrailrequest.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequest - Python SDK -description: BulkUnassignMembersFromGuardrailRequest method reference -seoTitle: BulkUnassignMembersFromGuardrailRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignmembersfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequest | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequest method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequest%20-%20Python%20SDK&description=BulkUnassignMembersFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `request_body` | [operations.BulkUnassignMembersFromGuardrailRequestBody](/client-sdks/python/operations/bulkunassignmembersfromguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignmembersfromguardrailrequestbody.mdx b/client-sdks/python/operations/bulkunassignmembersfromguardrailrequestbody.mdx deleted file mode 100644 index 1131633c..00000000 --- a/client-sdks/python/operations/bulkunassignmembersfromguardrailrequestbody.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequestBody - Python SDK -description: BulkUnassignMembersFromGuardrailRequestBody method reference -seoTitle: BulkUnassignMembersFromGuardrailRequestBody | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignmembersfromguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequestBody | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequestBody method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequestBody%20-%20Python%20SDK&description=BulkUnassignMembersFromGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `member_user_ids` | List[*str*] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/python/operations/bulkunassignmembersfromguardrailresponse.mdx b/client-sdks/python/operations/bulkunassignmembersfromguardrailresponse.mdx deleted file mode 100644 index 6dcbd69e..00000000 --- a/client-sdks/python/operations/bulkunassignmembersfromguardrailresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailResponse - Python SDK -description: BulkUnassignMembersFromGuardrailResponse method reference -seoTitle: BulkUnassignMembersFromGuardrailResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/bulkunassignmembersfromguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailResponse | OpenRouter Python SDK -'og:description': >- - BulkUnassignMembersFromGuardrailResponse method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailResponse%20-%20Python%20SDK&description=BulkUnassignMembersFromGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Unassignment result - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassigned_count` | *float* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/client-sdks/python/operations/calldata.mdx b/client-sdks/python/operations/calldata.mdx deleted file mode 100644 index 3f1862c6..00000000 --- a/client-sdks/python/operations/calldata.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: CallData - Python SDK -description: CallData method reference -seoTitle: CallData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/calldata' -'og:site_name': OpenRouter Documentation -'og:title': CallData | OpenRouter Python SDK -'og:description': >- - CallData method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CallData%20-%20Python%20SDK&description=CallData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `deadline` | *str* | :heavy_check_mark: | N/A | -| `fee_amount` | *str* | :heavy_check_mark: | N/A | -| `id` | *str* | :heavy_check_mark: | N/A | -| `operator` | *str* | :heavy_check_mark: | N/A | -| `prefix` | *str* | :heavy_check_mark: | N/A | -| `recipient` | *str* | :heavy_check_mark: | N/A | -| `recipient_amount` | *str* | :heavy_check_mark: | N/A | -| `recipient_currency` | *str* | :heavy_check_mark: | N/A | -| `refund_destination` | *str* | :heavy_check_mark: | N/A | -| `signature` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/content.mdx b/client-sdks/python/operations/content.mdx deleted file mode 100644 index b3d97fe1..00000000 --- a/client-sdks/python/operations/content.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Content - Python SDK -description: Content method reference -seoTitle: Content | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/content' -'og:site_name': OpenRouter Documentation -'og:title': Content | OpenRouter Python SDK -'og:description': >- - Content method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Content%20-%20Python%20SDK&description=Content%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.ContentText` - -```python lines -value: operations.ContentText = /* values here */ -``` - -### `operations.ContentImageURL` - -```python lines -value: operations.ContentImageURL = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/contentimageurl.mdx b/client-sdks/python/operations/contentimageurl.mdx deleted file mode 100644 index 4d143a49..00000000 --- a/client-sdks/python/operations/contentimageurl.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ContentImageURL - Python SDK -description: ContentImageURL method reference -seoTitle: ContentImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/contentimageurl' -'og:site_name': OpenRouter Documentation -'og:title': ContentImageURL | OpenRouter Python SDK -'og:description': >- - ContentImageURL method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentImageURL%20-%20Python%20SDK&description=ContentImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `type` | [operations.TypeImageURL](/client-sdks/python/api-reference/operations/typeimageurl) | :heavy_check_mark: | N/A | -| `image_url` | [operations.ImageURL](/client-sdks/python/api-reference/operations/imageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/contenttext.mdx b/client-sdks/python/operations/contenttext.mdx deleted file mode 100644 index 27e58148..00000000 --- a/client-sdks/python/operations/contenttext.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ContentText - Python SDK -description: ContentText method reference -seoTitle: ContentText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/contenttext' -'og:site_name': OpenRouter Documentation -'og:title': ContentText | OpenRouter Python SDK -'og:description': >- - ContentText method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentText%20-%20Python%20SDK&description=ContentText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | [operations.TypeText](/client-sdks/python/api-reference/operations/typetext) | :heavy_check_mark: | N/A | -| `text` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createauthkeyscodecodechallengemethod.mdx b/client-sdks/python/operations/createauthkeyscodecodechallengemethod.mdx deleted file mode 100644 index d1335455..00000000 --- a/client-sdks/python/operations/createauthkeyscodecodechallengemethod.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeCodeChallengeMethod - Python SDK -description: CreateAuthKeysCodeCodeChallengeMethod method reference -seoTitle: CreateAuthKeysCodeCodeChallengeMethod | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/createauthkeyscodecodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeCodeChallengeMethod | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeCodeChallengeMethod method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeCodeChallengeMethod%20-%20Python%20SDK&description=CreateAuthKeysCodeCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Values - -| Name | Value | -| ------- | ------- | -| `S256` | S256 | -| `PLAIN` | plain | \ No newline at end of file diff --git a/client-sdks/python/operations/createauthkeyscodedata.mdx b/client-sdks/python/operations/createauthkeyscodedata.mdx deleted file mode 100644 index fa46372a..00000000 --- a/client-sdks/python/operations/createauthkeyscodedata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeData - Python SDK -description: CreateAuthKeysCodeData method reference -seoTitle: CreateAuthKeysCodeData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createauthkeyscodedata' -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeData | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeData%20-%20Python%20SDK&description=CreateAuthKeysCodeData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Auth code data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | -| `app_id` | *float* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/createauthkeyscoderequest.mdx b/client-sdks/python/operations/createauthkeyscoderequest.mdx deleted file mode 100644 index fc097c33..00000000 --- a/client-sdks/python/operations/createauthkeyscoderequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateAuthKeysCodeRequest - Python SDK -description: CreateAuthKeysCodeRequest method reference -seoTitle: CreateAuthKeysCodeRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createauthkeyscoderequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequest | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequest%20-%20Python%20SDK&description=CreateAuthKeysCodeRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `callback_url` | *str* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `code_challenge` | *Optional[str]* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `code_challenge_method` | [Optional[operations.CreateAuthKeysCodeCodeChallengeMethod]](../operations/createauthkeyscodecodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `limit` | *Optional[float]* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Optional expiration time for the API key to be created | | \ No newline at end of file diff --git a/client-sdks/python/operations/createauthkeyscoderesponse.mdx b/client-sdks/python/operations/createauthkeyscoderesponse.mdx deleted file mode 100644 index 09272fab..00000000 --- a/client-sdks/python/operations/createauthkeyscoderesponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateAuthKeysCodeResponse - Python SDK -description: CreateAuthKeysCodeResponse method reference -seoTitle: CreateAuthKeysCodeResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createauthkeyscoderesponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeResponse | OpenRouter Python SDK -'og:description': >- - CreateAuthKeysCodeResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeResponse%20-%20Python%20SDK&description=CreateAuthKeysCodeResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Successfully created authorization code - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](/client-sdks/python/api-reference/operations/createauthkeyscodedata) | :heavy_check_mark: | Auth code data | `{"id": "auth_code_xyz789","app_id": 12345,"created_at": "2025-08-24T10:30:00Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/createcoinbasechargedata.mdx b/client-sdks/python/operations/createcoinbasechargedata.mdx deleted file mode 100644 index b1476694..00000000 --- a/client-sdks/python/operations/createcoinbasechargedata.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreateCoinbaseChargeData - Python SDK -description: CreateCoinbaseChargeData method reference -seoTitle: CreateCoinbaseChargeData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createcoinbasechargedata' -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeData | OpenRouter Python SDK -'og:description': >- - CreateCoinbaseChargeData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeData%20-%20Python%20SDK&description=CreateCoinbaseChargeData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | -| `created_at` | *str* | :heavy_check_mark: | N/A | -| `expires_at` | *str* | :heavy_check_mark: | N/A | -| `web3_data` | [operations.Web3Data](/client-sdks/python/operations/web3data) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createcoinbasechargeresponse.mdx b/client-sdks/python/operations/createcoinbasechargeresponse.mdx deleted file mode 100644 index dd543643..00000000 --- a/client-sdks/python/operations/createcoinbasechargeresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateCoinbaseChargeResponse - Python SDK -description: CreateCoinbaseChargeResponse method reference -seoTitle: CreateCoinbaseChargeResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createcoinbasechargeresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeResponse | OpenRouter Python SDK -'og:description': >- - CreateCoinbaseChargeResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeResponse%20-%20Python%20SDK&description=CreateCoinbaseChargeResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns the calldata to fulfill the transaction - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | [operations.CreateCoinbaseChargeData](/client-sdks/python/operations/createcoinbasechargedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createcoinbasechargesecurity.mdx b/client-sdks/python/operations/createcoinbasechargesecurity.mdx deleted file mode 100644 index ecbc6730..00000000 --- a/client-sdks/python/operations/createcoinbasechargesecurity.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: CreateCoinbaseChargeSecurity - Python SDK -description: CreateCoinbaseChargeSecurity method reference -seoTitle: CreateCoinbaseChargeSecurity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createcoinbasechargesecurity' -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeSecurity | OpenRouter Python SDK -'og:description': >- - CreateCoinbaseChargeSecurity method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeSecurity%20-%20Python%20SDK&description=CreateCoinbaseChargeSecurity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createembeddingsdata.mdx b/client-sdks/python/operations/createembeddingsdata.mdx deleted file mode 100644 index 9ad0636d..00000000 --- a/client-sdks/python/operations/createembeddingsdata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateEmbeddingsData - Python SDK -description: CreateEmbeddingsData method reference -seoTitle: CreateEmbeddingsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createembeddingsdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsData | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsData%20-%20Python%20SDK&description=CreateEmbeddingsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `object` | [operations.ObjectEmbedding](/client-sdks/python/api-reference/operations/objectembedding) | :heavy_check_mark: | N/A | -| `embedding` | [operations.Embedding](/client-sdks/python/api-reference/operations/embedding) | :heavy_check_mark: | N/A | -| `index` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createembeddingsrequest.mdx b/client-sdks/python/operations/createembeddingsrequest.mdx deleted file mode 100644 index 86a23bd5..00000000 --- a/client-sdks/python/operations/createembeddingsrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateEmbeddingsRequest - Python SDK -description: CreateEmbeddingsRequest method reference -seoTitle: CreateEmbeddingsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createembeddingsrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequest | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequest%20-%20Python%20SDK&description=CreateEmbeddingsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `input` | [operations.InputUnion](/client-sdks/python/api-reference/operations/inputunion) | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `encoding_format` | [Optional[operations.EncodingFormat]](../operations/encodingformat.md) | :heavy_minus_sign: | N/A | -| `dimensions` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `user` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `provider` | [Optional[components.ProviderPreferences]](../components/providerpreferences.md) | :heavy_minus_sign: | Provider routing preferences for the request. | -| `input_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createembeddingsresponse.mdx b/client-sdks/python/operations/createembeddingsresponse.mdx deleted file mode 100644 index 217dedd6..00000000 --- a/client-sdks/python/operations/createembeddingsresponse.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateEmbeddingsResponse - Python SDK -description: CreateEmbeddingsResponse method reference -seoTitle: CreateEmbeddingsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createembeddingsresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponse | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponse%20-%20Python%20SDK&description=CreateEmbeddingsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateEmbeddingsResponseBody` - -```python lines -value: operations.CreateEmbeddingsResponseBody = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/createembeddingsresponsebody.mdx b/client-sdks/python/operations/createembeddingsresponsebody.mdx deleted file mode 100644 index 66397752..00000000 --- a/client-sdks/python/operations/createembeddingsresponsebody.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateEmbeddingsResponseBody - Python SDK -description: CreateEmbeddingsResponseBody method reference -seoTitle: CreateEmbeddingsResponseBody | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createembeddingsresponsebody' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponseBody | OpenRouter Python SDK -'og:description': >- - CreateEmbeddingsResponseBody method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponseBody%20-%20Python%20SDK&description=CreateEmbeddingsResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Embedding response - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `object` | [operations.Object](/client-sdks/python/api-reference/operations/object) | :heavy_check_mark: | N/A | -| `data` | List[[operations.CreateEmbeddingsData](/client-sdks/python/api-reference/operations/createembeddingsdata)] | :heavy_check_mark: | N/A | -| `model` | *str* | :heavy_check_mark: | N/A | -| `usage` | [Optional[operations.Usage]](../operations/usage.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/createguardraildata.mdx b/client-sdks/python/operations/createguardraildata.mdx deleted file mode 100644 index a102ab39..00000000 --- a/client-sdks/python/operations/createguardraildata.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CreateGuardrailData - Python SDK -description: CreateGuardrailData method reference -seoTitle: CreateGuardrailData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailData | OpenRouter Python SDK -'og:description': >- - CreateGuardrailData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailData%20-%20Python%20SDK&description=CreateGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The created guardrail - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `reset_interval` | [OptionalNullable[operations.CreateGuardrailResetIntervalResponse]](../operations/createguardrailresetintervalresponse.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/createguardrailrequest.mdx b/client-sdks/python/operations/createguardrailrequest.mdx deleted file mode 100644 index f0214621..00000000 --- a/client-sdks/python/operations/createguardrailrequest.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: CreateGuardrailRequest - Python SDK -description: CreateGuardrailRequest method reference -seoTitle: CreateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - CreateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20Python%20SDK&description=CreateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `name` | *str* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 50 | -| `reset_interval` | [OptionalNullable[operations.CreateGuardrailResetIntervalRequest]](../operations/createguardrailresetintervalrequest.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false | \ No newline at end of file diff --git a/client-sdks/python/operations/createguardrailresetintervalrequest.mdx b/client-sdks/python/operations/createguardrailresetintervalrequest.mdx deleted file mode 100644 index 7a533b53..00000000 --- a/client-sdks/python/operations/createguardrailresetintervalrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateGuardrailResetIntervalRequest - Python SDK -description: CreateGuardrailResetIntervalRequest method reference -seoTitle: CreateGuardrailResetIntervalRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/createguardrailresetintervalrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResetIntervalRequest | OpenRouter Python SDK -'og:description': >- - CreateGuardrailResetIntervalRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResetIntervalRequest%20-%20Python%20SDK&description=CreateGuardrailResetIntervalRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/createguardrailresetintervalresponse.mdx b/client-sdks/python/operations/createguardrailresetintervalresponse.mdx deleted file mode 100644 index 66f24aa9..00000000 --- a/client-sdks/python/operations/createguardrailresetintervalresponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: CreateGuardrailResetIntervalResponse - Python SDK -description: CreateGuardrailResetIntervalResponse method reference -seoTitle: CreateGuardrailResetIntervalResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/createguardrailresetintervalresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResetIntervalResponse | OpenRouter Python SDK -'og:description': >- - CreateGuardrailResetIntervalResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResetIntervalResponse%20-%20Python%20SDK&description=CreateGuardrailResetIntervalResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/createguardrailresponse.mdx b/client-sdks/python/operations/createguardrailresponse.mdx deleted file mode 100644 index fc25845e..00000000 --- a/client-sdks/python/operations/createguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateGuardrailResponse - Python SDK -description: CreateGuardrailResponse method reference -seoTitle: CreateGuardrailResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResponse | OpenRouter Python SDK -'og:description': >- - CreateGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResponse%20-%20Python%20SDK&description=CreateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Guardrail created successfully - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateGuardrailData](/client-sdks/python/operations/createguardraildata) | :heavy_check_mark: | The created guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/createkeysdata.mdx b/client-sdks/python/operations/createkeysdata.mdx deleted file mode 100644 index 2f25b4b0..00000000 --- a/client-sdks/python/operations/createkeysdata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: CreateKeysData - Python SDK -description: CreateKeysData method reference -seoTitle: CreateKeysData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createkeysdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysData | OpenRouter Python SDK -'og:description': >- - CreateKeysData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysData%20-%20Python%20SDK&description=CreateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The created API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/python/operations/createkeyslimitreset.mdx b/client-sdks/python/operations/createkeyslimitreset.mdx deleted file mode 100644 index 7b5f6d18..00000000 --- a/client-sdks/python/operations/createkeyslimitreset.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateKeysLimitReset - Python SDK -description: CreateKeysLimitReset method reference -seoTitle: CreateKeysLimitReset | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createkeyslimitreset' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysLimitReset | OpenRouter Python SDK -'og:description': >- - CreateKeysLimitReset method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysLimitReset%20-%20Python%20SDK&description=CreateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/createkeysrequest.mdx b/client-sdks/python/operations/createkeysrequest.mdx deleted file mode 100644 index acaa3914..00000000 --- a/client-sdks/python/operations/createkeysrequest.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CreateKeysRequest - Python SDK -description: CreateKeysRequest method reference -seoTitle: CreateKeysRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createkeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequest | OpenRouter Python SDK -'og:description': >- - CreateKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequest%20-%20Python%20SDK&description=CreateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limit_reset` | [OptionalNullable[operations.CreateKeysLimitReset]](../operations/createkeyslimitreset.md) | :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 | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :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 | \ No newline at end of file diff --git a/client-sdks/python/operations/createkeysresponse.mdx b/client-sdks/python/operations/createkeysresponse.mdx deleted file mode 100644 index 08b8cba6..00000000 --- a/client-sdks/python/operations/createkeysresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CreateKeysResponse - Python SDK -description: CreateKeysResponse method reference -seoTitle: CreateKeysResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createkeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysResponse | OpenRouter Python SDK -'og:description': >- - CreateKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysResponse%20-%20Python%20SDK&description=CreateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key created successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateKeysData](/client-sdks/python/api-reference/operations/createkeysdata) | :heavy_check_mark: | The created API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | -| `key` | *str* | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/client-sdks/python/operations/createresponsesresponse.mdx b/client-sdks/python/operations/createresponsesresponse.mdx deleted file mode 100644 index 78d2b666..00000000 --- a/client-sdks/python/operations/createresponsesresponse.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: CreateResponsesResponse - Python SDK -description: CreateResponsesResponse method reference -seoTitle: CreateResponsesResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createresponsesresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponse | OpenRouter Python SDK -'og:description': >- - CreateResponsesResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponse%20-%20Python%20SDK&description=CreateResponsesResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.OpenResponsesNonStreamingResponse` - -```python lines -value: components.OpenResponsesNonStreamingResponse = /* values here */ -``` - -### `Union[eventstreaming.EventStream[components.OpenResponsesStreamEvent], eventstreaming.EventStreamAsync[components.OpenResponsesStreamEvent]]` - -```python lines -value: Union[eventstreaming.EventStream[components.OpenResponsesStreamEvent], eventstreaming.EventStreamAsync[components.OpenResponsesStreamEvent]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/createresponsesresponsebody.mdx b/client-sdks/python/operations/createresponsesresponsebody.mdx deleted file mode 100644 index d22bd888..00000000 --- a/client-sdks/python/operations/createresponsesresponsebody.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: CreateResponsesResponseBody - Python SDK -description: CreateResponsesResponseBody method reference -seoTitle: CreateResponsesResponseBody | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/createresponsesresponsebody' -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponseBody | OpenRouter Python SDK -'og:description': >- - CreateResponsesResponseBody method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponseBody%20-%20Python%20SDK&description=CreateResponsesResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Successful response - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.OpenResponsesStreamEvent](/client-sdks/python/components/openresponsesstreamevent) | :heavy_check_mark: | Union of all possible event types emitted during response streaming | `{"type": "response.created","response": {"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "in_progress","output": [],"tools": [],"tool_choice": "auto","parallel_tool_calls": true,"error": null,"incomplete_details": null,"metadata": null,"instructions": null,"temperature": null,"top_p": null,"max_output_tokens": null}`,
"sequence_number": `0
`} | \ No newline at end of file diff --git a/client-sdks/python/operations/deleteguardrailrequest.mdx b/client-sdks/python/operations/deleteguardrailrequest.mdx deleted file mode 100644 index d5b4b9d5..00000000 --- a/client-sdks/python/operations/deleteguardrailrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: DeleteGuardrailRequest - Python SDK -description: DeleteGuardrailRequest method reference -seoTitle: DeleteGuardrailRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/deleteguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailRequest | OpenRouter Python SDK -'og:description': >- - DeleteGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailRequest%20-%20Python%20SDK&description=DeleteGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/operations/deleteguardrailresponse.mdx b/client-sdks/python/operations/deleteguardrailresponse.mdx deleted file mode 100644 index 7949aa2e..00000000 --- a/client-sdks/python/operations/deleteguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteGuardrailResponse - Python SDK -description: DeleteGuardrailResponse method reference -seoTitle: DeleteGuardrailResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/deleteguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailResponse | OpenRouter Python SDK -'og:description': >- - DeleteGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailResponse%20-%20Python%20SDK&description=DeleteGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Guardrail deleted successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/client-sdks/python/operations/deletekeysrequest.mdx b/client-sdks/python/operations/deletekeysrequest.mdx deleted file mode 100644 index df351e2a..00000000 --- a/client-sdks/python/operations/deletekeysrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: DeleteKeysRequest - Python SDK -description: DeleteKeysRequest method reference -seoTitle: DeleteKeysRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/deletekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysRequest | OpenRouter Python SDK -'og:description': >- - DeleteKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysRequest%20-%20Python%20SDK&description=DeleteKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to delete | 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 | \ No newline at end of file diff --git a/client-sdks/python/operations/deletekeysresponse.mdx b/client-sdks/python/operations/deletekeysresponse.mdx deleted file mode 100644 index 063572d7..00000000 --- a/client-sdks/python/operations/deletekeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: DeleteKeysResponse - Python SDK -description: DeleteKeysResponse method reference -seoTitle: DeleteKeysResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/deletekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysResponse | OpenRouter Python SDK -'og:description': >- - DeleteKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysResponse%20-%20Python%20SDK&description=DeleteKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key deleted successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *Literal[True]* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/client-sdks/python/operations/embedding.mdx b/client-sdks/python/operations/embedding.mdx deleted file mode 100644 index 3e3950b9..00000000 --- a/client-sdks/python/operations/embedding.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Embedding - Python SDK -description: Embedding method reference -seoTitle: Embedding | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/embedding' -'og:site_name': OpenRouter Documentation -'og:title': Embedding | OpenRouter Python SDK -'og:description': >- - Embedding method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embedding%20-%20Python%20SDK&description=Embedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `List[float]` - -```python lines -value: List[float] = /* values here */ -``` - -### `str` - -```python lines -value: str = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/encodingformat.mdx b/client-sdks/python/operations/encodingformat.mdx deleted file mode 100644 index 3773efbb..00000000 --- a/client-sdks/python/operations/encodingformat.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: EncodingFormat - Python SDK -description: EncodingFormat method reference -seoTitle: EncodingFormat | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/encodingformat' -'og:site_name': OpenRouter Documentation -'og:title': EncodingFormat | OpenRouter Python SDK -'og:description': >- - EncodingFormat method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EncodingFormat%20-%20Python%20SDK&description=EncodingFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| -------- | -------- | -| `FLOAT` | float | -| `BASE64` | base64 | \ No newline at end of file diff --git a/client-sdks/python/operations/exchangeauthcodeforapikeycodechallengemethod.mdx b/client-sdks/python/operations/exchangeauthcodeforapikeycodechallengemethod.mdx deleted file mode 100644 index 85119fe1..00000000 --- a/client-sdks/python/operations/exchangeauthcodeforapikeycodechallengemethod.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyCodeChallengeMethod - Python SDK -description: ExchangeAuthCodeForAPIKeyCodeChallengeMethod method reference -seoTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/exchangeauthcodeforapikeycodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyCodeChallengeMethod method documentation for the - OpenRouter Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Values - -| Name | Value | -| ------- | ------- | -| `S256` | S256 | -| `PLAIN` | plain | \ No newline at end of file diff --git a/client-sdks/python/operations/exchangeauthcodeforapikeyrequest.mdx b/client-sdks/python/operations/exchangeauthcodeforapikeyrequest.mdx deleted file mode 100644 index fb07c60d..00000000 --- a/client-sdks/python/operations/exchangeauthcodeforapikeyrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequest - Python SDK -description: ExchangeAuthCodeForAPIKeyRequest method reference -seoTitle: ExchangeAuthCodeForAPIKeyRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/exchangeauthcodeforapikeyrequest -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequest | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequest%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `code` | *str* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `code_verifier` | *Optional[str]* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | -| `code_challenge_method` | [OptionalNullable[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod]](../operations/exchangeauthcodeforapikeycodechallengemethod.md) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | \ No newline at end of file diff --git a/client-sdks/python/operations/exchangeauthcodeforapikeyresponse.mdx b/client-sdks/python/operations/exchangeauthcodeforapikeyresponse.mdx deleted file mode 100644 index 60dee2ce..00000000 --- a/client-sdks/python/operations/exchangeauthcodeforapikeyresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyResponse - Python SDK -description: ExchangeAuthCodeForAPIKeyResponse method reference -seoTitle: ExchangeAuthCodeForAPIKeyResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/exchangeauthcodeforapikeyresponse -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyResponse | OpenRouter Python SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyResponse%20-%20Python%20SDK&description=ExchangeAuthCodeForAPIKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Successfully exchanged code for an API key - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *str* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `user_id` | *Nullable[str]* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/client-sdks/python/operations/getcreditsdata.mdx b/client-sdks/python/operations/getcreditsdata.mdx deleted file mode 100644 index 5e9b11cc..00000000 --- a/client-sdks/python/operations/getcreditsdata.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetCreditsData - Python SDK -description: GetCreditsData method reference -seoTitle: GetCreditsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getcreditsdata' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsData | OpenRouter Python SDK -'og:description': >- - GetCreditsData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsData%20-%20Python%20SDK&description=GetCreditsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `total_credits` | *float* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `total_usage` | *float* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/client-sdks/python/operations/getcreditsresponse.mdx b/client-sdks/python/operations/getcreditsresponse.mdx deleted file mode 100644 index bf6a43c5..00000000 --- a/client-sdks/python/operations/getcreditsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetCreditsResponse - Python SDK -description: GetCreditsResponse method reference -seoTitle: GetCreditsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getcreditsresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsResponse | OpenRouter Python SDK -'og:description': >- - GetCreditsResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsResponse%20-%20Python%20SDK&description=GetCreditsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Total credits purchased and used - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.GetCreditsData](/client-sdks/python/api-reference/operations/getcreditsdata) | :heavy_check_mark: | N/A | `{"total_credits": 100.5,"total_usage": 25.75}` | \ No newline at end of file diff --git a/client-sdks/python/operations/getcurrentkeydata.mdx b/client-sdks/python/operations/getcurrentkeydata.mdx deleted file mode 100644 index c166e682..00000000 --- a/client-sdks/python/operations/getcurrentkeydata.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: GetCurrentKeyData - Python SDK -description: GetCurrentKeyData method reference -seoTitle: GetCurrentKeyData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getcurrentkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyData | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyData%20-%20Python%20SDK&description=GetCurrentKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Current API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | 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 | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `is_free_tier` | *bool* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `is_provisioning_key` | *bool* | :heavy_check_mark: | Whether this is a provisioning key | false | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| ~~`rate_limit`~~ | [operations.RateLimit](/client-sdks/python/api-reference/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. | `{"requests": 1000,"interval": "1h","note": "This field is deprecated and safe to ignore."}` | \ No newline at end of file diff --git a/client-sdks/python/operations/getcurrentkeyresponse.mdx b/client-sdks/python/operations/getcurrentkeyresponse.mdx deleted file mode 100644 index a9bb019d..00000000 --- a/client-sdks/python/operations/getcurrentkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetCurrentKeyResponse - Python SDK -description: GetCurrentKeyResponse method reference -seoTitle: GetCurrentKeyResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getcurrentkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyResponse | OpenRouter Python SDK -'og:description': >- - GetCurrentKeyResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyResponse%20-%20Python%20SDK&description=GetCurrentKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetCurrentKeyData](/client-sdks/python/api-reference/operations/getcurrentkeydata) | :heavy_check_mark: | Current API key information | `{"label": "sk-or-v1-au78b3456789012345678901234567890","limit": 100,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"is_free_tier": false,"is_provisioning_key": false,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"expires_at": "2027-12-31T23:59:59Z","rate_limit": {"requests": 1000,"interval": "1h","note": "This field is deprecated and safe to ignore."}`
} | \ No newline at end of file diff --git a/client-sdks/python/operations/getgenerationdata.mdx b/client-sdks/python/operations/getgenerationdata.mdx deleted file mode 100644 index 2f5dd83a..00000000 --- a/client-sdks/python/operations/getgenerationdata.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: GetGenerationData - Python SDK -description: GetGenerationData method reference -seoTitle: GetGenerationData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getgenerationdata' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationData | OpenRouter Python SDK -'og:description': >- - GetGenerationData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationData%20-%20Python%20SDK&description=GetGenerationData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Generation data - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `upstream_id` | *Nullable[str]* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `total_cost` | *float* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `cache_discount` | *Nullable[float]* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `upstream_inference_cost` | *Nullable[float]* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `model` | *str* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `app_id` | *Nullable[float]* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `streamed` | *Nullable[bool]* | :heavy_check_mark: | Whether the response was streamed | true | -| `cancelled` | *Nullable[bool]* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `provider_name` | *Nullable[str]* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `latency` | *Nullable[float]* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `moderation_latency` | *Nullable[float]* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `generation_time` | *Nullable[float]* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `finish_reason` | *Nullable[str]* | :heavy_check_mark: | Reason the generation finished | stop | -| `tokens_prompt` | *Nullable[float]* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `tokens_completion` | *Nullable[float]* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `native_tokens_prompt` | *Nullable[float]* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `native_tokens_completion` | *Nullable[float]* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `native_tokens_completion_images` | *Nullable[float]* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `native_tokens_reasoning` | *Nullable[float]* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `native_tokens_cached` | *Nullable[float]* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `num_media_prompt` | *Nullable[float]* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `num_input_audio_prompt` | *Nullable[float]* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `num_media_completion` | *Nullable[float]* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `num_search_results` | *Nullable[float]* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *str* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `usage` | *float* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `is_byok` | *bool* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `native_finish_reason` | *Nullable[str]* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `external_user` | *Nullable[str]* | :heavy_check_mark: | External user identifier | user-123 | -| `api_type` | [Nullable[operations.APIType]](../operations/apitype.md) | :heavy_check_mark: | Type of API used for the generation | | -| `router` | *Nullable[str]* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | \ No newline at end of file diff --git a/client-sdks/python/operations/getgenerationrequest.mdx b/client-sdks/python/operations/getgenerationrequest.mdx deleted file mode 100644 index b230b699..00000000 --- a/client-sdks/python/operations/getgenerationrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: GetGenerationRequest - Python SDK -description: GetGenerationRequest method reference -seoTitle: GetGenerationRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getgenerationrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationRequest | OpenRouter Python SDK -'og:description': >- - GetGenerationRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationRequest%20-%20Python%20SDK&description=GetGenerationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/getgenerationresponse.mdx b/client-sdks/python/operations/getgenerationresponse.mdx deleted file mode 100644 index cb1c3ebf..00000000 --- a/client-sdks/python/operations/getgenerationresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetGenerationResponse - Python SDK -description: GetGenerationResponse method reference -seoTitle: GetGenerationResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getgenerationresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationResponse | OpenRouter Python SDK -'og:description': >- - GetGenerationResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationResponse%20-%20Python%20SDK&description=GetGenerationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Generation response - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | [operations.GetGenerationData](/client-sdks/python/operations/getgenerationdata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/client-sdks/python/operations/getguardraildata.mdx b/client-sdks/python/operations/getguardraildata.mdx deleted file mode 100644 index ef83a931..00000000 --- a/client-sdks/python/operations/getguardraildata.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: GetGuardrailData - Python SDK -description: GetGuardrailData method reference -seoTitle: GetGuardrailData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailData | OpenRouter Python SDK -'og:description': >- - GetGuardrailData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailData%20-%20Python%20SDK&description=GetGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The guardrail - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `reset_interval` | [OptionalNullable[operations.GetGuardrailResetInterval]](../operations/getguardrailresetinterval.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/getguardrailrequest.mdx b/client-sdks/python/operations/getguardrailrequest.mdx deleted file mode 100644 index bc252941..00000000 --- a/client-sdks/python/operations/getguardrailrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: GetGuardrailRequest - Python SDK -description: GetGuardrailRequest method reference -seoTitle: GetGuardrailRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailRequest | OpenRouter Python SDK -'og:description': >- - GetGuardrailRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailRequest%20-%20Python%20SDK&description=GetGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/python/operations/getguardrailresetinterval.mdx b/client-sdks/python/operations/getguardrailresetinterval.mdx deleted file mode 100644 index 27b6d7c3..00000000 --- a/client-sdks/python/operations/getguardrailresetinterval.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: GetGuardrailResetInterval - Python SDK -description: GetGuardrailResetInterval method reference -seoTitle: GetGuardrailResetInterval | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getguardrailresetinterval' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResetInterval | OpenRouter Python SDK -'og:description': >- - GetGuardrailResetInterval method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResetInterval%20-%20Python%20SDK&description=GetGuardrailResetInterval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/getguardrailresponse.mdx b/client-sdks/python/operations/getguardrailresponse.mdx deleted file mode 100644 index 6da5fdf2..00000000 --- a/client-sdks/python/operations/getguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetGuardrailResponse - Python SDK -description: GetGuardrailResponse method reference -seoTitle: GetGuardrailResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResponse | OpenRouter Python SDK -'og:description': >- - GetGuardrailResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResponse%20-%20Python%20SDK&description=GetGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Guardrail details - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetGuardrailData](/client-sdks/python/operations/getguardraildata) | :heavy_check_mark: | The guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/getkeydata.mdx b/client-sdks/python/operations/getkeydata.mdx deleted file mode 100644 index 5160173a..00000000 --- a/client-sdks/python/operations/getkeydata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: GetKeyData - Python SDK -description: GetKeyData method reference -seoTitle: GetKeyData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyData | OpenRouter Python SDK -'og:description': >- - GetKeyData method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyData%20-%20Python%20SDK&description=GetKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/python/operations/getkeyrequest.mdx b/client-sdks/python/operations/getkeyrequest.mdx deleted file mode 100644 index 126f8bc7..00000000 --- a/client-sdks/python/operations/getkeyrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: GetKeyRequest - Python SDK -description: GetKeyRequest method reference -seoTitle: GetKeyRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyRequest | OpenRouter Python SDK -'og:description': >- - GetKeyRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyRequest%20-%20Python%20SDK&description=GetKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to retrieve | 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 | \ No newline at end of file diff --git a/client-sdks/python/operations/getkeyresponse.mdx b/client-sdks/python/operations/getkeyresponse.mdx deleted file mode 100644 index 32b7555a..00000000 --- a/client-sdks/python/operations/getkeyresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetKeyResponse - Python SDK -description: GetKeyResponse method reference -seoTitle: GetKeyResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyResponse | OpenRouter Python SDK -'og:description': >- - GetKeyResponse method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyResponse%20-%20Python%20SDK&description=GetKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key details - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetKeyData](/client-sdks/python/api-reference/operations/getkeydata) | :heavy_check_mark: | The API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/getmodelsrequest.mdx b/client-sdks/python/operations/getmodelsrequest.mdx deleted file mode 100644 index 665088fa..00000000 --- a/client-sdks/python/operations/getmodelsrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GetModelsRequest - Python SDK -description: GetModelsRequest method reference -seoTitle: GetModelsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getmodelsrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetModelsRequest | OpenRouter Python SDK -'og:description': >- - GetModelsRequest method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsRequest%20-%20Python%20SDK&description=GetModelsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `category` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `supported_parameters` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/getuseractivityrequest.mdx b/client-sdks/python/operations/getuseractivityrequest.mdx deleted file mode 100644 index 638d695c..00000000 --- a/client-sdks/python/operations/getuseractivityrequest.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: GetUserActivityRequest - Python SDK -description: GetUserActivityRequest method reference -seoTitle: GetUserActivityRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getuseractivityrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityRequest | OpenRouter Python SDK -'og:description': >- - GetUserActivityRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityRequest%20-%20Python%20SDK&description=GetUserActivityRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `date_` | *Optional[str]* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | \ No newline at end of file diff --git a/client-sdks/python/operations/getuseractivityresponse.mdx b/client-sdks/python/operations/getuseractivityresponse.mdx deleted file mode 100644 index f5ce587f..00000000 --- a/client-sdks/python/operations/getuseractivityresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: GetUserActivityResponse - Python SDK -description: GetUserActivityResponse method reference -seoTitle: GetUserActivityResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/getuseractivityresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityResponse | OpenRouter Python SDK -'og:description': >- - GetUserActivityResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityResponse%20-%20Python%20SDK&description=GetUserActivityResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns user activity data grouped by endpoint - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | List[[components.ActivityItem](/client-sdks/python/api-reference/components/activityitem)] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/client-sdks/python/operations/imageurl.mdx b/client-sdks/python/operations/imageurl.mdx deleted file mode 100644 index 7bfe8463..00000000 --- a/client-sdks/python/operations/imageurl.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ImageURL - Python SDK -description: ImageURL method reference -seoTitle: ImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageURL | OpenRouter Python SDK -'og:description': >- - ImageURL method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageURL%20-%20Python%20SDK&description=ImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/input.mdx b/client-sdks/python/operations/input.mdx deleted file mode 100644 index 1c580757..00000000 --- a/client-sdks/python/operations/input.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Input - Python SDK -description: Input method reference -seoTitle: Input | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/input' -'og:site_name': OpenRouter Documentation -'og:title': Input | OpenRouter Python SDK -'og:description': >- - Input method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input%20-%20Python%20SDK&description=Input%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | List[[operations.Content](/client-sdks/python/api-reference/operations/content)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/inputunion.mdx b/client-sdks/python/operations/inputunion.mdx deleted file mode 100644 index 3f7f8b30..00000000 --- a/client-sdks/python/operations/inputunion.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: InputUnion - Python SDK -description: InputUnion method reference -seoTitle: InputUnion | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion | OpenRouter Python SDK -'og:description': >- - InputUnion method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20Python%20SDK&description=InputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `str` - -```python lines -value: str = /* values here */ -``` - -### `List[str]` - -```python lines -value: List[str] = /* values here */ -``` - -### `List[float]` - -```python lines -value: List[float] = /* values here */ -``` - -### `List[List[float]]` - -```python lines -value: List[List[float]] = /* values here */ -``` - -### `List[operations.Input]` - -```python lines -value: List[operations.Input] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/listdata.mdx b/client-sdks/python/operations/listdata.mdx deleted file mode 100644 index ef72e9f6..00000000 --- a/client-sdks/python/operations/listdata.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ListData - Python SDK -description: ListData method reference -seoTitle: ListData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listdata' -'og:site_name': OpenRouter Documentation -'og:title': ListData | OpenRouter Python SDK -'og:description': >- - ListData method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListData%20-%20Python%20SDK&description=ListData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listendpointsrequest.mdx b/client-sdks/python/operations/listendpointsrequest.mdx deleted file mode 100644 index 1765615b..00000000 --- a/client-sdks/python/operations/listendpointsrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ListEndpointsRequest - Python SDK -description: ListEndpointsRequest method reference -seoTitle: ListEndpointsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listendpointsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsRequest | OpenRouter Python SDK -'og:description': >- - ListEndpointsRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsRequest%20-%20Python%20SDK&description=ListEndpointsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `author` | *str* | :heavy_check_mark: | N/A | -| `slug` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/listendpointsresponse.mdx b/client-sdks/python/operations/listendpointsresponse.mdx deleted file mode 100644 index 77bf7b6b..00000000 --- a/client-sdks/python/operations/listendpointsresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListEndpointsResponse - Python SDK -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listendpointsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20Python%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [components.ListEndpointsResponse](/client-sdks/python/api-reference/components/listendpointsresponse) | :heavy_check_mark: | List of available endpoints for a model | `{"id": "openai/gpt-4","name": "GPT-4","created": 1692901234,"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.","architecture": {"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}`,
"endpoints": [
`{"name": "OpenAI: GPT-4","model_name": "GPT-4","context_length": 8192,"pricing": {"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"}`,
"provider_name": "OpenAI",
"tag": "openai",
"quantization": "fp16",
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"status": "default",
"uptime_last_30m": 99.5,
"supports_implicit_caching": true,
"latency_last_30m": `{"p50": 0.25,"p75": 0.35,"p90": 0.48,"p99": 0.85}`,
"throughput_last_30m": `{"p50": 45.2,"p75": 38.5,"p90": 28.3,"p99": 15.1}`
}
]
} | \ No newline at end of file diff --git a/client-sdks/python/operations/listendpointszdrresponse.mdx b/client-sdks/python/operations/listendpointszdrresponse.mdx deleted file mode 100644 index 028418ff..00000000 --- a/client-sdks/python/operations/listendpointszdrresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListEndpointsZdrResponse - Python SDK -description: ListEndpointsZdrResponse method reference -seoTitle: ListEndpointsZdrResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listendpointszdrresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrResponse | OpenRouter Python SDK -'og:description': >- - ListEndpointsZdrResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrResponse%20-%20Python%20SDK&description=ListEndpointsZdrResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `data` | List[[components.PublicEndpoint](/client-sdks/python/api-reference/components/publicendpoint)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailkeyassignmentsdata.mdx b/client-sdks/python/operations/listguardrailkeyassignmentsdata.mdx deleted file mode 100644 index b157879a..00000000 --- a/client-sdks/python/operations/listguardrailkeyassignmentsdata.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsData - Python SDK -description: ListGuardrailKeyAssignmentsData method reference -seoTitle: ListGuardrailKeyAssignmentsData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailkeyassignmentsdata -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsData | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsData method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsData%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hash` | *str* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `key_name` | *str* | :heavy_check_mark: | Name of the API key | Production Key | -| `key_label` | *str* | :heavy_check_mark: | Label of the API key | prod-key | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailkeyassignmentsrequest.mdx b/client-sdks/python/operations/listguardrailkeyassignmentsrequest.mdx deleted file mode 100644 index 99dfc46e..00000000 --- a/client-sdks/python/operations/listguardrailkeyassignmentsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsRequest - Python SDK -description: ListGuardrailKeyAssignmentsRequest method reference -seoTitle: ListGuardrailKeyAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsRequest%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailkeyassignmentsresponse.mdx b/client-sdks/python/operations/listguardrailkeyassignmentsresponse.mdx deleted file mode 100644 index 43702a6a..00000000 --- a/client-sdks/python/operations/listguardrailkeyassignmentsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsResponse - Python SDK -description: ListGuardrailKeyAssignmentsResponse method reference -seoTitle: ListGuardrailKeyAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailKeyAssignmentsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsResponse%20-%20Python%20SDK&description=ListGuardrailKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of key assignments - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListGuardrailKeyAssignmentsData](/client-sdks/python/operations/listguardrailkeyassignmentsdata)] | :heavy_check_mark: | List of key assignments | | -| `total_count` | *float* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailmemberassignmentsdata.mdx b/client-sdks/python/operations/listguardrailmemberassignmentsdata.mdx deleted file mode 100644 index d08ce505..00000000 --- a/client-sdks/python/operations/listguardrailmemberassignmentsdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsData - Python SDK -description: ListGuardrailMemberAssignmentsData method reference -seoTitle: ListGuardrailMemberAssignmentsData | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailmemberassignmentsdata -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsData | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsData method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsData%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | -| `organization_id` | *str* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailmemberassignmentsrequest.mdx b/client-sdks/python/operations/listguardrailmemberassignmentsrequest.mdx deleted file mode 100644 index e4bf3779..00000000 --- a/client-sdks/python/operations/listguardrailmemberassignmentsrequest.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsRequest - Python SDK -description: ListGuardrailMemberAssignmentsRequest method reference -seoTitle: ListGuardrailMemberAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsRequest%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailmemberassignmentsresponse.mdx b/client-sdks/python/operations/listguardrailmemberassignmentsresponse.mdx deleted file mode 100644 index 66728285..00000000 --- a/client-sdks/python/operations/listguardrailmemberassignmentsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsResponse - Python SDK -description: ListGuardrailMemberAssignmentsResponse method reference -seoTitle: ListGuardrailMemberAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listguardrailmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailMemberAssignmentsResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsResponse%20-%20Python%20SDK&description=ListGuardrailMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of member assignments - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListGuardrailMemberAssignmentsData](/client-sdks/python/operations/listguardrailmemberassignmentsdata)] | :heavy_check_mark: | List of member assignments | | -| `total_count` | *float* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailsdata.mdx b/client-sdks/python/operations/listguardrailsdata.mdx deleted file mode 100644 index 7c3ea998..00000000 --- a/client-sdks/python/operations/listguardrailsdata.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ListGuardrailsData - Python SDK -description: ListGuardrailsData method reference -seoTitle: ListGuardrailsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listguardrailsdata' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsData | OpenRouter Python SDK -'og:description': >- - ListGuardrailsData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsData%20-%20Python%20SDK&description=ListGuardrailsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `reset_interval` | [OptionalNullable[operations.ListGuardrailsResetInterval]](../operations/listguardrailsresetinterval.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailsrequest.mdx b/client-sdks/python/operations/listguardrailsrequest.mdx deleted file mode 100644 index 7731f21c..00000000 --- a/client-sdks/python/operations/listguardrailsrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ListGuardrailsRequest - Python SDK -description: ListGuardrailsRequest method reference -seoTitle: ListGuardrailsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listguardrailsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsRequest | OpenRouter Python SDK -'og:description': >- - ListGuardrailsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsRequest%20-%20Python%20SDK&description=ListGuardrailsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailsresetinterval.mdx b/client-sdks/python/operations/listguardrailsresetinterval.mdx deleted file mode 100644 index b0c75db3..00000000 --- a/client-sdks/python/operations/listguardrailsresetinterval.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListGuardrailsResetInterval - Python SDK -description: ListGuardrailsResetInterval method reference -seoTitle: ListGuardrailsResetInterval | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listguardrailsresetinterval' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResetInterval | OpenRouter Python SDK -'og:description': >- - ListGuardrailsResetInterval method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResetInterval%20-%20Python%20SDK&description=ListGuardrailsResetInterval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/listguardrailsresponse.mdx b/client-sdks/python/operations/listguardrailsresponse.mdx deleted file mode 100644 index c9c4191c..00000000 --- a/client-sdks/python/operations/listguardrailsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListGuardrailsResponse - Python SDK -description: ListGuardrailsResponse method reference -seoTitle: ListGuardrailsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listguardrailsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse | OpenRouter Python SDK -'og:description': >- - ListGuardrailsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20Python%20SDK&description=ListGuardrailsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of guardrails - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `data` | List[[operations.ListGuardrailsData](/client-sdks/python/operations/listguardrailsdata)] | :heavy_check_mark: | List of guardrails | | -| `total_count` | *float* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/client-sdks/python/operations/listkeyassignmentsdata.mdx b/client-sdks/python/operations/listkeyassignmentsdata.mdx deleted file mode 100644 index 7a6b4dfd..00000000 --- a/client-sdks/python/operations/listkeyassignmentsdata.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ListKeyAssignmentsData - Python SDK -description: ListKeyAssignmentsData method reference -seoTitle: ListKeyAssignmentsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listkeyassignmentsdata' -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsData | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsData%20-%20Python%20SDK&description=ListKeyAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `key_hash` | *str* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `key_name` | *str* | :heavy_check_mark: | Name of the API key | Production Key | -| `key_label` | *str* | :heavy_check_mark: | Label of the API key | prod-key | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listkeyassignmentsrequest.mdx b/client-sdks/python/operations/listkeyassignmentsrequest.mdx deleted file mode 100644 index 63590979..00000000 --- a/client-sdks/python/operations/listkeyassignmentsrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ListKeyAssignmentsRequest - Python SDK -description: ListKeyAssignmentsRequest method reference -seoTitle: ListKeyAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listkeyassignmentsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsRequest%20-%20Python%20SDK&description=ListKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/operations/listkeyassignmentsresponse.mdx b/client-sdks/python/operations/listkeyassignmentsresponse.mdx deleted file mode 100644 index fa5faf02..00000000 --- a/client-sdks/python/operations/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - Python SDK -description: ListKeyAssignmentsResponse method reference -seoTitle: ListKeyAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listkeyassignmentsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListKeyAssignmentsResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20Python%20SDK&description=ListKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of key assignments - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | List[[operations.ListKeyAssignmentsData](/client-sdks/python/operations/listkeyassignmentsdata)] | :heavy_check_mark: | List of key assignments | | -| `total_count` | *float* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/python/operations/listmemberassignmentsdata.mdx b/client-sdks/python/operations/listmemberassignmentsdata.mdx deleted file mode 100644 index 9e797a37..00000000 --- a/client-sdks/python/operations/listmemberassignmentsdata.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ListMemberAssignmentsData - Python SDK -description: ListMemberAssignmentsData method reference -seoTitle: ListMemberAssignmentsData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listmemberassignmentsdata' -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsData | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsData method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsData%20-%20Python%20SDK&description=ListMemberAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `user_id` | *str* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | -| `organization_id` | *str* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `guardrail_id` | *str* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `assigned_by` | *Nullable[str]* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/listmemberassignmentsrequest.mdx b/client-sdks/python/operations/listmemberassignmentsrequest.mdx deleted file mode 100644 index 05bcc372..00000000 --- a/client-sdks/python/operations/listmemberassignmentsrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ListMemberAssignmentsRequest - Python SDK -description: ListMemberAssignmentsRequest method reference -seoTitle: ListMemberAssignmentsRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listmemberassignmentsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsRequest | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsRequest method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsRequest%20-%20Python%20SDK&description=ListMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *Optional[str]* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/python/operations/listmemberassignmentsresponse.mdx b/client-sdks/python/operations/listmemberassignmentsresponse.mdx deleted file mode 100644 index afb6cb1d..00000000 --- a/client-sdks/python/operations/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - Python SDK -description: ListMemberAssignmentsResponse method reference -seoTitle: ListMemberAssignmentsResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse | OpenRouter Python SDK -'og:description': >- - ListMemberAssignmentsResponse method documentation for the OpenRouter Python - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20Python%20SDK&description=ListMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of member assignments - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `data` | List[[operations.ListMemberAssignmentsData](/client-sdks/python/operations/listmemberassignmentsdata)] | :heavy_check_mark: | List of member assignments | | -| `total_count` | *float* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/python/operations/listmodelsusersecurity.mdx b/client-sdks/python/operations/listmodelsusersecurity.mdx deleted file mode 100644 index 7b2ab562..00000000 --- a/client-sdks/python/operations/listmodelsusersecurity.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ListModelsUserSecurity - Python SDK -description: ListModelsUserSecurity method reference -seoTitle: ListModelsUserSecurity | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listmodelsusersecurity' -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserSecurity | OpenRouter Python SDK -'og:description': >- - ListModelsUserSecurity method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserSecurity%20-%20Python%20SDK&description=ListModelsUserSecurity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/listprovidersdata.mdx b/client-sdks/python/operations/listprovidersdata.mdx deleted file mode 100644 index a03e498b..00000000 --- a/client-sdks/python/operations/listprovidersdata.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ListProvidersData - Python SDK -description: ListProvidersData method reference -seoTitle: ListProvidersData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listprovidersdata' -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersData | OpenRouter Python SDK -'og:description': >- - ListProvidersData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersData%20-%20Python%20SDK&description=ListProvidersData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `name` | *str* | :heavy_check_mark: | Display name of the provider | OpenAI | -| `slug` | *str* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `privacy_policy_url` | *Nullable[str]* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `terms_of_service_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | -| `status_page_url` | *OptionalNullable[str]* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | \ No newline at end of file diff --git a/client-sdks/python/operations/listprovidersresponse.mdx b/client-sdks/python/operations/listprovidersresponse.mdx deleted file mode 100644 index 749d5431..00000000 --- a/client-sdks/python/operations/listprovidersresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListProvidersResponse - Python SDK -description: ListProvidersResponse method reference -seoTitle: ListProvidersResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listprovidersresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersResponse | OpenRouter Python SDK -'og:description': >- - ListProvidersResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersResponse%20-%20Python%20SDK&description=ListProvidersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Returns a list of providers - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | List[[operations.ListProvidersData](/client-sdks/python/api-reference/operations/listprovidersdata)] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/listrequest.mdx b/client-sdks/python/operations/listrequest.mdx deleted file mode 100644 index cd9d7e3f..00000000 --- a/client-sdks/python/operations/listrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ListRequest - Python SDK -description: ListRequest method reference -seoTitle: ListRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListRequest | OpenRouter Python SDK -'og:description': >- - ListRequest method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListRequest%20-%20Python%20SDK&description=ListRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `include_disabled` | *Optional[str]* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *Optional[str]* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | \ No newline at end of file diff --git a/client-sdks/python/operations/listresponse.mdx b/client-sdks/python/operations/listresponse.mdx deleted file mode 100644 index 23fd2985..00000000 --- a/client-sdks/python/operations/listresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ListResponse - Python SDK -description: ListResponse method reference -seoTitle: ListResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/listresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListResponse | OpenRouter Python SDK -'og:description': >- - ListResponse method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListResponse%20-%20Python%20SDK&description=ListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -List of API keys - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | List[[operations.ListData](/client-sdks/python/api-reference/operations/listdata)] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/client-sdks/python/operations/metadata.mdx b/client-sdks/python/operations/metadata.mdx deleted file mode 100644 index 65cf7cb8..00000000 --- a/client-sdks/python/operations/metadata.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Metadata - Python SDK -description: Metadata method reference -seoTitle: Metadata | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/metadata' -'og:site_name': OpenRouter Documentation -'og:title': Metadata | OpenRouter Python SDK -'og:description': >- - Metadata method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Metadata%20-%20Python%20SDK&description=Metadata%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `chain_id` | *float* | :heavy_check_mark: | N/A | -| `contract_address` | *str* | :heavy_check_mark: | N/A | -| `sender` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/object.mdx b/client-sdks/python/operations/object.mdx deleted file mode 100644 index c0ae4096..00000000 --- a/client-sdks/python/operations/object.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Object - Python SDK -description: Object method reference -seoTitle: Object | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/object' -'og:site_name': OpenRouter Documentation -'og:title': Object | OpenRouter Python SDK -'og:description': >- - Object method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Object%20-%20Python%20SDK&description=Object%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `LIST` | list | \ No newline at end of file diff --git a/client-sdks/python/operations/objectembedding.mdx b/client-sdks/python/operations/objectembedding.mdx deleted file mode 100644 index c388939c..00000000 --- a/client-sdks/python/operations/objectembedding.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: ObjectEmbedding - Python SDK -description: ObjectEmbedding method reference -seoTitle: ObjectEmbedding | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/objectembedding' -'og:site_name': OpenRouter Documentation -'og:title': ObjectEmbedding | OpenRouter Python SDK -'og:description': >- - ObjectEmbedding method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectEmbedding%20-%20Python%20SDK&description=ObjectEmbedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `EMBEDDING` | embedding | \ No newline at end of file diff --git a/client-sdks/python/operations/ratelimit.mdx b/client-sdks/python/operations/ratelimit.mdx deleted file mode 100644 index c59aef57..00000000 --- a/client-sdks/python/operations/ratelimit.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: ~~RateLimit~~ - Python SDK -description: ~~RateLimit~~ method reference -seoTitle: ~~RateLimit~~ | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/ratelimit' -'og:site_name': OpenRouter Documentation -'og:title': ~~RateLimit~~ | OpenRouter Python SDK -'og:description': >- - ~~RateLimit~~ method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~RateLimit~~%20-%20Python%20SDK&description=~~RateLimit~~%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Legacy rate limit information about a key. Will always return -1. - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `requests` | *float* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | -| `interval` | *str* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *str* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | \ No newline at end of file diff --git a/client-sdks/python/operations/sendchatcompletionrequestresponse.mdx b/client-sdks/python/operations/sendchatcompletionrequestresponse.mdx deleted file mode 100644 index eaef20d9..00000000 --- a/client-sdks/python/operations/sendchatcompletionrequestresponse.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: SendChatCompletionRequestResponse - Python SDK -description: SendChatCompletionRequestResponse method reference -seoTitle: SendChatCompletionRequestResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/sendchatcompletionrequestresponse -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestResponse | OpenRouter Python SDK -'og:description': >- - SendChatCompletionRequestResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestResponse%20-%20Python%20SDK&description=SendChatCompletionRequestResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `components.ChatResponse` - -```python lines -value: components.ChatResponse = /* values here */ -``` - -### `Union[eventstreaming.EventStream[components.ChatStreamingResponseChunkData], eventstreaming.EventStreamAsync[components.ChatStreamingResponseChunkData]]` - -```python lines -value: Union[eventstreaming.EventStream[components.ChatStreamingResponseChunkData], eventstreaming.EventStreamAsync[components.ChatStreamingResponseChunkData]] = /* values here */ -``` \ No newline at end of file diff --git a/client-sdks/python/operations/transferintent.mdx b/client-sdks/python/operations/transferintent.mdx deleted file mode 100644 index 9e22f2bc..00000000 --- a/client-sdks/python/operations/transferintent.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: TransferIntent - Python SDK -description: TransferIntent method reference -seoTitle: TransferIntent | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/transferintent' -'og:site_name': OpenRouter Documentation -'og:title': TransferIntent | OpenRouter Python SDK -'og:description': >- - TransferIntent method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TransferIntent%20-%20Python%20SDK&description=TransferIntent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `call_data` | [operations.CallData](/client-sdks/python/operations/calldata) | :heavy_check_mark: | N/A | -| `metadata` | [operations.Metadata](/client-sdks/python/operations/metadata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/typeimageurl.mdx b/client-sdks/python/operations/typeimageurl.mdx deleted file mode 100644 index bdf17ee9..00000000 --- a/client-sdks/python/operations/typeimageurl.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeImageURL - Python SDK -description: TypeImageURL method reference -seoTitle: TypeImageURL | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/typeimageurl' -'og:site_name': OpenRouter Documentation -'og:title': TypeImageURL | OpenRouter Python SDK -'og:description': >- - TypeImageURL method documentation for the OpenRouter Python SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeImageURL%20-%20Python%20SDK&description=TypeImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ----------- | ----------- | -| `IMAGE_URL` | image_url | \ No newline at end of file diff --git a/client-sdks/python/operations/typetext.mdx b/client-sdks/python/operations/typetext.mdx deleted file mode 100644 index 43fbd87c..00000000 --- a/client-sdks/python/operations/typetext.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: TypeText - Python SDK -description: TypeText method reference -seoTitle: TypeText | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/typetext' -'og:site_name': OpenRouter Documentation -'og:title': TypeText | OpenRouter Python SDK -'og:description': >- - TypeText method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeText%20-%20Python%20SDK&description=TypeText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Values - -| Name | Value | -| ------ | ------ | -| `TEXT` | text | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardraildata.mdx b/client-sdks/python/operations/updateguardraildata.mdx deleted file mode 100644 index 9d92912a..00000000 --- a/client-sdks/python/operations/updateguardraildata.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: UpdateGuardrailData - Python SDK -description: UpdateGuardrailData method reference -seoTitle: UpdateGuardrailData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updateguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailData | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailData method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailData%20-%20Python%20SDK&description=UpdateGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The updated guardrail - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *str* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `reset_interval` | [OptionalNullable[operations.UpdateGuardrailResetIntervalResponse]](../operations/updateguardrailresetintervalresponse.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowed_models` | List[*str*] | :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"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updated_at` | *OptionalNullable[str]* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardrailrequest.mdx b/client-sdks/python/operations/updateguardrailrequest.mdx deleted file mode 100644 index 22a37c36..00000000 --- a/client-sdks/python/operations/updateguardrailrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: UpdateGuardrailRequest - Python SDK -description: UpdateGuardrailRequest method reference -seoTitle: UpdateGuardrailRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updateguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailRequest method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20Python%20SDK&description=UpdateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `request_body` | [operations.UpdateGuardrailRequestBody](/client-sdks/python/operations/updateguardrailrequestbody) | :heavy_check_mark: | N/A | `{"name": "Updated Guardrail Name","description": "Updated description","limit_usd": 75,"reset_interval": "weekly"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardrailrequestbody.mdx b/client-sdks/python/operations/updateguardrailrequestbody.mdx deleted file mode 100644 index d75490c0..00000000 --- a/client-sdks/python/operations/updateguardrailrequestbody.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: UpdateGuardrailRequestBody - Python SDK -description: UpdateGuardrailRequestBody method reference -seoTitle: UpdateGuardrailRequestBody | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updateguardrailrequestbody' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequestBody | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailRequestBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequestBody%20-%20Python%20SDK&description=UpdateGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `limit_usd` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `reset_interval` | [OptionalNullable[operations.UpdateGuardrailResetIntervalRequest]](../operations/updateguardrailresetintervalrequest.md) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowed_providers` | List[*str*] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `allowed_models` | List[*str*] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `enforce_zdr` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether to enforce zero data retention | true | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardrailresetintervalrequest.mdx b/client-sdks/python/operations/updateguardrailresetintervalrequest.mdx deleted file mode 100644 index 09b6270a..00000000 --- a/client-sdks/python/operations/updateguardrailresetintervalrequest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: UpdateGuardrailResetIntervalRequest - Python SDK -description: UpdateGuardrailResetIntervalRequest method reference -seoTitle: UpdateGuardrailResetIntervalRequest | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/updateguardrailresetintervalrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResetIntervalRequest | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailResetIntervalRequest method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResetIntervalRequest%20-%20Python%20SDK&description=UpdateGuardrailResetIntervalRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardrailresetintervalresponse.mdx b/client-sdks/python/operations/updateguardrailresetintervalresponse.mdx deleted file mode 100644 index daaabb45..00000000 --- a/client-sdks/python/operations/updateguardrailresetintervalresponse.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: UpdateGuardrailResetIntervalResponse - Python SDK -description: UpdateGuardrailResetIntervalResponse method reference -seoTitle: UpdateGuardrailResetIntervalResponse | OpenRouter Python SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/python/operations/updateguardrailresetintervalresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResetIntervalResponse | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailResetIntervalResponse method documentation for the OpenRouter - Python SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResetIntervalResponse%20-%20Python%20SDK&description=UpdateGuardrailResetIntervalResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/updateguardrailresponse.mdx b/client-sdks/python/operations/updateguardrailresponse.mdx deleted file mode 100644 index 719ba6f2..00000000 --- a/client-sdks/python/operations/updateguardrailresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateGuardrailResponse - Python SDK -description: UpdateGuardrailResponse method reference -seoTitle: UpdateGuardrailResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updateguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResponse | OpenRouter Python SDK -'og:description': >- - UpdateGuardrailResponse method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResponse%20-%20Python%20SDK&description=UpdateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -Guardrail updated successfully - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateGuardrailData](/client-sdks/python/operations/updateguardraildata) | :heavy_check_mark: | The updated guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/updatekeysdata.mdx b/client-sdks/python/operations/updatekeysdata.mdx deleted file mode 100644 index 6a77d25d..00000000 --- a/client-sdks/python/operations/updatekeysdata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: UpdateKeysData - Python SDK -description: UpdateKeysData method reference -seoTitle: UpdateKeysData | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updatekeysdata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysData | OpenRouter Python SDK -'og:description': >- - UpdateKeysData method documentation for the OpenRouter Python SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysData%20-%20Python%20SDK&description=UpdateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The updated API key information - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *str* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *str* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *bool* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *Nullable[float]* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limit_remaining` | *Nullable[float]* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limit_reset` | *Nullable[str]* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `include_byok_in_limit` | *bool* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *float* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usage_daily` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usage_weekly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usage_monthly` | *float* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byok_usage` | *float* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byok_usage_daily` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byok_usage_weekly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byok_usage_monthly` | *float* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `created_at` | *str* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updated_at` | *Nullable[str]* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/python/operations/updatekeyslimitreset.mdx b/client-sdks/python/operations/updatekeyslimitreset.mdx deleted file mode 100644 index 5301da83..00000000 --- a/client-sdks/python/operations/updatekeyslimitreset.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateKeysLimitReset - Python SDK -description: UpdateKeysLimitReset method reference -seoTitle: UpdateKeysLimitReset | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updatekeyslimitreset' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysLimitReset | OpenRouter Python SDK -'og:description': >- - UpdateKeysLimitReset method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysLimitReset%20-%20Python%20SDK&description=UpdateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -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. - -## Values - -| Name | Value | -| --------- | --------- | -| `DAILY` | daily | -| `WEEKLY` | weekly | -| `MONTHLY` | monthly | \ No newline at end of file diff --git a/client-sdks/python/operations/updatekeysrequest.mdx b/client-sdks/python/operations/updatekeysrequest.mdx deleted file mode 100644 index 78001410..00000000 --- a/client-sdks/python/operations/updatekeysrequest.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: UpdateKeysRequest - Python SDK -description: UpdateKeysRequest method reference -seoTitle: UpdateKeysRequest | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updatekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequest | OpenRouter Python SDK -'og:description': >- - UpdateKeysRequest method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequest%20-%20Python%20SDK&description=UpdateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *str* | :heavy_check_mark: | The hash identifier of the API key to update | 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 | -| `request_body` | [operations.UpdateKeysRequestBody](/client-sdks/python/api-reference/operations/updatekeysrequestbody) | :heavy_check_mark: | N/A | `{"name": "Updated API Key Name","disabled": false,"limit": 75,"limit_reset": "daily","include_byok_in_limit": true}` | \ No newline at end of file diff --git a/client-sdks/python/operations/updatekeysrequestbody.mdx b/client-sdks/python/operations/updatekeysrequestbody.mdx deleted file mode 100644 index e971da05..00000000 --- a/client-sdks/python/operations/updatekeysrequestbody.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: UpdateKeysRequestBody - Python SDK -description: UpdateKeysRequestBody method reference -seoTitle: UpdateKeysRequestBody | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updatekeysrequestbody' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequestBody | OpenRouter Python SDK -'og:description': >- - UpdateKeysRequestBody method documentation for the OpenRouter Python SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequestBody%20-%20Python%20SDK&description=UpdateKeysRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *Optional[str]* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | -| `disabled` | *Optional[bool]* | :heavy_minus_sign: | Whether to disable the API key | false | -| `limit` | *OptionalNullable[float]* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limit_reset` | [OptionalNullable[operations.UpdateKeysLimitReset]](../operations/updatekeyslimitreset.md) | :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 | -| `include_byok_in_limit` | *Optional[bool]* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | \ No newline at end of file diff --git a/client-sdks/python/operations/updatekeysresponse.mdx b/client-sdks/python/operations/updatekeysresponse.mdx deleted file mode 100644 index 71188fd8..00000000 --- a/client-sdks/python/operations/updatekeysresponse.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: UpdateKeysResponse - Python SDK -description: UpdateKeysResponse method reference -seoTitle: UpdateKeysResponse | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/updatekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysResponse | OpenRouter Python SDK -'og:description': >- - UpdateKeysResponse method documentation for the OpenRouter Python SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysResponse%20-%20Python%20SDK&description=UpdateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -API key updated successfully - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateKeysData](/client-sdks/python/api-reference/operations/updatekeysdata) | :heavy_check_mark: | The updated API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | \ No newline at end of file diff --git a/client-sdks/python/operations/usage.mdx b/client-sdks/python/operations/usage.mdx deleted file mode 100644 index d98ace9b..00000000 --- a/client-sdks/python/operations/usage.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Usage - Python SDK -description: Usage method reference -seoTitle: Usage | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/usage' -'og:site_name': OpenRouter Documentation -'og:title': Usage | OpenRouter Python SDK -'og:description': >- - Usage method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Usage%20-%20Python%20SDK&description=Usage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `prompt_tokens` | *float* | :heavy_check_mark: | N/A | -| `total_tokens` | *float* | :heavy_check_mark: | N/A | -| `cost` | *Optional[float]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/python/operations/web3data.mdx b/client-sdks/python/operations/web3data.mdx deleted file mode 100644 index 45ecc9c3..00000000 --- a/client-sdks/python/operations/web3data.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Web3Data - Python SDK -description: Web3Data method reference -seoTitle: Web3Data | OpenRouter Python SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python/operations/web3data' -'og:site_name': OpenRouter Documentation -'og:title': Web3Data | OpenRouter Python SDK -'og:description': >- - Web3Data method documentation for the OpenRouter Python SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Web3Data%20-%20Python%20SDK&description=Web3Data%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `transfer_intent` | [operations.TransferIntent](/client-sdks/python/operations/transferintent) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/python/overview.mdx b/client-sdks/python/overview.mdx deleted file mode 100644 index 5c0ba5c4..00000000 --- a/client-sdks/python/overview.mdx +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: Python SDK -description: Official OpenRouter Python SDK documentation -seoTitle: OpenRouter Python SDK | Complete Documentation -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/python' -'og:site_name': OpenRouter Documentation -'og:title': OpenRouter Python SDK | Complete Documentation -'og:description': >- - Complete guide to using the OpenRouter Python SDK. Learn how to integrate AI - models into your Python applications. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Python%20SDK&description=Official%20OpenRouter%20Python%20SDK%20documentation -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: book -sidebarTitle: Overview ---- - -{/* banner:start */} - -The Python SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/python-sdk/issues). - -{/* banner:end */} - -The OpenRouter Python SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API. - -## Why use the OpenRouter SDK? - -Integrating AI models into applications involves handling different provider APIs, managing model-specific requirements, and avoiding common implementation mistakes. The OpenRouter SDK standardizes these integrations and protects you from footguns. - -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - api_key=os.getenv("OPENROUTER_API_KEY") -) as client: - response = client.chat.send( - model="minimax/minimax-m2", - messages=[ - {"role": "user", "content": "Explain quantum computing"} - ] - ) -``` - -The SDK provides three core benefits: - -### Auto-generated from API specifications - -The SDK is automatically generated from OpenRouter's OpenAPI specs and updated with every API change. New models, parameters, and features appear in your IDE autocomplete immediately. No manual updates. No version drift. - -```python lines -# When new models launch, they're available instantly -response = client.chat.send( - model="minimax/minimax-m2" -) -``` - -### Type-safe by default - -Every parameter, response field, and configuration option is fully typed with Python type hints and validated with Pydantic. Invalid configurations are caught at runtime with clear error messages. - -```python lines -response = client.chat.send( - model="minimax/minimax-m2", - messages=[ - {"role": "user", "content": "Hello"} - # ← Pydantic validates message structure - ], - temperature=0.7, # ← Type-checked and validated - stream=True # ← Response type changes based on this -) -``` - -**Actionable error messages:** - -```python lines -# Instead of generic errors, get specific guidance: -# "Model 'openai/o1-preview' requires at least 2 messages. -# You provided 1 message. Add a system or user message." -``` - -**Type-safe streaming:** - -```python lines -stream = client.chat.send( - model="minimax/minimax-m2", - messages=[{"role": "user", "content": "Write a story"}], - stream=True -) - -for event in stream: - # Full type information for streaming responses - content = event.choices[0].delta.content if event.choices else None -``` - -**Async support:** - -```python lines -import asyncio - -async def main(): - async with OpenRouter( - api_key=os.getenv("OPENROUTER_API_KEY") - ) as client: - response = await client.chat.send_async( - model="minimax/minimax-m2", - messages=[{"role": "user", "content": "Hello"}] - ) - print(response.choices[0].message.content) - -asyncio.run(main()) -``` - -## Installation - -```bash lines -# Using uv (recommended) -uv add openrouter - -# Using pip -pip install openrouter - -# Using poetry -poetry add openrouter -``` - -**Requirements:** Python 3.9 or higher - -Get your API key from [openrouter.ai/settings/keys](https://openrouter.ai/settings/keys). - -## Quick start - -```python lines -from openrouter import OpenRouter -import os - -with OpenRouter( - api_key=os.getenv("OPENROUTER_API_KEY") -) as client: - response = client.chat.send( - model="minimax/minimax-m2", - messages=[ - {"role": "user", "content": "Hello!"} - ] - ) - - print(response.choices[0].message.content) -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/analytics.mdx b/client-sdks/typescript/api-reference/analytics.mdx deleted file mode 100644 index 72cbc46f..00000000 --- a/client-sdks/typescript/api-reference/analytics.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Analytics - TypeScript SDK -description: Analytics method reference -seoTitle: Analytics | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/analytics' -'og:site_name': OpenRouter Documentation -'og:title': Analytics | OpenRouter TypeScript SDK -'og:description': >- - Analytics method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analytics%20-%20TypeScript%20SDK&description=Analytics%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: chart-simple -sidebarTitle: Analytics ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Analytics and usage endpoints - -### Available Operations - -* [getUserActivity](#getuseractivity) - Get user activity grouped by endpoint - -## getUserActivity - -Returns user activity data grouped by endpoint for the last 30 (completed) UTC days. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getUserActivity" method="get" path="/activity" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.analytics.getUserActivity(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { analyticsGetUserActivity } from "@openrouter/sdk/funcs/analyticsGetUserActivity.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await analyticsGetUserActivity(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("analyticsGetUserActivity failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetUserActivityRequest](/client-sdks/typescript/api-reference/operations/getuseractivityrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.ActivityResponse](/client-sdks/typescript/api-reference/models/activityresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/apikeys.mdx b/client-sdks/typescript/api-reference/apikeys.mdx deleted file mode 100644 index 62b8b034..00000000 --- a/client-sdks/typescript/api-reference/apikeys.mdx +++ /dev/null @@ -1,556 +0,0 @@ ---- -title: APIKeys - TypeScript SDK -description: APIKeys method reference -seoTitle: APIKeys | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/apikeys' -'og:site_name': OpenRouter Documentation -'og:title': APIKeys | OpenRouter TypeScript SDK -'og:description': >- - APIKeys method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=APIKeys%20-%20TypeScript%20SDK&description=APIKeys%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: key -sidebarTitle: APIKeys ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -API key management endpoints - -### Available Operations - -* [getCurrentKeyMetadata](#getcurrentkeymetadata) - Get current API key -* [list](#list) - List API keys -* [create](#create) - Create a new API key -* [delete](#delete) - Delete an API key -* [get](#get) - Get a single API key -* [update](#update) - Update an API key - -## getCurrentKeyMetadata - -Get information on the API key associated with the current authentication session - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getCurrentKey" method="get" path="/key" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.getCurrentKeyMetadata(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysGetCurrentKeyMetadata } from "@openrouter/sdk/funcs/apiKeysGetCurrentKeyMetadata.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysGetCurrentKeyMetadata(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysGetCurrentKeyMetadata failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCurrentKeyRequest](/client-sdks/typescript/api-reference/operations/getcurrentkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.GetCurrentKeyResponse](/client-sdks/typescript/api-reference/operations/getcurrentkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list - -List all API keys for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="list" method="get" path="/keys" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.list(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysList } from "@openrouter/sdk/funcs/apiKeysList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysList(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListRequest](/client-sdks/typescript/api-reference/operations/listrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListResponse](/client-sdks/typescript/api-reference/operations/listresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new API key for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createKeys" method="post" path="/keys" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.create({ - requestBody: { - expiresAt: new Date("2027-12-31T23:59:59Z"), - includeByokInLimit: true, - limit: 50, - limitReset: "monthly", - name: "My New API Key", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysCreate } from "@openrouter/sdk/funcs/apiKeysCreate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysCreate(openRouter, { - requestBody: { - expiresAt: new Date("2027-12-31T23:59:59Z"), - includeByokInLimit: true, - limit: 50, - limitReset: "monthly", - name: "My New API Key", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateKeysRequest](/client-sdks/typescript/api-reference/operations/createkeysrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.CreateKeysResponse](/client-sdks/typescript/api-reference/operations/createkeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="deleteKeys" method="delete" path="/keys/{hash}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.delete({ - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysDelete } from "@openrouter/sdk/funcs/apiKeysDelete.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysDelete(openRouter, { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteKeysRequest](/client-sdks/typescript/api-reference/operations/deletekeysrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.DeleteKeysResponse](/client-sdks/typescript/api-reference/operations/deletekeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single API key by hash. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getKey" method="get" path="/keys/{hash}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.get({ - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysGet } from "@openrouter/sdk/funcs/apiKeysGet.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysGet(openRouter, { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetKeyRequest](/client-sdks/typescript/api-reference/operations/getkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.GetKeyResponse](/client-sdks/typescript/api-reference/operations/getkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing API key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="updateKeys" method="patch" path="/keys/{hash}" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.apiKeys.update({ - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - requestBody: { - disabled: false, - includeByokInLimit: true, - limit: 75, - limitReset: "daily", - name: "Updated API Key Name", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { apiKeysUpdate } from "@openrouter/sdk/funcs/apiKeysUpdate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await apiKeysUpdate(openRouter, { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - requestBody: { - disabled: false, - includeByokInLimit: true, - limit: 75, - limitReset: "daily", - name: "Updated API Key Name", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("apiKeysUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateKeysRequest](/client-sdks/typescript/api-reference/operations/updatekeysrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.UpdateKeysResponse](/client-sdks/typescript/api-reference/operations/updatekeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/byok.mdx b/client-sdks/typescript/api-reference/byok.mdx deleted file mode 100644 index 8b81e9dd..00000000 --- a/client-sdks/typescript/api-reference/byok.mdx +++ /dev/null @@ -1,467 +0,0 @@ ---- -title: Byok - TypeScript SDK -sidebarTitle: Byok -description: Byok method reference -seoTitle: Byok | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/byok' -'og:site_name': OpenRouter Documentation -'og:title': Byok | OpenRouter TypeScript SDK -'og:description': >- - Byok method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Byok%20-%20TypeScript%20SDK&description=Byok%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -BYOK endpoints - -### Available Operations - -* [list](#list) - List BYOK provider credentials -* [create](#create) - Create a BYOK provider credential -* [delete](#delete) - Delete a BYOK provider credential -* [get](#get) - Get a BYOK provider credential -* [update](#update) - Update a BYOK provider credential - -## list - -List the bring-your-own-key (BYOK) provider credentials for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace, or the `provider` query parameter to filter by upstream provider. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listBYOKKeys" method="get" path="/byok" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.byok.list(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { byokList } from "@openrouter/sdk/funcs/byokList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await byokList(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("byokList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListBYOKKeysRequest](/client-sdks/typescript/api-reference/operations/listbyokkeysrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListBYOKKeysResponse](/client-sdks/typescript/api-reference/operations/listbyokkeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new bring-your-own-key (BYOK) provider credential. The raw key is encrypted at rest and never returned in API responses. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createBYOKKey" method="post" path="/byok" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.byok.create({ - createBYOKKeyRequest: { - key: "sk-proj-abc123...", - name: "Production OpenAI Key", - provider: "openai", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { byokCreate } from "@openrouter/sdk/funcs/byokCreate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await byokCreate(openRouter, { - createBYOKKeyRequest: { - key: "sk-proj-abc123...", - name: "Production OpenAI Key", - provider: "openai", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("byokCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateBYOKKeyRequest](/client-sdks/typescript/api-reference/operations/createbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreateBYOKKeyResponse](/client-sdks/typescript/api-reference/models/createbyokkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete (soft-delete) a bring-your-own-key (BYOK) provider credential by its `id`. The encrypted key material is wiped and the record is marked as deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="deleteBYOKKey" method="delete" path="/byok/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.byok.delete({ - id: "11111111-2222-3333-4444-555555555555", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { byokDelete } from "@openrouter/sdk/funcs/byokDelete.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await byokDelete(openRouter, { - id: "11111111-2222-3333-4444-555555555555", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("byokDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteBYOKKeyRequest](/client-sdks/typescript/api-reference/operations/deletebyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.DeleteBYOKKeyResponse](/client-sdks/typescript/api-reference/models/deletebyokkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single bring-your-own-key (BYOK) provider credential by its `id`. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getBYOKKey" method="get" path="/byok/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.byok.get({ - id: "11111111-2222-3333-4444-555555555555", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { byokGet } from "@openrouter/sdk/funcs/byokGet.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await byokGet(openRouter, { - id: "11111111-2222-3333-4444-555555555555", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("byokGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBYOKKeyRequest](/client-sdks/typescript/api-reference/operations/getbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GetBYOKKeyResponse](/client-sdks/typescript/api-reference/models/getbyokkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing bring-your-own-key (BYOK) provider credential by its `id`. Include the `key` field to rotate the raw provider API key in-place (the previous key material is overwritten). [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="updateBYOKKey" method="patch" path="/byok/{id}" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.byok.update({ - id: "11111111-2222-3333-4444-555555555555", - updateBYOKKeyRequest: { - disabled: false, - name: "Updated OpenAI Key", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { byokUpdate } from "@openrouter/sdk/funcs/byokUpdate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await byokUpdate(openRouter, { - id: "11111111-2222-3333-4444-555555555555", - updateBYOKKeyRequest: { - disabled: false, - name: "Updated OpenAI Key", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("byokUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateBYOKKeyRequest](/client-sdks/typescript/api-reference/operations/updatebyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.UpdateBYOKKeyResponse](/client-sdks/typescript/api-reference/models/updatebyokkeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/chat.mdx b/client-sdks/typescript/api-reference/chat.mdx deleted file mode 100644 index 35a1ee77..00000000 --- a/client-sdks/typescript/api-reference/chat.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: Chat - TypeScript SDK -sidebarTitle: Chat -description: Chat method reference -seoTitle: Chat | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/chat' -'og:site_name': OpenRouter Documentation -'og:title': Chat | OpenRouter TypeScript SDK -'og:description': >- - Chat method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Chat%20-%20TypeScript%20SDK&description=Chat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: comments ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -### Available Operations - -* [send](#send) - Create a chat completion - -## send - -Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes. - -### Example Usage: guardrail-blocked - -{/* UsageSnippet language="typescript" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" example="guardrail-blocked" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.chat.send({ - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { chatSend } from "@openrouter/sdk/funcs/chatSend.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await chatSend(openRouter, { - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("chatSend failed:", res.error); - } -} - -run(); -``` -### Example Usage: insufficient-permissions - -{/* UsageSnippet language="typescript" operationID="sendChatCompletionRequest" method="post" path="/chat/completions" example="insufficient-permissions" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.chat.send({ - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { chatSend } from "@openrouter/sdk/funcs/chatSend.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await chatSend(openRouter, { - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("chatSend failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SendChatCompletionRequestRequest](/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.SendChatCompletionRequestResponse](/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.RequestTimeoutResponseError | 408 | application/json | -| errors.PayloadTooLargeResponseError | 413 | application/json | -| errors.UnprocessableEntityResponseError | 422 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/credits.mdx b/client-sdks/typescript/api-reference/credits.mdx deleted file mode 100644 index a6c82e16..00000000 --- a/client-sdks/typescript/api-reference/credits.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: Credits - TypeScript SDK -description: Credits method reference -seoTitle: Credits | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/credits' -'og:site_name': OpenRouter Documentation -'og:title': Credits | OpenRouter TypeScript SDK -'og:description': >- - Credits method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Credits%20-%20TypeScript%20SDK&description=Credits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: coins -sidebarTitle: Credits ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Credit management endpoints - -### Available Operations - -* [getCredits](#getcredits) - Get remaining credits - -## getCredits - -Get total credits purchased and used for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getCredits" method="get" path="/credits" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.credits.getCredits(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { creditsGetCredits } from "@openrouter/sdk/funcs/creditsGetCredits.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await creditsGetCredits(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("creditsGetCredits failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCreditsRequest](/client-sdks/typescript/api-reference/operations/getcreditsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.GetCreditsResponse](/client-sdks/typescript/api-reference/operations/getcreditsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/datasets.mdx b/client-sdks/typescript/api-reference/datasets.mdx deleted file mode 100644 index 83f2ceee..00000000 --- a/client-sdks/typescript/api-reference/datasets.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: Datasets - TypeScript SDK -sidebarTitle: Datasets -description: Datasets method reference -seoTitle: Datasets | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/datasets' -'og:site_name': OpenRouter Documentation -'og:title': Datasets | OpenRouter TypeScript SDK -'og:description': >- - Datasets method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datasets%20-%20TypeScript%20SDK&description=Datasets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Datasets endpoints - -### Available Operations - -* [getRankingsDaily](#getrankingsdaily) - Daily token totals for top 50 models - -## getRankingsDaily - -Returns the top 50 public models per day by total token usage on OpenRouter, plus a -single aggregated `other` row per day that sums every model outside that top 50. -Token totals are `prompt_tokens + completion_tokens`, matching the public rankings -chart on openrouter.ai/rankings. - -Each row is a distinct `(date, model_permaslug)` pair. The `other` row uses the -reserved permaslug `other` and is always returned last within its date, so callers -can compute `top-50 traffic / total daily traffic` without a second request. - -Authenticate with any valid OpenRouter API key (same key used for inference). -Rate-limited to 30 requests/minute per key and 500 requests/day per account. - -When republishing or quoting this dataset, OpenRouter must be cited as: -"Source: OpenRouter (openrouter.ai/rankings), as of \{as_of\}." - -Token counts come from each upstream provider's own tokenizer (Anthropic counts -are as reported by Anthropic, OpenAI counts are as reported by OpenAI, etc.), so -a token in one row is not directly comparable to a token in another row from a -different provider. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getRankingsDaily" method="get" path="/datasets/rankings-daily" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.datasets.getRankingsDaily(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { datasetsGetRankingsDaily } from "@openrouter/sdk/funcs/datasetsGetRankingsDaily.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await datasetsGetRankingsDaily(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("datasetsGetRankingsDaily failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetRankingsDailyRequest](/client-sdks/typescript/api-reference/operations/getrankingsdailyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.RankingsDailyResponse](/client-sdks/typescript/api-reference/models/rankingsdailyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/embeddings.mdx b/client-sdks/typescript/api-reference/embeddings.mdx deleted file mode 100644 index 6c0a336f..00000000 --- a/client-sdks/typescript/api-reference/embeddings.mdx +++ /dev/null @@ -1,209 +0,0 @@ ---- -title: Embeddings - TypeScript SDK -sidebarTitle: Embeddings -description: Embeddings method reference -seoTitle: Embeddings | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/embeddings' -'og:site_name': OpenRouter Documentation -'og:title': Embeddings | OpenRouter TypeScript SDK -'og:description': >- - Embeddings method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embeddings%20-%20TypeScript%20SDK&description=Embeddings%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Text embedding endpoints - -### Available Operations - -* [generate](#generate) - Submit an embedding request -* [listModels](#listmodels) - List all embeddings models - -## generate - -Submits an embedding request to the embeddings router - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createEmbeddings" method="post" path="/embeddings" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.embeddings.generate({ - requestBody: { - input: "The quick brown fox jumps over the lazy dog", - model: "openai/text-embedding-3-small", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { embeddingsGenerate } from "@openrouter/sdk/funcs/embeddingsGenerate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await embeddingsGenerate(openRouter, { - requestBody: { - input: "The quick brown fox jumps over the lazy dog", - model: "openai/text-embedding-3-small", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("embeddingsGenerate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateEmbeddingsRequest](/client-sdks/typescript/api-reference/operations/createembeddingsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.CreateEmbeddingsResponse](/client-sdks/typescript/api-reference/operations/createembeddingsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listModels - -Returns a list of all available embeddings models and their properties - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listEmbeddingsModels" method="get" path="/embeddings/models" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.embeddings.listModels(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { embeddingsListModels } from "@openrouter/sdk/funcs/embeddingsListModels.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await embeddingsListModels(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("embeddingsListModels failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEmbeddingsModelsRequest](/client-sdks/typescript/api-reference/operations/listembeddingsmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.ModelsListResponse](/client-sdks/typescript/api-reference/models/modelslistresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/endpoints.mdx b/client-sdks/typescript/api-reference/endpoints.mdx deleted file mode 100644 index 8f5ccfbb..00000000 --- a/client-sdks/typescript/api-reference/endpoints.mdx +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Endpoints - TypeScript SDK -sidebarTitle: Endpoints -description: Endpoints method reference -seoTitle: Endpoints | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/endpoints' -'og:site_name': OpenRouter Documentation -'og:title': Endpoints | OpenRouter TypeScript SDK -'og:description': >- - Endpoints method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Endpoints%20-%20TypeScript%20SDK&description=Endpoints%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: network-wired ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Endpoint information - -### Available Operations - -* [listZdrEndpoints](#listzdrendpoints) - Preview the impact of ZDR on the available endpoints -* [list](#list) - List all endpoints for a model - -## listZdrEndpoints - -Preview the impact of ZDR on the available endpoints - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listEndpointsZdr" method="get" path="/endpoints/zdr" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.endpoints.listZdrEndpoints(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { endpointsListZdrEndpoints } from "@openrouter/sdk/funcs/endpointsListZdrEndpoints.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await endpointsListZdrEndpoints(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("endpointsListZdrEndpoints failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsZdrRequest](/client-sdks/typescript/api-reference/operations/listendpointszdrrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListEndpointsZdrResponse](/client-sdks/typescript/api-reference/operations/listendpointszdrresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## list - -List all endpoints for a model - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listEndpoints" method="get" path="/models/{author}/{slug}/endpoints" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.endpoints.list({ - author: "", - slug: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { endpointsList } from "@openrouter/sdk/funcs/endpointsList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await endpointsList(openRouter, { - author: "", - slug: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("endpointsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsRequest](/client-sdks/typescript/api-reference/operations/listendpointsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListEndpointsResponse](/client-sdks/typescript/api-reference/operations/listendpointsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/badgatewayresponseerror.mdx b/client-sdks/typescript/api-reference/errors/badgatewayresponseerror.mdx deleted file mode 100644 index 73ec909c..00000000 --- a/client-sdks/typescript/api-reference/errors/badgatewayresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BadGatewayResponseError - TypeScript SDK -sidebarTitle: BadGatewayResponseError -description: BadGatewayResponseError type definition -seoTitle: BadGatewayResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/badgatewayresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - BadGatewayResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseError%20-%20TypeScript%20SDK&description=BadGatewayResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Bad Gateway - Provider/upstream API failure - -## Example Usage - -```typescript lines -import { BadGatewayResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadGatewayResponseErrorData](/client-sdks/typescript/api-reference/models/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | `{"code": 502,"message": "Provider returned error"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/badrequestresponseerror.mdx b/client-sdks/typescript/api-reference/errors/badrequestresponseerror.mdx deleted file mode 100644 index ac6cdebb..00000000 --- a/client-sdks/typescript/api-reference/errors/badrequestresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BadRequestResponseError - TypeScript SDK -sidebarTitle: BadRequestResponseError -description: BadRequestResponseError type definition -seoTitle: BadRequestResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/badrequestresponseerror -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - BadRequestResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseError%20-%20TypeScript%20SDK&description=BadRequestResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Bad Request - Invalid request parameters or malformed input - -## Example Usage - -```typescript lines -import { BadRequestResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadRequestResponseErrorData](/client-sdks/typescript/api-reference/models/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | `{"code": 400,"message": "Invalid request parameters"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/conflictresponseerror.mdx b/client-sdks/typescript/api-reference/errors/conflictresponseerror.mdx deleted file mode 100644 index 6f1a0eb8..00000000 --- a/client-sdks/typescript/api-reference/errors/conflictresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ConflictResponseError - TypeScript SDK -sidebarTitle: ConflictResponseError -description: ConflictResponseError type definition -seoTitle: ConflictResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/conflictresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - ConflictResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseError%20-%20TypeScript%20SDK&description=ConflictResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Conflict - Resource conflict or concurrent modification - -## Example Usage - -```typescript lines -import { ConflictResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.ConflictResponseErrorData](/client-sdks/typescript/api-reference/models/conflictresponseerrordata) | :heavy_check_mark: | Error data for ConflictResponse | `{"code": 409,"message": "Resource conflict. Please try again later."}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/edgenetworktimeoutresponseerror.mdx b/client-sdks/typescript/api-reference/errors/edgenetworktimeoutresponseerror.mdx deleted file mode 100644 index 9ebac7ac..00000000 --- a/client-sdks/typescript/api-reference/errors/edgenetworktimeoutresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseError - TypeScript SDK -sidebarTitle: EdgeNetworkTimeoutResponseError -description: EdgeNetworkTimeoutResponseError type definition -seoTitle: EdgeNetworkTimeoutResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/edgenetworktimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - EdgeNetworkTimeoutResponseError type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseError%20-%20TypeScript%20SDK&description=EdgeNetworkTimeoutResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Infrastructure Timeout - Provider request timed out at edge network - -## Example Usage - -```typescript lines -import { EdgeNetworkTimeoutResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.EdgeNetworkTimeoutResponseErrorData](/client-sdks/typescript/api-reference/models/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | `{"code": 524,"message": "Request timed out. Please try again later."}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/forbiddenresponseerror.mdx b/client-sdks/typescript/api-reference/errors/forbiddenresponseerror.mdx deleted file mode 100644 index 79519fa9..00000000 --- a/client-sdks/typescript/api-reference/errors/forbiddenresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ForbiddenResponseError - TypeScript SDK -sidebarTitle: ForbiddenResponseError -description: ForbiddenResponseError type definition -seoTitle: ForbiddenResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/forbiddenresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - ForbiddenResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseError%20-%20TypeScript%20SDK&description=ForbiddenResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Forbidden - Authentication successful but insufficient permissions - -## Example Usage - -```typescript lines -import { ForbiddenResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `error` | [models.ForbiddenResponseErrorData](/client-sdks/typescript/api-reference/models/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | `{"code": 403,"message": "Only management keys can perform this operation"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/internalserverresponseerror.mdx b/client-sdks/typescript/api-reference/errors/internalserverresponseerror.mdx deleted file mode 100644 index d3c56186..00000000 --- a/client-sdks/typescript/api-reference/errors/internalserverresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: InternalServerResponseError - TypeScript SDK -sidebarTitle: InternalServerResponseError -description: InternalServerResponseError type definition -seoTitle: InternalServerResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/internalserverresponseerror -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - InternalServerResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseError%20-%20TypeScript%20SDK&description=InternalServerResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Internal Server Error - Unexpected server error - -## Example Usage - -```typescript lines -import { InternalServerResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.InternalServerResponseErrorData](/client-sdks/typescript/api-reference/models/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | `{"code": 500,"message": "Internal Server Error"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/notfoundresponseerror.mdx b/client-sdks/typescript/api-reference/errors/notfoundresponseerror.mdx deleted file mode 100644 index 5dc224fe..00000000 --- a/client-sdks/typescript/api-reference/errors/notfoundresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: NotFoundResponseError - TypeScript SDK -sidebarTitle: NotFoundResponseError -description: NotFoundResponseError type definition -seoTitle: NotFoundResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/notfoundresponseerror -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - NotFoundResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseError%20-%20TypeScript%20SDK&description=NotFoundResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Not Found - Resource does not exist - -## Example Usage - -```typescript lines -import { NotFoundResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.NotFoundResponseErrorData](/client-sdks/typescript/api-reference/models/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | `{"code": 404,"message": "Resource not found"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/payloadtoolargeresponseerror.mdx b/client-sdks/typescript/api-reference/errors/payloadtoolargeresponseerror.mdx deleted file mode 100644 index 0f77e83b..00000000 --- a/client-sdks/typescript/api-reference/errors/payloadtoolargeresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PayloadTooLargeResponseError - TypeScript SDK -sidebarTitle: PayloadTooLargeResponseError -description: PayloadTooLargeResponseError type definition -seoTitle: PayloadTooLargeResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/payloadtoolargeresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - PayloadTooLargeResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseError%20-%20TypeScript%20SDK&description=PayloadTooLargeResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Payload Too Large - Request payload exceeds size limits - -## Example Usage - -```typescript lines -import { PayloadTooLargeResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.PayloadTooLargeResponseErrorData](/client-sdks/typescript/api-reference/models/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | `{"code": 413,"message": "Request payload too large"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/paymentrequiredresponseerror.mdx b/client-sdks/typescript/api-reference/errors/paymentrequiredresponseerror.mdx deleted file mode 100644 index 30c4b44e..00000000 --- a/client-sdks/typescript/api-reference/errors/paymentrequiredresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PaymentRequiredResponseError - TypeScript SDK -sidebarTitle: PaymentRequiredResponseError -description: PaymentRequiredResponseError type definition -seoTitle: PaymentRequiredResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/paymentrequiredresponseerror -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - PaymentRequiredResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseError%20-%20TypeScript%20SDK&description=PaymentRequiredResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Payment Required - Insufficient credits or quota to complete request - -## Example Usage - -```typescript lines -import { PaymentRequiredResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [models.PaymentRequiredResponseErrorData](/client-sdks/typescript/api-reference/models/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | `{"code": 402,"message": "Insufficient credits. Add more using https://openrouter.ai/credits"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/provideroverloadedresponseerror.mdx b/client-sdks/typescript/api-reference/errors/provideroverloadedresponseerror.mdx deleted file mode 100644 index 1babd2ae..00000000 --- a/client-sdks/typescript/api-reference/errors/provideroverloadedresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ProviderOverloadedResponseError - TypeScript SDK -sidebarTitle: ProviderOverloadedResponseError -description: ProviderOverloadedResponseError type definition -seoTitle: ProviderOverloadedResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/provideroverloadedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderOverloadedResponseError type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseError%20-%20TypeScript%20SDK&description=ProviderOverloadedResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider Overloaded - Provider is temporarily overloaded - -## Example Usage - -```typescript lines -import { ProviderOverloadedResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ProviderOverloadedResponseErrorData](/client-sdks/typescript/api-reference/models/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | `{"code": 529,"message": "Provider returned error"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/requesttimeoutresponseerror.mdx b/client-sdks/typescript/api-reference/errors/requesttimeoutresponseerror.mdx deleted file mode 100644 index d6877331..00000000 --- a/client-sdks/typescript/api-reference/errors/requesttimeoutresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: RequestTimeoutResponseError - TypeScript SDK -sidebarTitle: RequestTimeoutResponseError -description: RequestTimeoutResponseError type definition -seoTitle: RequestTimeoutResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/requesttimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - RequestTimeoutResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseError%20-%20TypeScript%20SDK&description=RequestTimeoutResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request Timeout - Operation exceeded time limit - -## Example Usage - -```typescript lines -import { RequestTimeoutResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.RequestTimeoutResponseErrorData](/client-sdks/typescript/api-reference/models/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | `{"code": 408,"message": "Operation timed out. Please try again later."}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/serviceunavailableresponseerror.mdx b/client-sdks/typescript/api-reference/errors/serviceunavailableresponseerror.mdx deleted file mode 100644 index c955f0db..00000000 --- a/client-sdks/typescript/api-reference/errors/serviceunavailableresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ServiceUnavailableResponseError - TypeScript SDK -sidebarTitle: ServiceUnavailableResponseError -description: ServiceUnavailableResponseError type definition -seoTitle: ServiceUnavailableResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/serviceunavailableresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - ServiceUnavailableResponseError type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseError%20-%20TypeScript%20SDK&description=ServiceUnavailableResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Service Unavailable - Service temporarily unavailable - -## Example Usage - -```typescript lines -import { ServiceUnavailableResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ServiceUnavailableResponseErrorData](/client-sdks/typescript/api-reference/models/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | `{"code": 503,"message": "Service temporarily unavailable"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/toomanyrequestsresponseerror.mdx b/client-sdks/typescript/api-reference/errors/toomanyrequestsresponseerror.mdx deleted file mode 100644 index 26fb06f6..00000000 --- a/client-sdks/typescript/api-reference/errors/toomanyrequestsresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: TooManyRequestsResponseError - TypeScript SDK -sidebarTitle: TooManyRequestsResponseError -description: TooManyRequestsResponseError type definition -seoTitle: TooManyRequestsResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/toomanyrequestsresponseerror -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - TooManyRequestsResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseError%20-%20TypeScript%20SDK&description=TooManyRequestsResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Too Many Requests - Rate limit exceeded - -## Example Usage - -```typescript lines -import { TooManyRequestsResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.TooManyRequestsResponseErrorData](/client-sdks/typescript/api-reference/models/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | `{"code": 429,"message": "Rate limit exceeded"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/unauthorizedresponseerror.mdx b/client-sdks/typescript/api-reference/errors/unauthorizedresponseerror.mdx deleted file mode 100644 index 30d3dd63..00000000 --- a/client-sdks/typescript/api-reference/errors/unauthorizedresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: UnauthorizedResponseError - TypeScript SDK -sidebarTitle: UnauthorizedResponseError -description: UnauthorizedResponseError type definition -seoTitle: UnauthorizedResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/unauthorizedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - UnauthorizedResponseError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseError%20-%20TypeScript%20SDK&description=UnauthorizedResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unauthorized - Authentication required or invalid credentials - -## Example Usage - -```typescript lines -import { UnauthorizedResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `error` | [models.UnauthorizedResponseErrorData](/client-sdks/typescript/api-reference/models/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | `{"code": 401,"message": "Missing Authentication header"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/errors/unprocessableentityresponseerror.mdx b/client-sdks/typescript/api-reference/errors/unprocessableentityresponseerror.mdx deleted file mode 100644 index a434b705..00000000 --- a/client-sdks/typescript/api-reference/errors/unprocessableentityresponseerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: UnprocessableEntityResponseError - TypeScript SDK -sidebarTitle: UnprocessableEntityResponseError -description: UnprocessableEntityResponseError type definition -seoTitle: UnprocessableEntityResponseError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/errors/unprocessableentityresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseError Type | OpenRouter TypeScript SDK -'og:description': >- - UnprocessableEntityResponseError type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseError%20-%20TypeScript%20SDK&description=UnprocessableEntityResponseError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unprocessable Entity - Semantic validation failure - -## Example Usage - -```typescript lines -import { UnprocessableEntityResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `error` | [models.UnprocessableEntityResponseErrorData](/client-sdks/typescript/api-reference/models/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | `{"code": 422,"message": "Invalid argument"}` | -| `openrouterMetadata` | `Record` | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/generations.mdx b/client-sdks/typescript/api-reference/generations.mdx deleted file mode 100644 index 9be92933..00000000 --- a/client-sdks/typescript/api-reference/generations.mdx +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: Generations - TypeScript SDK -sidebarTitle: Generations -description: Generations method reference -seoTitle: Generations | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/generations' -'og:site_name': OpenRouter Documentation -'og:title': Generations | OpenRouter TypeScript SDK -'og:description': >- - Generations method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Generations%20-%20TypeScript%20SDK&description=Generations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: diagram-project ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Generation history endpoints - -### Available Operations - -* [getGeneration](#getgeneration) - Get request & usage metadata for a generation -* [listGenerationContent](#listgenerationcontent) - Get stored prompt and completion content for a generation - -## getGeneration - -Get request & usage metadata for a generation - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getGeneration" method="get" path="/generation" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.generations.getGeneration({ - id: "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { generationsGetGeneration } from "@openrouter/sdk/funcs/generationsGetGeneration.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await generationsGetGeneration(openRouter, { - id: "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("generationsGetGeneration failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGenerationRequest](/client-sdks/typescript/api-reference/operations/getgenerationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GenerationResponse](/client-sdks/typescript/api-reference/models/generationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listGenerationContent - -Get stored prompt and completion content for a generation - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listGenerationContent" method="get" path="/generation/content" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.generations.listGenerationContent({ - id: "gen-1234567890", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { generationsListGenerationContent } from "@openrouter/sdk/funcs/generationsListGenerationContent.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await generationsListGenerationContent(openRouter, { - id: "gen-1234567890", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("generationsListGenerationContent failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGenerationContentRequest](/client-sdks/typescript/api-reference/operations/listgenerationcontentrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GenerationContentResponse](/client-sdks/typescript/api-reference/models/generationcontentresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/guardrails.mdx b/client-sdks/typescript/api-reference/guardrails.mdx deleted file mode 100644 index 7f30ed75..00000000 --- a/client-sdks/typescript/api-reference/guardrails.mdx +++ /dev/null @@ -1,1215 +0,0 @@ ---- -title: Guardrails - TypeScript SDK -sidebarTitle: Guardrails -description: Guardrails method reference -seoTitle: Guardrails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/guardrails' -'og:site_name': OpenRouter Documentation -'og:title': Guardrails | OpenRouter TypeScript SDK -'og:description': >- - Guardrails method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrails%20-%20TypeScript%20SDK&description=Guardrails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Guardrails endpoints - -### Available Operations - -* [list](#list) - List guardrails -* [create](#create) - Create a guardrail -* [delete](#delete) - Delete a guardrail -* [get](#get) - Get a guardrail -* [update](#update) - Update a guardrail -* [listGuardrailKeyAssignments](#listguardrailkeyassignments) - List key assignments for a guardrail -* [bulkAssignKeys](#bulkassignkeys) - Bulk assign keys to a guardrail -* [bulkUnassignKeys](#bulkunassignkeys) - Bulk unassign keys from a guardrail -* [listGuardrailMemberAssignments](#listguardrailmemberassignments) - List member assignments for a guardrail -* [bulkAssignMembers](#bulkassignmembers) - Bulk assign members to a guardrail -* [bulkUnassignMembers](#bulkunassignmembers) - Bulk unassign members from a guardrail -* [listKeyAssignments](#listkeyassignments) - List all key assignments -* [listMemberAssignments](#listmemberassignments) - List all member assignments - -## list - -List all guardrails for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listGuardrails" method="get" path="/guardrails" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.list(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsList } from "@openrouter/sdk/funcs/guardrailsList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsList(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("guardrailsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailsRequest](/client-sdks/typescript/api-reference/operations/listguardrailsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListGuardrailsResponse](/client-sdks/typescript/api-reference/operations/listguardrailsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new guardrail for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createGuardrail" method="post" path="/guardrails" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.create({ - createGuardrailRequest: { - allowedModels: null, - allowedProviders: [ - "openai", - "anthropic", - "deepseek", - ], - description: "A guardrail for limiting API usage", - enforceZdrAnthropic: true, - enforceZdrGoogle: false, - enforceZdrOpenai: true, - enforceZdrOther: false, - ignoredModels: null, - ignoredProviders: null, - limitUsd: 50, - name: "My New Guardrail", - resetInterval: "monthly", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsCreate } from "@openrouter/sdk/funcs/guardrailsCreate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsCreate(openRouter, { - createGuardrailRequest: { - allowedModels: null, - allowedProviders: [ - "openai", - "anthropic", - "deepseek", - ], - description: "A guardrail for limiting API usage", - enforceZdrAnthropic: true, - enforceZdrGoogle: false, - enforceZdrOpenai: true, - enforceZdrOther: false, - ignoredModels: null, - ignoredProviders: null, - limitUsd: 50, - name: "My New Guardrail", - resetInterval: "monthly", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateGuardrailRequest](/client-sdks/typescript/api-reference/operations/createguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreateGuardrailResponse](/client-sdks/typescript/api-reference/models/createguardrailresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="deleteGuardrail" method="delete" path="/guardrails/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.delete({ - id: "550e8400-e29b-41d4-a716-446655440000", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsDelete } from "@openrouter/sdk/funcs/guardrailsDelete.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsDelete(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteGuardrailRequest](/client-sdks/typescript/api-reference/operations/deleteguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.DeleteGuardrailResponse](/client-sdks/typescript/api-reference/models/deleteguardrailresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single guardrail by ID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getGuardrail" method="get" path="/guardrails/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.get({ - id: "550e8400-e29b-41d4-a716-446655440000", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsGet } from "@openrouter/sdk/funcs/guardrailsGet.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsGet(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGuardrailRequest](/client-sdks/typescript/api-reference/operations/getguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GetGuardrailResponse](/client-sdks/typescript/api-reference/models/getguardrailresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="updateGuardrail" method="patch" path="/guardrails/{id}" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.update({ - id: "550e8400-e29b-41d4-a716-446655440000", - updateGuardrailRequest: { - description: "Updated description", - limitUsd: 75, - name: "Updated Guardrail Name", - resetInterval: "weekly", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsUpdate } from "@openrouter/sdk/funcs/guardrailsUpdate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsUpdate(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - updateGuardrailRequest: { - description: "Updated description", - limitUsd: 75, - name: "Updated Guardrail Name", - resetInterval: "weekly", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateGuardrailRequest](/client-sdks/typescript/api-reference/operations/updateguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.UpdateGuardrailResponse](/client-sdks/typescript/api-reference/models/updateguardrailresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listGuardrailKeyAssignments - -List all API key assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listGuardrailKeyAssignments" method="get" path="/guardrails/{id}/assignments/keys" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.listGuardrailKeyAssignments({ - id: "550e8400-e29b-41d4-a716-446655440000", - }); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsListGuardrailKeyAssignments } from "@openrouter/sdk/funcs/guardrailsListGuardrailKeyAssignments.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsListGuardrailKeyAssignments(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - }); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("guardrailsListGuardrailKeyAssignments failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailKeyAssignmentsRequest](/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListGuardrailKeyAssignmentsResponse](/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkAssignKeys - -Assign multiple API keys to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkAssignKeysToGuardrail" method="post" path="/guardrails/{id}/assignments/keys" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.bulkAssignKeys({ - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsBulkAssignKeys } from "@openrouter/sdk/funcs/guardrailsBulkAssignKeys.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsBulkAssignKeys(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsBulkAssignKeys failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignKeysToGuardrailRequest](/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkAssignKeysResponse](/client-sdks/typescript/api-reference/models/bulkassignkeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkUnassignKeys - -Unassign multiple API keys from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkUnassignKeysFromGuardrail" method="post" path="/guardrails/{id}/assignments/keys/remove" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.bulkUnassignKeys({ - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsBulkUnassignKeys } from "@openrouter/sdk/funcs/guardrailsBulkUnassignKeys.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsBulkUnassignKeys(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsBulkUnassignKeys failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignKeysFromGuardrailRequest](/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkUnassignKeysResponse](/client-sdks/typescript/api-reference/models/bulkunassignkeysresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listGuardrailMemberAssignments - -List all organization member assignments for a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listGuardrailMemberAssignments" method="get" path="/guardrails/{id}/assignments/members" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.listGuardrailMemberAssignments({ - id: "550e8400-e29b-41d4-a716-446655440000", - }); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsListGuardrailMemberAssignments } from "@openrouter/sdk/funcs/guardrailsListGuardrailMemberAssignments.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsListGuardrailMemberAssignments(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - }); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("guardrailsListGuardrailMemberAssignments failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailMemberAssignmentsRequest](/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListGuardrailMemberAssignmentsResponse](/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkAssignMembers - -Assign multiple organization members to a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkAssignMembersToGuardrail" method="post" path="/guardrails/{id}/assignments/members" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.bulkAssignMembers({ - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsBulkAssignMembers } from "@openrouter/sdk/funcs/guardrailsBulkAssignMembers.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsBulkAssignMembers(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsBulkAssignMembers failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignMembersToGuardrailRequest](/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkAssignMembersResponse](/client-sdks/typescript/api-reference/models/bulkassignmembersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkUnassignMembers - -Unassign multiple organization members from a specific guardrail. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkUnassignMembersFromGuardrail" method="post" path="/guardrails/{id}/assignments/members/remove" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.bulkUnassignMembers({ - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsBulkUnassignMembers } from "@openrouter/sdk/funcs/guardrailsBulkUnassignMembers.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsBulkUnassignMembers(openRouter, { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("guardrailsBulkUnassignMembers failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignMembersFromGuardrailRequest](/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkUnassignMembersResponse](/client-sdks/typescript/api-reference/models/bulkunassignmembersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listKeyAssignments - -List all API key guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listKeyAssignments" method="get" path="/guardrails/assignments/keys" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.listKeyAssignments(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsListKeyAssignments } from "@openrouter/sdk/funcs/guardrailsListKeyAssignments.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsListKeyAssignments(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("guardrailsListKeyAssignments failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListKeyAssignmentsRequest](/client-sdks/typescript/api-reference/operations/listkeyassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListKeyAssignmentsResponse](/client-sdks/typescript/api-reference/operations/listkeyassignmentsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listMemberAssignments - -List all organization member guardrail assignments for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listMemberAssignments" method="get" path="/guardrails/assignments/members" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.guardrails.listMemberAssignments(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { guardrailsListMemberAssignments } from "@openrouter/sdk/funcs/guardrailsListMemberAssignments.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await guardrailsListMemberAssignments(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("guardrailsListMemberAssignments failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListMemberAssignmentsRequest](/client-sdks/typescript/api-reference/operations/listmemberassignmentsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListMemberAssignmentsResponse](/client-sdks/typescript/api-reference/operations/listmemberassignmentsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/lib/retryconfig.mdx b/client-sdks/typescript/api-reference/lib/retryconfig.mdx deleted file mode 100644 index 7cca5e7b..00000000 --- a/client-sdks/typescript/api-reference/lib/retryconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: RetryConfig - TypeScript SDK -sidebarTitle: RetryConfig -description: RetryConfig method reference -seoTitle: RetryConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/lib/retryconfig' -'og:site_name': OpenRouter Documentation -'og:title': RetryConfig | OpenRouter TypeScript SDK -'og:description': >- - RetryConfig method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RetryConfig%20-%20TypeScript%20SDK&description=RetryConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- | -| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | | -| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | ------------ | ----------------------------------------- | -------- | -| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` | -| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` | -| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models.mdx b/client-sdks/typescript/api-reference/models.mdx deleted file mode 100644 index 9faf89b3..00000000 --- a/client-sdks/typescript/api-reference/models.mdx +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: Models - TypeScript SDK -sidebarTitle: Models -description: Models method reference -seoTitle: Models | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models' -'og:site_name': OpenRouter Documentation -'og:title': Models | OpenRouter TypeScript SDK -'og:description': >- - Models method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Models%20-%20TypeScript%20SDK&description=Models%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Model information endpoints - -### Available Operations - -* [list](#list) - List all models and their properties -* [count](#count) - Get total count of available models -* [listForUser](#listforuser) - List models filtered by user provider preferences, privacy settings, and guardrails - -## list - -List all models and their properties - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getModels" method="get" path="/models" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.models.list(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { modelsList } from "@openrouter/sdk/funcs/modelsList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsList(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetModelsRequest](/client-sdks/typescript/api-reference/operations/getmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.ModelsListResponse](/client-sdks/typescript/api-reference/models/modelslistresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## count - -Get total count of available models - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listModelsCount" method="get" path="/models/count" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.models.count(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { modelsCount } from "@openrouter/sdk/funcs/modelsCount.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await modelsCount(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsCount failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsCountRequest](/client-sdks/typescript/api-reference/operations/listmodelscountrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.ModelsCountResponse](/client-sdks/typescript/api-reference/models/modelscountresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listForUser - -List models filtered by user provider preferences, [privacy settings](https://openrouter.ai/docs/guides/privacy/provider-logging), and [guardrails](https://openrouter.ai/docs/guides/features/guardrails). If requesting through `eu.openrouter.ai/api/v1/...` the results will be filtered to models that satisfy [EU in-region routing](https://openrouter.ai/docs/guides/privacy/provider-logging#enterprise-eu-in-region-routing). - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listModelsUser" method="get" path="/models/user" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", -}); - -async function run() { - const result = await openRouter.models.listForUser({ - bearer: process.env["OPENROUTER_BEARER"] ?? "", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { modelsListForUser } from "@openrouter/sdk/funcs/modelsListForUser.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", -}); - -async function run() { - const res = await modelsListForUser(openRouter, { - bearer: process.env["OPENROUTER_BEARER"] ?? "", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("modelsListForUser failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsUserRequest](/client-sdks/typescript/api-reference/operations/listmodelsuserrequest) | :heavy_check_mark: | The request object to use for the request. | -| `security` | [operations.ListModelsUserSecurity](/client-sdks/typescript/api-reference/operations/listmodelsusersecurity) | :heavy_check_mark: | The security requirements to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.ModelsListResponse](/client-sdks/typescript/api-reference/models/modelslistresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/action.mdx b/client-sdks/typescript/api-reference/models/action.mdx deleted file mode 100644 index 2afc7759..00000000 --- a/client-sdks/typescript/api-reference/models/action.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Action - TypeScript SDK -sidebarTitle: Action -description: Action type definition -seoTitle: Action Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/action' -'og:site_name': OpenRouter Documentation -'og:title': Action Type | OpenRouter TypeScript SDK -'og:description': >- - Action type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Action%20-%20TypeScript%20SDK&description=Action%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputWebSearchCallItemActionSearch` - -```typescript lines -const value: models.OutputWebSearchCallItemActionSearch = { - query: "", - type: "search", -}; -``` - -### `models.ActionOpenPage` - -```typescript lines -const value: models.ActionOpenPage = { - type: "open_page", -}; -``` - -### `models.ActionFindInPage` - -```typescript lines -const value: models.ActionFindInPage = { - pattern: "", - type: "find_in_page", - url: "https://qualified-king.org", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/actionenum.mdx b/client-sdks/typescript/api-reference/models/actionenum.mdx deleted file mode 100644 index dd4416ad..00000000 --- a/client-sdks/typescript/api-reference/models/actionenum.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ActionEnum - TypeScript SDK -sidebarTitle: ActionEnum -description: ActionEnum type definition -seoTitle: ActionEnum Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/actionenum' -'og:site_name': OpenRouter Documentation -'og:title': ActionEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ActionEnum type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionEnum%20-%20TypeScript%20SDK&description=ActionEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActionEnum } from "@openrouter/sdk/models"; - -let value: ActionEnum = "read"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"read" | "write" | "delete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/actionfindinpage.mdx b/client-sdks/typescript/api-reference/models/actionfindinpage.mdx deleted file mode 100644 index 0f9ca58f..00000000 --- a/client-sdks/typescript/api-reference/models/actionfindinpage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ActionFindInPage - TypeScript SDK -sidebarTitle: ActionFindInPage -description: ActionFindInPage type definition -seoTitle: ActionFindInPage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/actionfindinpage -'og:site_name': OpenRouter Documentation -'og:title': ActionFindInPage Type | OpenRouter TypeScript SDK -'og:description': >- - ActionFindInPage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionFindInPage%20-%20TypeScript%20SDK&description=ActionFindInPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActionFindInPage } from "@openrouter/sdk/models"; - -let value: ActionFindInPage = { - pattern: "", - type: "find_in_page", - url: "https://qualified-king.org", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `pattern` | *string* | :heavy_check_mark: | N/A | -| `type` | *"find_in_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/actionopenpage.mdx b/client-sdks/typescript/api-reference/models/actionopenpage.mdx deleted file mode 100644 index 56778804..00000000 --- a/client-sdks/typescript/api-reference/models/actionopenpage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ActionOpenPage - TypeScript SDK -sidebarTitle: ActionOpenPage -description: ActionOpenPage type definition -seoTitle: ActionOpenPage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/actionopenpage' -'og:site_name': OpenRouter Documentation -'og:title': ActionOpenPage Type | OpenRouter TypeScript SDK -'og:description': >- - ActionOpenPage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActionOpenPage%20-%20TypeScript%20SDK&description=ActionOpenPage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActionOpenPage } from "@openrouter/sdk/models"; - -let value: ActionOpenPage = { - type: "open_page", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"open_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/activityitem.mdx b/client-sdks/typescript/api-reference/models/activityitem.mdx deleted file mode 100644 index 90eb0470..00000000 --- a/client-sdks/typescript/api-reference/models/activityitem.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: ActivityItem - TypeScript SDK -sidebarTitle: ActivityItem -description: ActivityItem type definition -seoTitle: ActivityItem Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/activityitem' -'og:site_name': OpenRouter Documentation -'og:title': ActivityItem Type | OpenRouter TypeScript SDK -'og:description': >- - ActivityItem type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityItem%20-%20TypeScript%20SDK&description=ActivityItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActivityItem } from "@openrouter/sdk/models"; - -let value: ActivityItem = { - byokUsageInference: 0.012, - completionTokens: 125, - date: "2025-08-24", - endpointId: "550e8400-e29b-41d4-a716-446655440000", - model: "openai/gpt-4.1", - modelPermaslug: "openai/gpt-4.1-2025-04-14", - promptTokens: 50, - providerName: "OpenAI", - reasoningTokens: 25, - requests: 5, - usage: 0.015, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `byokUsageInference` | *number* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `completionTokens` | *number* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `date` | *string* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `endpointId` | *string* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `model` | *string* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `promptTokens` | *number* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `reasoningTokens` | *number* | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `requests` | *number* | :heavy_check_mark: | Number of requests made | 5 | -| `usage` | *number* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/activityresponse.mdx b/client-sdks/typescript/api-reference/models/activityresponse.mdx deleted file mode 100644 index e80708f4..00000000 --- a/client-sdks/typescript/api-reference/models/activityresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ActivityResponse - TypeScript SDK -sidebarTitle: ActivityResponse -description: ActivityResponse type definition -seoTitle: ActivityResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/activityresponse -'og:site_name': OpenRouter Documentation -'og:title': ActivityResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ActivityResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityResponse%20-%20TypeScript%20SDK&description=ActivityResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActivityResponse } from "@openrouter/sdk/models"; - -let value: ActivityResponse = { - data: [ - { - byokUsageInference: 0.012, - completionTokens: 125, - date: "2025-08-24", - endpointId: "550e8400-e29b-41d4-a716-446655440000", - model: "openai/gpt-4.1", - modelPermaslug: "openai/gpt-4.1-2025-04-14", - promptTokens: 50, - providerName: "OpenAI", - reasoningTokens: 25, - requests: 5, - usage: 0.015, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | [models.ActivityItem](/client-sdks/typescript/api-reference/models/activityitem)[] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/allowedtools.mdx b/client-sdks/typescript/api-reference/models/allowedtools.mdx deleted file mode 100644 index 75fb4b59..00000000 --- a/client-sdks/typescript/api-reference/models/allowedtools.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AllowedTools - TypeScript SDK -sidebarTitle: AllowedTools -description: AllowedTools type definition -seoTitle: AllowedTools Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/allowedtools' -'og:site_name': OpenRouter Documentation -'og:title': AllowedTools Type | OpenRouter TypeScript SDK -'og:description': >- - AllowedTools type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedTools%20-%20TypeScript%20SDK&description=AllowedTools%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AllowedTools } from "@openrouter/sdk/models"; - -let value: AllowedTools = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `readOnly` | *boolean* | :heavy_minus_sign: | N/A | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/allowedtoolsunion.mdx b/client-sdks/typescript/api-reference/models/allowedtoolsunion.mdx deleted file mode 100644 index 696af079..00000000 --- a/client-sdks/typescript/api-reference/models/allowedtoolsunion.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: AllowedToolsUnion - TypeScript SDK -sidebarTitle: AllowedToolsUnion -description: AllowedToolsUnion type definition -seoTitle: AllowedToolsUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/allowedtoolsunion -'og:site_name': OpenRouter Documentation -'og:title': AllowedToolsUnion Type | OpenRouter TypeScript SDK -'og:description': >- - AllowedToolsUnion type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AllowedToolsUnion%20-%20TypeScript%20SDK&description=AllowedToolsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` - -### `models.AllowedTools` - -```typescript lines -const value: models.AllowedTools = {}; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/always.mdx b/client-sdks/typescript/api-reference/models/always.mdx deleted file mode 100644 index e2118b61..00000000 --- a/client-sdks/typescript/api-reference/models/always.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Always - TypeScript SDK -sidebarTitle: Always -description: Always type definition -seoTitle: Always Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/always' -'og:site_name': OpenRouter Documentation -'og:title': Always Type | OpenRouter TypeScript SDK -'og:description': >- - Always type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Always%20-%20TypeScript%20SDK&description=Always%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Always } from "@openrouter/sdk/models"; - -let value: Always = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/analysis.mdx b/client-sdks/typescript/api-reference/models/analysis.mdx deleted file mode 100644 index b0e0a46a..00000000 --- a/client-sdks/typescript/api-reference/models/analysis.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Analysis - TypeScript SDK -sidebarTitle: Analysis -description: Analysis type definition -seoTitle: Analysis Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/analysis' -'og:site_name': OpenRouter Documentation -'og:title': Analysis Type | OpenRouter TypeScript SDK -'og:description': >- - Analysis type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Analysis%20-%20TypeScript%20SDK&description=Analysis%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Structured analysis produced by the fusion judge model. - -## Example Usage - -```typescript expandable lines -import { Analysis } from "@openrouter/sdk/models"; - -let value: Analysis = { - blindSpots: [], - consensus: [ - "", - ], - contradictions: [ - { - stances: [ - { - model: "Roadster", - stance: "", - }, - ], - topic: "", - }, - ], - partialCoverage: [], - uniqueInsights: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `blindSpots` | *string*[] | :heavy_check_mark: | N/A | -| `consensus` | *string*[] | :heavy_check_mark: | N/A | -| `contradictions` | [models.Contradiction](/client-sdks/typescript/api-reference/models/contradiction)[] | :heavy_check_mark: | N/A | -| `partialCoverage` | [models.PartialCoverage](/client-sdks/typescript/api-reference/models/partialcoverage)[] | :heavy_check_mark: | N/A | -| `uniqueInsights` | [models.UniqueInsight](/client-sdks/typescript/api-reference/models/uniqueinsight)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/annotationaddedevent.mdx b/client-sdks/typescript/api-reference/models/annotationaddedevent.mdx deleted file mode 100644 index aa2d12cc..00000000 --- a/client-sdks/typescript/api-reference/models/annotationaddedevent.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: AnnotationAddedEvent - TypeScript SDK -sidebarTitle: AnnotationAddedEvent -description: AnnotationAddedEvent type definition -seoTitle: AnnotationAddedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/annotationaddedevent -'og:site_name': OpenRouter Documentation -'og:title': AnnotationAddedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - AnnotationAddedEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnnotationAddedEvent%20-%20TypeScript%20SDK&description=AnnotationAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a text annotation is added to output - -## Example Usage - -```typescript lines -import { AnnotationAddedEvent } from "@openrouter/sdk/models"; - -let value: AnnotationAddedEvent = { - annotation: { - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, - type: "file_citation", - }, - annotationIndex: 601849, - contentIndex: 735383, - itemId: "", - outputIndex: 124913, - sequenceNumber: 0, - type: "response.output_text.annotation.added", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `annotation` | *models.OpenAIResponsesAnnotation* | :heavy_check_mark: | N/A | `{"file_id": "file-abc123","filename": "research_paper.pdf","index": 0,"type": "file_citation"}` | -| `annotationIndex` | *number* | :heavy_check_mark: | N/A | | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_text.annotation.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicallowedcallers.mdx b/client-sdks/typescript/api-reference/models/anthropicallowedcallers.mdx deleted file mode 100644 index 7245ad6b..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicallowedcallers.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicAllowedCallers - TypeScript SDK -sidebarTitle: AnthropicAllowedCallers -description: AnthropicAllowedCallers type definition -seoTitle: AnthropicAllowedCallers Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicallowedcallers -'og:site_name': OpenRouter Documentation -'og:title': AnthropicAllowedCallers Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicAllowedCallers type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicAllowedCallers%20-%20TypeScript%20SDK&description=AnthropicAllowedCallers%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicAllowedCallers } from "@openrouter/sdk/models"; - -let value: AnthropicAllowedCallers = "code_execution_20260120"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"direct" | "code_execution_20250825" | "code_execution_20260120" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicbase64imagesource.mdx b/client-sdks/typescript/api-reference/models/anthropicbase64imagesource.mdx deleted file mode 100644 index cfc92d2d..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicbase64imagesource.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicBase64ImageSource - TypeScript SDK -sidebarTitle: AnthropicBase64ImageSource -description: AnthropicBase64ImageSource type definition -seoTitle: AnthropicBase64ImageSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicbase64imagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64ImageSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicBase64ImageSource type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64ImageSource%20-%20TypeScript%20SDK&description=AnthropicBase64ImageSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicBase64ImageSource } from "@openrouter/sdk/models"; - -let value: AnthropicBase64ImageSource = { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | | -| `mediaType` | [models.AnthropicImageMimeType](/client-sdks/typescript/api-reference/models/anthropicimagemimetype) | :heavy_check_mark: | N/A | image/jpeg | -| `type` | *"base64"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicbase64pdfsource.mdx b/client-sdks/typescript/api-reference/models/anthropicbase64pdfsource.mdx deleted file mode 100644 index dcc98bdf..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicbase64pdfsource.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicBase64PdfSource - TypeScript SDK -sidebarTitle: AnthropicBase64PdfSource -description: AnthropicBase64PdfSource type definition -seoTitle: AnthropicBase64PdfSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicbase64pdfsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicBase64PdfSource type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSource%20-%20TypeScript%20SDK&description=AnthropicBase64PdfSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicBase64PdfSource } from "@openrouter/sdk/models"; - -let value: AnthropicBase64PdfSource = { - data: "JVBERi0x...", - mediaType: "application/pdf", - type: "base64", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicBase64PdfSourceMediaType](/client-sdks/typescript/api-reference/models/anthropicbase64pdfsourcemediatype) | :heavy_check_mark: | N/A | -| `type` | *"base64"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicbase64pdfsourcemediatype.mdx b/client-sdks/typescript/api-reference/models/anthropicbase64pdfsourcemediatype.mdx deleted file mode 100644 index e7627f29..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicbase64pdfsourcemediatype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicBase64PdfSourceMediaType - TypeScript SDK -sidebarTitle: AnthropicBase64PdfSourceMediaType -description: AnthropicBase64PdfSourceMediaType type definition -seoTitle: AnthropicBase64PdfSourceMediaType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicbase64pdfsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicBase64PdfSourceMediaType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicBase64PdfSourceMediaType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicBase64PdfSourceMediaType%20-%20TypeScript%20SDK&description=AnthropicBase64PdfSourceMediaType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicBase64PdfSourceMediaType } from "@openrouter/sdk/models"; - -let value: AnthropicBase64PdfSourceMediaType = "application/pdf"; -``` - -## Values - -```typescript lines -"application/pdf" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccachecontroldirective.mdx b/client-sdks/typescript/api-reference/models/anthropiccachecontroldirective.mdx deleted file mode 100644 index e7eb5e05..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccachecontroldirective.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: AnthropicCacheControlDirective - TypeScript SDK -sidebarTitle: AnthropicCacheControlDirective -description: AnthropicCacheControlDirective type definition -seoTitle: AnthropicCacheControlDirective Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccachecontroldirective -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirective Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCacheControlDirective type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirective%20-%20TypeScript%20SDK&description=AnthropicCacheControlDirective%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Example Usage - -```typescript lines -import { AnthropicCacheControlDirective } from "@openrouter/sdk/models"; - -let value: AnthropicCacheControlDirective = { - type: "ephemeral", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ttl` | [models.AnthropicCacheControlTtl](/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.AnthropicCacheControlDirectiveType](/client-sdks/typescript/api-reference/models/anthropiccachecontroldirectivetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccachecontroldirectivetype.mdx b/client-sdks/typescript/api-reference/models/anthropiccachecontroldirectivetype.mdx deleted file mode 100644 index 2f81279e..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccachecontroldirectivetype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicCacheControlDirectiveType - TypeScript SDK -sidebarTitle: AnthropicCacheControlDirectiveType -description: AnthropicCacheControlDirectiveType type definition -seoTitle: AnthropicCacheControlDirectiveType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccachecontroldirectivetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlDirectiveType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCacheControlDirectiveType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlDirectiveType%20-%20TypeScript%20SDK&description=AnthropicCacheControlDirectiveType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCacheControlDirectiveType } from "@openrouter/sdk/models"; - -let value: AnthropicCacheControlDirectiveType = "ephemeral"; -``` - -## Values - -```typescript lines -"ephemeral" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl.mdx b/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl.mdx deleted file mode 100644 index f402c51d..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicCacheControlTtl - TypeScript SDK -sidebarTitle: AnthropicCacheControlTtl -description: AnthropicCacheControlTtl type definition -seoTitle: AnthropicCacheControlTtl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccachecontrolttl -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCacheControlTtl Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCacheControlTtl type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCacheControlTtl%20-%20TypeScript%20SDK&description=AnthropicCacheControlTtl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCacheControlTtl } from "@openrouter/sdk/models"; - -let value: AnthropicCacheControlTtl = "5m"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"5m" | "1h" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccitationcharlocationparam.mdx b/client-sdks/typescript/api-reference/models/anthropiccitationcharlocationparam.mdx deleted file mode 100644 index 2e41811f..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccitationcharlocationparam.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AnthropicCitationCharLocationParam - TypeScript SDK -sidebarTitle: AnthropicCitationCharLocationParam -description: AnthropicCitationCharLocationParam type definition -seoTitle: AnthropicCitationCharLocationParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccitationcharlocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationCharLocationParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCitationCharLocationParam type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationCharLocationParam%20-%20TypeScript%20SDK&description=AnthropicCitationCharLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCitationCharLocationParam } from "@openrouter/sdk/models"; - -let value: AnthropicCitationCharLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endCharIndex: 18, - startCharIndex: 0, - type: "char_location", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endCharIndex` | *number* | :heavy_check_mark: | N/A | -| `startCharIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"char_location"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccitationcontentblocklocationparam.mdx b/client-sdks/typescript/api-reference/models/anthropiccitationcontentblocklocationparam.mdx deleted file mode 100644 index 2edaed85..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccitationcontentblocklocationparam.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AnthropicCitationContentBlockLocationParam - TypeScript SDK -sidebarTitle: AnthropicCitationContentBlockLocationParam -description: AnthropicCitationContentBlockLocationParam type definition -seoTitle: AnthropicCitationContentBlockLocationParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccitationcontentblocklocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationContentBlockLocationParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCitationContentBlockLocationParam type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationContentBlockLocationParam%20-%20TypeScript%20SDK&description=AnthropicCitationContentBlockLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCitationContentBlockLocationParam } from "@openrouter/sdk/models"; - -let value: AnthropicCitationContentBlockLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endBlockIndex: 1, - startBlockIndex: 0, - type: "content_block_location", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"content_block_location"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccitationpagelocationparam.mdx b/client-sdks/typescript/api-reference/models/anthropiccitationpagelocationparam.mdx deleted file mode 100644 index 3f3955aa..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccitationpagelocationparam.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AnthropicCitationPageLocationParam - TypeScript SDK -sidebarTitle: AnthropicCitationPageLocationParam -description: AnthropicCitationPageLocationParam type definition -seoTitle: AnthropicCitationPageLocationParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccitationpagelocationparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationPageLocationParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCitationPageLocationParam type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationPageLocationParam%20-%20TypeScript%20SDK&description=AnthropicCitationPageLocationParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCitationPageLocationParam } from "@openrouter/sdk/models"; - -let value: AnthropicCitationPageLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endPageNumber: 2, - startPageNumber: 1, - type: "page_location", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endPageNumber` | *number* | :heavy_check_mark: | N/A | -| `startPageNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"page_location"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccitationsearchresultlocation.mdx b/client-sdks/typescript/api-reference/models/anthropiccitationsearchresultlocation.mdx deleted file mode 100644 index 7bf17fa6..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccitationsearchresultlocation.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: AnthropicCitationSearchResultLocation - TypeScript SDK -sidebarTitle: AnthropicCitationSearchResultLocation -description: AnthropicCitationSearchResultLocation type definition -seoTitle: AnthropicCitationSearchResultLocation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccitationsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationSearchResultLocation Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCitationSearchResultLocation type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationSearchResultLocation%20-%20TypeScript%20SDK&description=AnthropicCitationSearchResultLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCitationSearchResultLocation } from "@openrouter/sdk/models"; - -let value: AnthropicCitationSearchResultLocation = { - citedText: "Example cited text", - endBlockIndex: 1, - searchResultIndex: 0, - source: "example_source", - startBlockIndex: 0, - title: "Example Result", - type: "search_result_location", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `searchResultIndex` | *number* | :heavy_check_mark: | N/A | -| `source` | *string* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"search_result_location"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropiccitationwebsearchresultlocation.mdx b/client-sdks/typescript/api-reference/models/anthropiccitationwebsearchresultlocation.mdx deleted file mode 100644 index 1d4fff8e..00000000 --- a/client-sdks/typescript/api-reference/models/anthropiccitationwebsearchresultlocation.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: AnthropicCitationWebSearchResultLocation - TypeScript SDK -sidebarTitle: AnthropicCitationWebSearchResultLocation -description: AnthropicCitationWebSearchResultLocation type definition -seoTitle: AnthropicCitationWebSearchResultLocation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropiccitationwebsearchresultlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicCitationWebSearchResultLocation Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicCitationWebSearchResultLocation type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicCitationWebSearchResultLocation%20-%20TypeScript%20SDK&description=AnthropicCitationWebSearchResultLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicCitationWebSearchResultLocation } from "@openrouter/sdk/models"; - -let value: AnthropicCitationWebSearchResultLocation = { - citedText: "Example cited text", - encryptedIndex: "enc_idx_0", - title: "Example Page", - type: "web_search_result_location", - url: "https://example.com", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `encryptedIndex` | *string* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"web_search_result_location"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparam.mdx b/client-sdks/typescript/api-reference/models/anthropicdocumentblockparam.mdx deleted file mode 100644 index 6507cbab..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparam.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: AnthropicDocumentBlockParam - TypeScript SDK -sidebarTitle: AnthropicDocumentBlockParam -description: AnthropicDocumentBlockParam type definition -seoTitle: AnthropicDocumentBlockParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicdocumentblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicDocumentBlockParam type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParam%20-%20TypeScript%20SDK&description=AnthropicDocumentBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicDocumentBlockParam } from "@openrouter/sdk/models"; - -let value: AnthropicDocumentBlockParam = { - source: { - data: "Hello, world!", - mediaType: "text/plain", - type: "text", - }, - type: "document", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | [models.AnthropicDocumentBlockParamCitations](/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcitations) | :heavy_minus_sign: | N/A | | -| `context` | *string* | :heavy_minus_sign: | N/A | | -| `source` | *models.AnthropicDocumentBlockParamSourceUnion* | :heavy_check_mark: | N/A | | -| `title` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *"document"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcitations.mdx b/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcitations.mdx deleted file mode 100644 index 7b5f4304..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcitations.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicDocumentBlockParamCitations - TypeScript SDK -sidebarTitle: AnthropicDocumentBlockParamCitations -description: AnthropicDocumentBlockParamCitations type definition -seoTitle: AnthropicDocumentBlockParamCitations Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicdocumentblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamCitations Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicDocumentBlockParamCitations type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamCitations%20-%20TypeScript%20SDK&description=AnthropicDocumentBlockParamCitations%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicDocumentBlockParamCitations } from "@openrouter/sdk/models"; - -let value: AnthropicDocumentBlockParamCitations = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent1.mdx b/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent1.mdx deleted file mode 100644 index e026c6f8..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent1.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent1 - TypeScript SDK -sidebarTitle: AnthropicDocumentBlockParamContent1 -description: AnthropicDocumentBlockParamContent1 type definition -seoTitle: AnthropicDocumentBlockParamContent1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent1 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent1 Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicDocumentBlockParamContent1 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent1%20-%20TypeScript%20SDK&description=AnthropicDocumentBlockParamContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicImageBlockParam` - -```typescript lines -const value: models.AnthropicImageBlockParam = { - source: { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", - }, - type: "image", -}; -``` - -### `models.AnthropicTextBlockParam` - -```typescript lines -const value: models.AnthropicTextBlockParam = { - text: "Hello, world!", - type: "text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent2.mdx b/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent2.mdx deleted file mode 100644 index 0ce9ca3a..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicDocumentBlockParamContent2 - TypeScript SDK -sidebarTitle: AnthropicDocumentBlockParamContent2 -description: AnthropicDocumentBlockParamContent2 type definition -seoTitle: AnthropicDocumentBlockParamContent2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicdocumentblockparamcontent2 -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamContent2 Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicDocumentBlockParamContent2 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamContent2%20-%20TypeScript%20SDK&description=AnthropicDocumentBlockParamContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.AnthropicDocumentBlockParamContent1[]` - -```typescript lines -const value: models.AnthropicDocumentBlockParamContent1[] = []; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamsourceunion.mdx b/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamsourceunion.mdx deleted file mode 100644 index fbe2a5ae..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicdocumentblockparamsourceunion.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: AnthropicDocumentBlockParamSourceUnion - TypeScript SDK -sidebarTitle: AnthropicDocumentBlockParamSourceUnion -description: AnthropicDocumentBlockParamSourceUnion type definition -seoTitle: AnthropicDocumentBlockParamSourceUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicdocumentblockparamsourceunion -'og:site_name': OpenRouter Documentation -'og:title': AnthropicDocumentBlockParamSourceUnion Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicDocumentBlockParamSourceUnion type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicDocumentBlockParamSourceUnion%20-%20TypeScript%20SDK&description=AnthropicDocumentBlockParamSourceUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicBase64PdfSource` - -```typescript lines -const value: models.AnthropicBase64PdfSource = { - data: "JVBERi0x...", - mediaType: "application/pdf", - type: "base64", -}; -``` - -### `models.AnthropicPlainTextSource` - -```typescript lines -const value: models.AnthropicPlainTextSource = { - data: "Hello, world!", - mediaType: "text/plain", - type: "text", -}; -``` - -### `models.SourceContent` - -```typescript lines -const value: models.SourceContent = { - content: "", - type: "content", -}; -``` - -### `models.AnthropicUrlPdfSource` - -```typescript lines -const value: models.AnthropicUrlPdfSource = { - type: "url", - url: "https://example.com/document.pdf", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicimageblockparam.mdx b/client-sdks/typescript/api-reference/models/anthropicimageblockparam.mdx deleted file mode 100644 index d1b1320b..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicimageblockparam.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: AnthropicImageBlockParam - TypeScript SDK -sidebarTitle: AnthropicImageBlockParam -description: AnthropicImageBlockParam type definition -seoTitle: AnthropicImageBlockParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicimageblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicImageBlockParam type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParam%20-%20TypeScript%20SDK&description=AnthropicImageBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicImageBlockParam } from "@openrouter/sdk/models"; - -let value: AnthropicImageBlockParam = { - source: { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", - }, - type: "image", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `source` | *models.AnthropicImageBlockParamSource* | :heavy_check_mark: | N/A | | -| `type` | *"image"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicimageblockparamsource.mdx b/client-sdks/typescript/api-reference/models/anthropicimageblockparamsource.mdx deleted file mode 100644 index ce22d149..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicimageblockparamsource.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: AnthropicImageBlockParamSource - TypeScript SDK -sidebarTitle: AnthropicImageBlockParamSource -description: AnthropicImageBlockParamSource type definition -seoTitle: AnthropicImageBlockParamSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicimageblockparamsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageBlockParamSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicImageBlockParamSource type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageBlockParamSource%20-%20TypeScript%20SDK&description=AnthropicImageBlockParamSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicBase64ImageSource` - -```typescript lines -const value: models.AnthropicBase64ImageSource = { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", -}; -``` - -### `models.AnthropicUrlImageSource` - -```typescript lines -const value: models.AnthropicUrlImageSource = { - type: "url", - url: "https://example.com/image.jpg", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicimagemimetype.mdx b/client-sdks/typescript/api-reference/models/anthropicimagemimetype.mdx deleted file mode 100644 index fc188637..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicimagemimetype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicImageMimeType - TypeScript SDK -sidebarTitle: AnthropicImageMimeType -description: AnthropicImageMimeType type definition -seoTitle: AnthropicImageMimeType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicimagemimetype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicImageMimeType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicImageMimeType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicImageMimeType%20-%20TypeScript%20SDK&description=AnthropicImageMimeType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicImageMimeType } from "@openrouter/sdk/models"; - -let value: AnthropicImageMimeType = "image/jpeg"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"image/jpeg" | "image/png" | "image/gif" | "image/webp" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleast.mdx b/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleast.mdx deleted file mode 100644 index d5ef9508..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleast.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeast - TypeScript SDK -sidebarTitle: AnthropicInputTokensClearAtLeast -description: AnthropicInputTokensClearAtLeast type definition -seoTitle: AnthropicInputTokensClearAtLeast Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicinputtokensclearatleast -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeast Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicInputTokensClearAtLeast type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeast%20-%20TypeScript%20SDK&description=AnthropicInputTokensClearAtLeast%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicInputTokensClearAtLeast } from "@openrouter/sdk/models"; - -let value: AnthropicInputTokensClearAtLeast = { - type: "input_tokens", - value: 50000, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.AnthropicInputTokensClearAtLeastType](/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleasttype) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleasttype.mdx b/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleasttype.mdx deleted file mode 100644 index 2930387c..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleasttype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicInputTokensClearAtLeastType - TypeScript SDK -sidebarTitle: AnthropicInputTokensClearAtLeastType -description: AnthropicInputTokensClearAtLeastType type definition -seoTitle: AnthropicInputTokensClearAtLeastType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicinputtokensclearatleasttype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensClearAtLeastType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicInputTokensClearAtLeastType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensClearAtLeastType%20-%20TypeScript%20SDK&description=AnthropicInputTokensClearAtLeastType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicInputTokensClearAtLeastType } from "@openrouter/sdk/models"; - -let value: AnthropicInputTokensClearAtLeastType = "input_tokens"; -``` - -## Values - -```typescript lines -"input_tokens" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicinputtokenstrigger.mdx b/client-sdks/typescript/api-reference/models/anthropicinputtokenstrigger.mdx deleted file mode 100644 index b726b3cc..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicinputtokenstrigger.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicInputTokensTrigger - TypeScript SDK -sidebarTitle: AnthropicInputTokensTrigger -description: AnthropicInputTokensTrigger type definition -seoTitle: AnthropicInputTokensTrigger Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicinputtokenstrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicInputTokensTrigger Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicInputTokensTrigger type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicInputTokensTrigger%20-%20TypeScript%20SDK&description=AnthropicInputTokensTrigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicInputTokensTrigger } from "@openrouter/sdk/models"; - -let value: AnthropicInputTokensTrigger = { - type: "input_tokens", - value: 100000, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"input_tokens"* | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicplaintextsource.mdx b/client-sdks/typescript/api-reference/models/anthropicplaintextsource.mdx deleted file mode 100644 index 2d78f898..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicplaintextsource.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicPlainTextSource - TypeScript SDK -sidebarTitle: AnthropicPlainTextSource -description: AnthropicPlainTextSource type definition -seoTitle: AnthropicPlainTextSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicplaintextsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicPlainTextSource type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSource%20-%20TypeScript%20SDK&description=AnthropicPlainTextSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicPlainTextSource } from "@openrouter/sdk/models"; - -let value: AnthropicPlainTextSource = { - data: "Hello, world!", - mediaType: "text/plain", - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicPlainTextSourceMediaType](/client-sdks/typescript/api-reference/models/anthropicplaintextsourcemediatype) | :heavy_check_mark: | N/A | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicplaintextsourcemediatype.mdx b/client-sdks/typescript/api-reference/models/anthropicplaintextsourcemediatype.mdx deleted file mode 100644 index bc484600..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicplaintextsourcemediatype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicPlainTextSourceMediaType - TypeScript SDK -sidebarTitle: AnthropicPlainTextSourceMediaType -description: AnthropicPlainTextSourceMediaType type definition -seoTitle: AnthropicPlainTextSourceMediaType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicplaintextsourcemediatype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicPlainTextSourceMediaType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicPlainTextSourceMediaType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicPlainTextSourceMediaType%20-%20TypeScript%20SDK&description=AnthropicPlainTextSourceMediaType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicPlainTextSourceMediaType } from "@openrouter/sdk/models"; - -let value: AnthropicPlainTextSourceMediaType = "text/plain"; -``` - -## Values - -```typescript lines -"text/plain" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparam.mdx b/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparam.mdx deleted file mode 100644 index cbc842d4..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparam.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: AnthropicSearchResultBlockParam - TypeScript SDK -sidebarTitle: AnthropicSearchResultBlockParam -description: AnthropicSearchResultBlockParam type definition -seoTitle: AnthropicSearchResultBlockParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicSearchResultBlockParam type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParam%20-%20TypeScript%20SDK&description=AnthropicSearchResultBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicSearchResultBlockParam } from "@openrouter/sdk/models"; - -let value: AnthropicSearchResultBlockParam = { - content: [ - { - text: "Result content", - type: "text", - }, - ], - source: "example_source", - title: "Example Result", - type: "search_result", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | [models.AnthropicSearchResultBlockParamCitations](/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparamcitations) | :heavy_minus_sign: | N/A | | -| `content` | [models.AnthropicTextBlockParam](/client-sdks/typescript/api-reference/models/anthropictextblockparam)[] | :heavy_check_mark: | N/A | | -| `source` | *string* | :heavy_check_mark: | N/A | | -| `title` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"search_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparamcitations.mdx b/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparamcitations.mdx deleted file mode 100644 index 6ccdf95f..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicsearchresultblockparamcitations.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicSearchResultBlockParamCitations - TypeScript SDK -sidebarTitle: AnthropicSearchResultBlockParamCitations -description: AnthropicSearchResultBlockParamCitations type definition -seoTitle: AnthropicSearchResultBlockParamCitations Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicsearchresultblockparamcitations -'og:site_name': OpenRouter Documentation -'og:title': AnthropicSearchResultBlockParamCitations Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicSearchResultBlockParamCitations type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicSearchResultBlockParamCitations%20-%20TypeScript%20SDK&description=AnthropicSearchResultBlockParamCitations%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicSearchResultBlockParamCitations } from "@openrouter/sdk/models"; - -let value: AnthropicSearchResultBlockParamCitations = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropictextblockparam.mdx b/client-sdks/typescript/api-reference/models/anthropictextblockparam.mdx deleted file mode 100644 index 092c3c31..00000000 --- a/client-sdks/typescript/api-reference/models/anthropictextblockparam.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicTextBlockParam - TypeScript SDK -sidebarTitle: AnthropicTextBlockParam -description: AnthropicTextBlockParam type definition -seoTitle: AnthropicTextBlockParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropictextblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicTextBlockParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicTextBlockParam type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicTextBlockParam%20-%20TypeScript%20SDK&description=AnthropicTextBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicTextBlockParam } from "@openrouter/sdk/models"; - -let value: AnthropicTextBlockParam = { - text: "Hello, world!", - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `citations` | *models.Citation*[] | :heavy_minus_sign: | N/A | | -| `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"text"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicthinkingdisplay.mdx b/client-sdks/typescript/api-reference/models/anthropicthinkingdisplay.mdx deleted file mode 100644 index a937f0f1..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicthinkingdisplay.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: AnthropicThinkingDisplay - TypeScript SDK -sidebarTitle: AnthropicThinkingDisplay -description: AnthropicThinkingDisplay type definition -seoTitle: AnthropicThinkingDisplay Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicthinkingdisplay -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingDisplay Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicThinkingDisplay type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingDisplay%20-%20TypeScript%20SDK&description=AnthropicThinkingDisplay%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicThinkingDisplay } from "@openrouter/sdk/models"; - -let value: AnthropicThinkingDisplay = "summarized"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"summarized" | "omitted" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicthinkingturns.mdx b/client-sdks/typescript/api-reference/models/anthropicthinkingturns.mdx deleted file mode 100644 index 3e577444..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicthinkingturns.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicThinkingTurns - TypeScript SDK -sidebarTitle: AnthropicThinkingTurns -description: AnthropicThinkingTurns type definition -seoTitle: AnthropicThinkingTurns Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicthinkingturns -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurns Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicThinkingTurns type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurns%20-%20TypeScript%20SDK&description=AnthropicThinkingTurns%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicThinkingTurns } from "@openrouter/sdk/models"; - -let value: AnthropicThinkingTurns = { - type: "thinking_turns", - value: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [models.AnthropicThinkingTurnsType](/client-sdks/typescript/api-reference/models/anthropicthinkingturnstype) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicthinkingturnstype.mdx b/client-sdks/typescript/api-reference/models/anthropicthinkingturnstype.mdx deleted file mode 100644 index 140c5389..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicthinkingturnstype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicThinkingTurnsType - TypeScript SDK -sidebarTitle: AnthropicThinkingTurnsType -description: AnthropicThinkingTurnsType type definition -seoTitle: AnthropicThinkingTurnsType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicthinkingturnstype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicThinkingTurnsType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicThinkingTurnsType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicThinkingTurnsType%20-%20TypeScript%20SDK&description=AnthropicThinkingTurnsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicThinkingTurnsType } from "@openrouter/sdk/models"; - -let value: AnthropicThinkingTurnsType = "thinking_turns"; -``` - -## Values - -```typescript lines -"thinking_turns" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropictooluseskeep.mdx b/client-sdks/typescript/api-reference/models/anthropictooluseskeep.mdx deleted file mode 100644 index 303fb8c6..00000000 --- a/client-sdks/typescript/api-reference/models/anthropictooluseskeep.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicToolUsesKeep - TypeScript SDK -sidebarTitle: AnthropicToolUsesKeep -description: AnthropicToolUsesKeep type definition -seoTitle: AnthropicToolUsesKeep Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropictooluseskeep -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeep Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicToolUsesKeep type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeep%20-%20TypeScript%20SDK&description=AnthropicToolUsesKeep%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicToolUsesKeep } from "@openrouter/sdk/models"; - -let value: AnthropicToolUsesKeep = { - type: "tool_uses", - value: 5, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [models.AnthropicToolUsesKeepType](/client-sdks/typescript/api-reference/models/anthropictooluseskeeptype) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropictooluseskeeptype.mdx b/client-sdks/typescript/api-reference/models/anthropictooluseskeeptype.mdx deleted file mode 100644 index 78e15492..00000000 --- a/client-sdks/typescript/api-reference/models/anthropictooluseskeeptype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicToolUsesKeepType - TypeScript SDK -sidebarTitle: AnthropicToolUsesKeepType -description: AnthropicToolUsesKeepType type definition -seoTitle: AnthropicToolUsesKeepType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropictooluseskeeptype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesKeepType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicToolUsesKeepType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesKeepType%20-%20TypeScript%20SDK&description=AnthropicToolUsesKeepType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicToolUsesKeepType } from "@openrouter/sdk/models"; - -let value: AnthropicToolUsesKeepType = "tool_uses"; -``` - -## Values - -```typescript lines -"tool_uses" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropictoolusestrigger.mdx b/client-sdks/typescript/api-reference/models/anthropictoolusestrigger.mdx deleted file mode 100644 index 24e3a334..00000000 --- a/client-sdks/typescript/api-reference/models/anthropictoolusestrigger.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicToolUsesTrigger - TypeScript SDK -sidebarTitle: AnthropicToolUsesTrigger -description: AnthropicToolUsesTrigger type definition -seoTitle: AnthropicToolUsesTrigger Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropictoolusestrigger -'og:site_name': OpenRouter Documentation -'og:title': AnthropicToolUsesTrigger Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicToolUsesTrigger type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicToolUsesTrigger%20-%20TypeScript%20SDK&description=AnthropicToolUsesTrigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicToolUsesTrigger } from "@openrouter/sdk/models"; - -let value: AnthropicToolUsesTrigger = { - type: "tool_uses", - value: 10, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"tool_uses"* | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicurlimagesource.mdx b/client-sdks/typescript/api-reference/models/anthropicurlimagesource.mdx deleted file mode 100644 index df6ed9c5..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicurlimagesource.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicUrlImageSource - TypeScript SDK -sidebarTitle: AnthropicUrlImageSource -description: AnthropicUrlImageSource type definition -seoTitle: AnthropicUrlImageSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicurlimagesource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicUrlImageSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicUrlImageSource type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicUrlImageSource%20-%20TypeScript%20SDK&description=AnthropicUrlImageSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicUrlImageSource } from "@openrouter/sdk/models"; - -let value: AnthropicUrlImageSource = { - type: "url", - url: "https://example.com/image.jpg", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"url"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicurlpdfsource.mdx b/client-sdks/typescript/api-reference/models/anthropicurlpdfsource.mdx deleted file mode 100644 index 43732cdd..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicurlpdfsource.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: AnthropicUrlPdfSource - TypeScript SDK -sidebarTitle: AnthropicUrlPdfSource -description: AnthropicUrlPdfSource type definition -seoTitle: AnthropicUrlPdfSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicurlpdfsource -'og:site_name': OpenRouter Documentation -'og:title': AnthropicUrlPdfSource Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicUrlPdfSource type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicUrlPdfSource%20-%20TypeScript%20SDK&description=AnthropicUrlPdfSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicUrlPdfSource } from "@openrouter/sdk/models"; - -let value: AnthropicUrlPdfSource = { - type: "url", - url: "https://example.com/document.pdf", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"url"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparam.mdx b/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparam.mdx deleted file mode 100644 index d97290f7..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparam.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParam - TypeScript SDK -sidebarTitle: AnthropicWebSearchResultBlockParam -description: AnthropicWebSearchResultBlockParam type definition -seoTitle: AnthropicWebSearchResultBlockParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicwebsearchresultblockparam -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParam Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicWebSearchResultBlockParam type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParam%20-%20TypeScript%20SDK&description=AnthropicWebSearchResultBlockParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicWebSearchResultBlockParam } from "@openrouter/sdk/models"; - -let value: AnthropicWebSearchResultBlockParam = { - encryptedContent: "enc_content_0", - title: "Example Page", - type: "web_search_result", - url: "https://example.com", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | -| `pageAge` | *string* | :heavy_minus_sign: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicWebSearchResultBlockParamType](/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparamtype) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparamtype.mdx b/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparamtype.mdx deleted file mode 100644 index 9aa95e0e..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicwebsearchresultblockparamtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicWebSearchResultBlockParamType - TypeScript SDK -sidebarTitle: AnthropicWebSearchResultBlockParamType -description: AnthropicWebSearchResultBlockParamType type definition -seoTitle: AnthropicWebSearchResultBlockParamType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicwebsearchresultblockparamtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchResultBlockParamType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicWebSearchResultBlockParamType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchResultBlockParamType%20-%20TypeScript%20SDK&description=AnthropicWebSearchResultBlockParamType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicWebSearchResultBlockParamType } from "@openrouter/sdk/models"; - -let value: AnthropicWebSearchResultBlockParamType = "web_search_result"; -``` - -## Values - -```typescript lines -"web_search_result" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocation.mdx b/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocation.mdx deleted file mode 100644 index 54aa02dc..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocation - TypeScript SDK -sidebarTitle: AnthropicWebSearchToolUserLocation -description: AnthropicWebSearchToolUserLocation type definition -seoTitle: AnthropicWebSearchToolUserLocation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocation -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocation Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicWebSearchToolUserLocation type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocation%20-%20TypeScript%20SDK&description=AnthropicWebSearchToolUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicWebSearchToolUserLocation } from "@openrouter/sdk/models"; - -let value: AnthropicWebSearchToolUserLocation = { - type: "approximate", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.AnthropicWebSearchToolUserLocationType](/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx b/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx deleted file mode 100644 index c35c2026..00000000 --- a/client-sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocationtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: AnthropicWebSearchToolUserLocationType - TypeScript SDK -sidebarTitle: AnthropicWebSearchToolUserLocationType -description: AnthropicWebSearchToolUserLocationType type definition -seoTitle: AnthropicWebSearchToolUserLocationType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/anthropicwebsearchtooluserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': AnthropicWebSearchToolUserLocationType Type | OpenRouter TypeScript SDK -'og:description': >- - AnthropicWebSearchToolUserLocationType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AnthropicWebSearchToolUserLocationType%20-%20TypeScript%20SDK&description=AnthropicWebSearchToolUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AnthropicWebSearchToolUserLocationType } from "@openrouter/sdk/models"; - -let value: AnthropicWebSearchToolUserLocationType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/apitype.mdx b/client-sdks/typescript/api-reference/models/apitype.mdx deleted file mode 100644 index a15aa735..00000000 --- a/client-sdks/typescript/api-reference/models/apitype.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ApiType - TypeScript SDK -sidebarTitle: ApiType -description: ApiType type definition -seoTitle: ApiType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/apitype' -'og:site_name': OpenRouter Documentation -'og:title': ApiType Type | OpenRouter TypeScript SDK -'og:description': >- - ApiType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApiType%20-%20TypeScript%20SDK&description=ApiType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Type of API used for the generation - -## Example Usage - -```typescript lines -import { ApiType } from "@openrouter/sdk/models"; - -let value: ApiType = "tts"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"completions" | "embeddings" | "rerank" | "tts" | "stt" | "video" | "image" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcallitem.mdx b/client-sdks/typescript/api-reference/models/applypatchcallitem.mdx deleted file mode 100644 index 4bdb8a53..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcallitem.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ApplyPatchCallItem - TypeScript SDK -sidebarTitle: ApplyPatchCallItem -description: ApplyPatchCallItem type definition -seoTitle: ApplyPatchCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcallitem -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItem%20-%20TypeScript%20SDK&description=ApplyPatchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A tool call emitted by the model requesting a V4A patch operation. The client applies the patch and echoes an `apply_patch_call_output` on the next turn. - -## Example Usage - -```typescript lines -import { ApplyPatchCallItem } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallItem = { - callId: "call_abc123", - operation: { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", - }, - status: "completed", - type: "apply_patch_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `status` | [models.ApplyPatchCallStatus](/client-sdks/typescript/api-reference/models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [models.ApplyPatchCallItemType](/client-sdks/typescript/api-reference/models/applypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcallitemtype.mdx b/client-sdks/typescript/api-reference/models/applypatchcallitemtype.mdx deleted file mode 100644 index ecfaadc4..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ApplyPatchCallItemType - TypeScript SDK -sidebarTitle: ApplyPatchCallItemType -description: ApplyPatchCallItemType type definition -seoTitle: ApplyPatchCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallItemType%20-%20TypeScript%20SDK&description=ApplyPatchCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ApplyPatchCallItemType } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallItemType = "apply_patch_call"; -``` - -## Values - -```typescript lines -"apply_patch_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloperation.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloperation.mdx deleted file mode 100644 index 9a05b277..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloperation.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ApplyPatchCallOperation - TypeScript SDK -sidebarTitle: ApplyPatchCallOperation -description: ApplyPatchCallOperation type definition -seoTitle: ApplyPatchCallOperation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperation Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOperation type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperation%20-%20TypeScript%20SDK&description=ApplyPatchCallOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. - -## Supported Types - -### `models.ApplyPatchCreateFileOperation` - -```typescript lines -const value: models.ApplyPatchCreateFileOperation = { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "create_file", -}; -``` - -### `models.ApplyPatchDeleteFileOperation` - -```typescript lines -const value: models.ApplyPatchDeleteFileOperation = { - path: "/src/main.ts", - type: "delete_file", -}; -``` - -### `models.ApplyPatchUpdateFileOperation` - -```typescript lines -const value: models.ApplyPatchUpdateFileOperation = { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx deleted file mode 100644 index 68aa5bfe..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdeltaevent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDeltaEvent - TypeScript SDK -sidebarTitle: ApplyPatchCallOperationDiffDeltaEvent -description: ApplyPatchCallOperationDiffDeltaEvent type definition -seoTitle: ApplyPatchCallOperationDiffDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloperationdiffdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOperationDiffDeltaEvent type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDeltaEvent%20-%20TypeScript%20SDK&description=ApplyPatchCallOperationDiffDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI's streaming shape. - -## Example Usage - -```typescript lines -import { ApplyPatchCallOperationDiffDeltaEvent } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallOperationDiffDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 790412, - sequenceNumber: 0, - type: "response.apply_patch_call_operation_diff.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.apply_patch_call_operation_diff.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdoneevent.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdoneevent.mdx deleted file mode 100644 index 7972cc86..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloperationdiffdoneevent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ApplyPatchCallOperationDiffDoneEvent - TypeScript SDK -sidebarTitle: ApplyPatchCallOperationDiffDoneEvent -description: ApplyPatchCallOperationDiffDoneEvent type definition -seoTitle: ApplyPatchCallOperationDiffDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloperationdiffdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOperationDiffDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOperationDiffDoneEvent type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOperationDiffDoneEvent%20-%20TypeScript%20SDK&description=ApplyPatchCallOperationDiffDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Emitted when `operation.diff` streaming completes for an `apply_patch_call`. - -## Example Usage - -```typescript lines -import { ApplyPatchCallOperationDiffDoneEvent } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallOperationDiffDoneEvent = { - diff: "", - itemId: "", - outputIndex: 170720, - sequenceNumber: 0, - type: "response.apply_patch_call_operation_diff.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.apply_patch_call_operation_diff.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloutputitem.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloutputitem.mdx deleted file mode 100644 index 977ad5b0..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloutputitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ApplyPatchCallOutputItem - TypeScript SDK -sidebarTitle: ApplyPatchCallOutputItem -description: ApplyPatchCallOutputItem type definition -seoTitle: ApplyPatchCallOutputItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItem Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOutputItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItem%20-%20TypeScript%20SDK&description=ApplyPatchCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The client's echo of an `apply_patch_call` after applying the patch. `output` is an optional human-readable log; `status` is `completed` when the patch was applied successfully, `failed` otherwise. - -## Example Usage - -```typescript lines -import { ApplyPatchCallOutputItem } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallOutputItem = { - callId: "call_abc123", - status: "completed", - type: "apply_patch_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *string* | :heavy_minus_sign: | N/A | -| `status` | [models.ApplyPatchCallOutputItemStatus](/client-sdks/typescript/api-reference/models/applypatchcalloutputitemstatus) | :heavy_check_mark: | N/A | -| `type` | [models.ApplyPatchCallOutputItemType](/client-sdks/typescript/api-reference/models/applypatchcalloutputitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloutputitemstatus.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloutputitemstatus.mdx deleted file mode 100644 index ba1ba3c3..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloutputitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchCallOutputItemStatus - TypeScript SDK -sidebarTitle: ApplyPatchCallOutputItemStatus -description: ApplyPatchCallOutputItemStatus type definition -seoTitle: ApplyPatchCallOutputItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOutputItemStatus type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemStatus%20-%20TypeScript%20SDK&description=ApplyPatchCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ApplyPatchCallOutputItemStatus } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallOutputItemStatus = "failed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"completed" | "failed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcalloutputitemtype.mdx b/client-sdks/typescript/api-reference/models/applypatchcalloutputitemtype.mdx deleted file mode 100644 index b3f5793d..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcalloutputitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ApplyPatchCallOutputItemType - TypeScript SDK -sidebarTitle: ApplyPatchCallOutputItemType -description: ApplyPatchCallOutputItemType type definition -seoTitle: ApplyPatchCallOutputItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallOutputItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallOutputItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallOutputItemType%20-%20TypeScript%20SDK&description=ApplyPatchCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ApplyPatchCallOutputItemType } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallOutputItemType = "apply_patch_call_output"; -``` - -## Values - -```typescript lines -"apply_patch_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcallstatus.mdx b/client-sdks/typescript/api-reference/models/applypatchcallstatus.mdx deleted file mode 100644 index 19038fc2..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcallstatus.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ApplyPatchCallStatus - TypeScript SDK -sidebarTitle: ApplyPatchCallStatus -description: ApplyPatchCallStatus type definition -seoTitle: ApplyPatchCallStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcallstatus -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCallStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCallStatus type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCallStatus%20-%20TypeScript%20SDK&description=ApplyPatchCallStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Lifecycle state of an `apply_patch_call` output item. - -## Example Usage - -```typescript lines -import { ApplyPatchCallStatus } from "@openrouter/sdk/models"; - -let value: ApplyPatchCallStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchcreatefileoperation.mdx b/client-sdks/typescript/api-reference/models/applypatchcreatefileoperation.mdx deleted file mode 100644 index d4de9d1f..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchcreatefileoperation.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ApplyPatchCreateFileOperation - TypeScript SDK -sidebarTitle: ApplyPatchCreateFileOperation -description: ApplyPatchCreateFileOperation type definition -seoTitle: ApplyPatchCreateFileOperation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchcreatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchCreateFileOperation Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchCreateFileOperation type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchCreateFileOperation%20-%20TypeScript%20SDK&description=ApplyPatchCreateFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing the new file contents. - -## Example Usage - -```typescript lines -import { ApplyPatchCreateFileOperation } from "@openrouter/sdk/models"; - -let value: ApplyPatchCreateFileOperation = { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "create_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"create_file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchdeletefileoperation.mdx b/client-sdks/typescript/api-reference/models/applypatchdeletefileoperation.mdx deleted file mode 100644 index 34014b77..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchdeletefileoperation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ApplyPatchDeleteFileOperation - TypeScript SDK -sidebarTitle: ApplyPatchDeleteFileOperation -description: ApplyPatchDeleteFileOperation type definition -seoTitle: ApplyPatchDeleteFileOperation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchdeletefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchDeleteFileOperation Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchDeleteFileOperation type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchDeleteFileOperation%20-%20TypeScript%20SDK&description=ApplyPatchDeleteFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The `delete_file` variant of an `apply_patch_call.operation`. Identifies the file to remove; no diff is required. - -## Example Usage - -```typescript lines -import { ApplyPatchDeleteFileOperation } from "@openrouter/sdk/models"; - -let value: ApplyPatchDeleteFileOperation = { - path: "/src/main.ts", - type: "delete_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"delete_file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchengineenum.mdx b/client-sdks/typescript/api-reference/models/applypatchengineenum.mdx deleted file mode 100644 index 180d56a7..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchengineenum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ApplyPatchEngineEnum - TypeScript SDK -sidebarTitle: ApplyPatchEngineEnum -description: ApplyPatchEngineEnum type definition -seoTitle: ApplyPatchEngineEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchengineenum -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchEngineEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchEngineEnum type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchEngineEnum%20-%20TypeScript%20SDK&description=ApplyPatchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { ApplyPatchEngineEnum } from "@openrouter/sdk/models"; - -let value: ApplyPatchEngineEnum = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "native" | "openrouter" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchservertool.mdx b/client-sdks/typescript/api-reference/models/applypatchservertool.mdx deleted file mode 100644 index e0e16082..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchservertool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ApplyPatchServerTool - TypeScript SDK -sidebarTitle: ApplyPatchServerTool -description: ApplyPatchServerTool type definition -seoTitle: ApplyPatchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchservertool -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerTool%20-%20TypeScript%20SDK&description=ApplyPatchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Apply patch tool configuration - -## Example Usage - -```typescript lines -import { ApplyPatchServerTool } from "@openrouter/sdk/models"; - -let value: ApplyPatchServerTool = { - type: "apply_patch", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"apply_patch"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/applypatchservertoolconfig.mdx deleted file mode 100644 index 1999b968..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchservertoolconfig.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApplyPatchServerToolConfig - TypeScript SDK -sidebarTitle: ApplyPatchServerToolConfig -description: ApplyPatchServerToolConfig type definition -seoTitle: ApplyPatchServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolConfig%20-%20TypeScript%20SDK&description=ApplyPatchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:apply_patch server tool - -## Example Usage - -```typescript lines -import { ApplyPatchServerToolConfig } from "@openrouter/sdk/models"; - -let value: ApplyPatchServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.ApplyPatchEngineEnum](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/applypatchservertoolopenrouter.mdx b/client-sdks/typescript/api-reference/models/applypatchservertoolopenrouter.mdx deleted file mode 100644 index 02f980d8..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchservertoolopenrouter.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ApplyPatchServerToolOpenRouter - TypeScript SDK -sidebarTitle: ApplyPatchServerToolOpenRouter -description: ApplyPatchServerToolOpenRouter type definition -seoTitle: ApplyPatchServerToolOpenRouter Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchServerToolOpenRouter Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchServerToolOpenRouter type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchServerToolOpenRouter%20-%20TypeScript%20SDK&description=ApplyPatchServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: validates V4A diff patches for file operations (create, update, delete). Restricted to the Responses API. - -## Example Usage - -```typescript lines -import { ApplyPatchServerToolOpenRouter } from "@openrouter/sdk/models"; - -let value: ApplyPatchServerToolOpenRouter = { - type: "openrouter:apply_patch", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `parameters` | [models.ApplyPatchServerToolConfig](/client-sdks/typescript/api-reference/models/applypatchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | `{"engine": "auto"}` | -| `type` | *"openrouter:apply_patch"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/applypatchupdatefileoperation.mdx b/client-sdks/typescript/api-reference/models/applypatchupdatefileoperation.mdx deleted file mode 100644 index 8dc293a0..00000000 --- a/client-sdks/typescript/api-reference/models/applypatchupdatefileoperation.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ApplyPatchUpdateFileOperation - TypeScript SDK -sidebarTitle: ApplyPatchUpdateFileOperation -description: ApplyPatchUpdateFileOperation type definition -seoTitle: ApplyPatchUpdateFileOperation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/applypatchupdatefileoperation -'og:site_name': OpenRouter Documentation -'og:title': ApplyPatchUpdateFileOperation Type | OpenRouter TypeScript SDK -'og:description': >- - ApplyPatchUpdateFileOperation type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApplyPatchUpdateFileOperation%20-%20TypeScript%20SDK&description=ApplyPatchUpdateFileOperation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff describing edits to an existing file. - -## Example Usage - -```typescript lines -import { ApplyPatchUpdateFileOperation } from "@openrouter/sdk/models"; - -let value: ApplyPatchUpdateFileOperation = { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"update_file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/architecture.mdx b/client-sdks/typescript/api-reference/models/architecture.mdx deleted file mode 100644 index 8d78cb7e..00000000 --- a/client-sdks/typescript/api-reference/models/architecture.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Architecture - TypeScript SDK -sidebarTitle: Architecture -description: Architecture type definition -seoTitle: Architecture Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/architecture' -'og:site_name': OpenRouter Documentation -'og:title': Architecture Type | OpenRouter TypeScript SDK -'og:description': >- - Architecture type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Architecture%20-%20TypeScript%20SDK&description=Architecture%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Example Usage - -```typescript lines -import { Architecture } from "@openrouter/sdk/models"; - -let value: Architecture = { - inputModalities: [ - "text", - ], - instructType: "chatml", - modality: "text", - outputModalities: [ - "text", - ], - tokenizer: "GPT", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `inputModalities` | [models.InputModality](/client-sdks/typescript/api-reference/models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.InstructType](/client-sdks/typescript/api-reference/models/instructtype) | :heavy_check_mark: | Instruction format type | chatml | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text | -| `outputModalities` | [models.OutputModality](/client-sdks/typescript/api-reference/models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.Tokenizer](/client-sdks/typescript/api-reference/models/tokenizer) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/aspectratio.mdx b/client-sdks/typescript/api-reference/models/aspectratio.mdx deleted file mode 100644 index b8e369da..00000000 --- a/client-sdks/typescript/api-reference/models/aspectratio.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: AspectRatio - TypeScript SDK -sidebarTitle: AspectRatio -description: AspectRatio type definition -seoTitle: AspectRatio Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/aspectratio' -'og:site_name': OpenRouter Documentation -'og:title': AspectRatio Type | OpenRouter TypeScript SDK -'og:description': >- - AspectRatio type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AspectRatio%20-%20TypeScript%20SDK&description=AspectRatio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Aspect ratio of the generated video - -## Example Usage - -```typescript lines -import { AspectRatio } from "@openrouter/sdk/models"; - -let value: AspectRatio = "16:9"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "21:9" | "9:21" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/autorouterplugin.mdx b/client-sdks/typescript/api-reference/models/autorouterplugin.mdx deleted file mode 100644 index 04e37414..00000000 --- a/client-sdks/typescript/api-reference/models/autorouterplugin.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: AutoRouterPlugin - TypeScript SDK -sidebarTitle: AutoRouterPlugin -description: AutoRouterPlugin type definition -seoTitle: AutoRouterPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/autorouterplugin -'og:site_name': OpenRouter Documentation -'og:title': AutoRouterPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - AutoRouterPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AutoRouterPlugin%20-%20TypeScript%20SDK&description=AutoRouterPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AutoRouterPlugin } from "@openrouter/sdk/models"; - -let value: AutoRouterPlugin = { - id: "auto-router", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| `costQualityTradeoff` | *number* | :heavy_minus_sign: | 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. | 7 | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `id` | *"auto-router"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/background.mdx b/client-sdks/typescript/api-reference/models/background.mdx deleted file mode 100644 index 35c56eb6..00000000 --- a/client-sdks/typescript/api-reference/models/background.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Background - TypeScript SDK -sidebarTitle: Background -description: Background type definition -seoTitle: Background Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/background' -'og:site_name': OpenRouter Documentation -'og:title': Background Type | OpenRouter TypeScript SDK -'og:description': >- - Background type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Background%20-%20TypeScript%20SDK&description=Background%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Background } from "@openrouter/sdk/models"; - -let value: Background = "transparent"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"transparent" | "opaque" | "auto" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/badgatewayresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/badgatewayresponseerrordata.mdx deleted file mode 100644 index fc5fbdad..00000000 --- a/client-sdks/typescript/api-reference/models/badgatewayresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BadGatewayResponseErrorData - TypeScript SDK -sidebarTitle: BadGatewayResponseErrorData -description: BadGatewayResponseErrorData type definition -seoTitle: BadGatewayResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/badgatewayresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - BadGatewayResponseErrorData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseErrorData%20-%20TypeScript%20SDK&description=BadGatewayResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for BadGatewayResponse - -## Example Usage - -```typescript lines -import { BadGatewayResponseErrorData } from "@openrouter/sdk/models"; - -let value: BadGatewayResponseErrorData = { - code: 502, - message: "Provider returned error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/badrequestresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/badrequestresponseerrordata.mdx deleted file mode 100644 index 6eb84269..00000000 --- a/client-sdks/typescript/api-reference/models/badrequestresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BadRequestResponseErrorData - TypeScript SDK -sidebarTitle: BadRequestResponseErrorData -description: BadRequestResponseErrorData type definition -seoTitle: BadRequestResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/badrequestresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - BadRequestResponseErrorData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseErrorData%20-%20TypeScript%20SDK&description=BadRequestResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for BadRequestResponse - -## Example Usage - -```typescript lines -import { BadRequestResponseErrorData } from "@openrouter/sdk/models"; - -let value: BadRequestResponseErrorData = { - code: 400, - message: "Invalid request parameters", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputscontent1.mdx b/client-sdks/typescript/api-reference/models/baseinputscontent1.mdx deleted file mode 100644 index 363b1579..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputscontent1.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: BaseInputsContent1 - TypeScript SDK -sidebarTitle: BaseInputsContent1 -description: BaseInputsContent1 type definition -seoTitle: BaseInputsContent1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputscontent1 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent1 Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsContent1 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent1%20-%20TypeScript%20SDK&description=BaseInputsContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputAudio` - -```typescript lines -const value: models.InputAudio = { - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, - type: "input_audio", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputImage` - -```typescript lines -const value: models.InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputscontent2.mdx b/client-sdks/typescript/api-reference/models/baseinputscontent2.mdx deleted file mode 100644 index 9a7146b0..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputscontent2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsContent2 - TypeScript SDK -sidebarTitle: BaseInputsContent2 -description: BaseInputsContent2 type definition -seoTitle: BaseInputsContent2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputscontent2 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsContent2 Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsContent2 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsContent2%20-%20TypeScript%20SDK&description=BaseInputsContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.BaseInputsContent1[]` - -```typescript lines -const value: models.BaseInputsContent1[] = []; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsmessage.mdx b/client-sdks/typescript/api-reference/models/baseinputsmessage.mdx deleted file mode 100644 index d7b924c2..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsmessage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: BaseInputsMessage - TypeScript SDK -sidebarTitle: BaseInputsMessage -description: BaseInputsMessage type definition -seoTitle: BaseInputsMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsmessage -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsMessage Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsMessage%20-%20TypeScript%20SDK&description=BaseInputsMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsMessage } from "@openrouter/sdk/models"; - -let value: BaseInputsMessage = { - content: "", - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | *models.BaseInputsContent2* | :heavy_check_mark: | N/A | -| `phase` | *models.BaseInputsPhaseUnion* | :heavy_minus_sign: | N/A | -| `role` | *models.BaseInputsRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.BaseInputsType](/client-sdks/typescript/api-reference/models/baseinputstype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsphasecommentary.mdx b/client-sdks/typescript/api-reference/models/baseinputsphasecommentary.mdx deleted file mode 100644 index 84044ad1..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsphasecommentary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsPhaseCommentary - TypeScript SDK -sidebarTitle: BaseInputsPhaseCommentary -description: BaseInputsPhaseCommentary type definition -seoTitle: BaseInputsPhaseCommentary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseCommentary Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsPhaseCommentary type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseCommentary%20-%20TypeScript%20SDK&description=BaseInputsPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsPhaseCommentary } from "@openrouter/sdk/models"; - -let value: BaseInputsPhaseCommentary = "commentary"; -``` - -## Values - -```typescript lines -"commentary" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsphasefinalanswer.mdx b/client-sdks/typescript/api-reference/models/baseinputsphasefinalanswer.mdx deleted file mode 100644 index 0e2c51f5..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsphasefinalanswer.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsPhaseFinalAnswer - TypeScript SDK -sidebarTitle: BaseInputsPhaseFinalAnswer -description: BaseInputsPhaseFinalAnswer type definition -seoTitle: BaseInputsPhaseFinalAnswer Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseFinalAnswer Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsPhaseFinalAnswer type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseFinalAnswer%20-%20TypeScript%20SDK&description=BaseInputsPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsPhaseFinalAnswer } from "@openrouter/sdk/models"; - -let value: BaseInputsPhaseFinalAnswer = "final_answer"; -``` - -## Values - -```typescript lines -"final_answer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsphaseunion.mdx b/client-sdks/typescript/api-reference/models/baseinputsphaseunion.mdx deleted file mode 100644 index c902dc17..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsphaseunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: BaseInputsPhaseUnion - TypeScript SDK -sidebarTitle: BaseInputsPhaseUnion -description: BaseInputsPhaseUnion type definition -seoTitle: BaseInputsPhaseUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsphaseunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsPhaseUnion Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsPhaseUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsPhaseUnion%20-%20TypeScript%20SDK&description=BaseInputsPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.BaseInputsPhaseCommentary` - -```typescript lines -const value: models.BaseInputsPhaseCommentary = "commentary"; -``` - -### `models.BaseInputsPhaseFinalAnswer` - -```typescript lines -const value: models.BaseInputsPhaseFinalAnswer = "final_answer"; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsroleassistant.mdx b/client-sdks/typescript/api-reference/models/baseinputsroleassistant.mdx deleted file mode 100644 index 73bf285e..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsroleassistant.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsRoleAssistant - TypeScript SDK -sidebarTitle: BaseInputsRoleAssistant -description: BaseInputsRoleAssistant type definition -seoTitle: BaseInputsRoleAssistant Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsroleassistant -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleAssistant Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsRoleAssistant type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleAssistant%20-%20TypeScript%20SDK&description=BaseInputsRoleAssistant%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsRoleAssistant } from "@openrouter/sdk/models"; - -let value: BaseInputsRoleAssistant = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsroledeveloper.mdx b/client-sdks/typescript/api-reference/models/baseinputsroledeveloper.mdx deleted file mode 100644 index b018ff23..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsRoleDeveloper - TypeScript SDK -sidebarTitle: BaseInputsRoleDeveloper -description: BaseInputsRoleDeveloper type definition -seoTitle: BaseInputsRoleDeveloper Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleDeveloper Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsRoleDeveloper type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleDeveloper%20-%20TypeScript%20SDK&description=BaseInputsRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsRoleDeveloper } from "@openrouter/sdk/models"; - -let value: BaseInputsRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsrolesystem.mdx b/client-sdks/typescript/api-reference/models/baseinputsrolesystem.mdx deleted file mode 100644 index 807cb0cb..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsrolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsRoleSystem - TypeScript SDK -sidebarTitle: BaseInputsRoleSystem -description: BaseInputsRoleSystem type definition -seoTitle: BaseInputsRoleSystem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsrolesystem -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleSystem Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsRoleSystem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleSystem%20-%20TypeScript%20SDK&description=BaseInputsRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsRoleSystem } from "@openrouter/sdk/models"; - -let value: BaseInputsRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsroleunion.mdx b/client-sdks/typescript/api-reference/models/baseinputsroleunion.mdx deleted file mode 100644 index f37f83a6..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsroleunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BaseInputsRoleUnion - TypeScript SDK -sidebarTitle: BaseInputsRoleUnion -description: BaseInputsRoleUnion type definition -seoTitle: BaseInputsRoleUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsroleunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUnion Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsRoleUnion type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUnion%20-%20TypeScript%20SDK&description=BaseInputsRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.BaseInputsRoleUser` - -```typescript lines -const value: models.BaseInputsRoleUser = "user"; -``` - -### `models.BaseInputsRoleSystem` - -```typescript lines -const value: models.BaseInputsRoleSystem = "system"; -``` - -### `models.BaseInputsRoleAssistant` - -```typescript lines -const value: models.BaseInputsRoleAssistant = "assistant"; -``` - -### `models.BaseInputsRoleDeveloper` - -```typescript lines -const value: models.BaseInputsRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsroleuser.mdx b/client-sdks/typescript/api-reference/models/baseinputsroleuser.mdx deleted file mode 100644 index 5ec5f2a6..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsroleuser.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: BaseInputsRoleUser - TypeScript SDK -sidebarTitle: BaseInputsRoleUser -description: BaseInputsRoleUser type definition -seoTitle: BaseInputsRoleUser Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsroleuser -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsRoleUser Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsRoleUser type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsRoleUser%20-%20TypeScript%20SDK&description=BaseInputsRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsRoleUser } from "@openrouter/sdk/models"; - -let value: BaseInputsRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputstype.mdx b/client-sdks/typescript/api-reference/models/baseinputstype.mdx deleted file mode 100644 index b9a1dadb..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputstype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: BaseInputsType - TypeScript SDK -sidebarTitle: BaseInputsType -description: BaseInputsType type definition -seoTitle: BaseInputsType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/baseinputstype' -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsType Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsType%20-%20TypeScript%20SDK&description=BaseInputsType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseInputsType } from "@openrouter/sdk/models"; - -let value: BaseInputsType = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsunion.mdx b/client-sdks/typescript/api-reference/models/baseinputsunion.mdx deleted file mode 100644 index 41fa83a2..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsunion.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: BaseInputsUnion - TypeScript SDK -sidebarTitle: BaseInputsUnion -description: BaseInputsUnion type definition -seoTitle: BaseInputsUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsunion -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsUnion type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion%20-%20TypeScript%20SDK&description=BaseInputsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.BaseInputsUnion1[]` - -```typescript lines -const value: models.BaseInputsUnion1[] = [ - { - content: "What is the weather today?", - role: "user", - }, -]; -``` - -### `any` - -```typescript lines -const value: any = [ - { - "content": "What is the weather today?", - "role": "user", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/baseinputsunion1.mdx b/client-sdks/typescript/api-reference/models/baseinputsunion1.mdx deleted file mode 100644 index cb8b02af..00000000 --- a/client-sdks/typescript/api-reference/models/baseinputsunion1.mdx +++ /dev/null @@ -1,149 +0,0 @@ ---- -title: BaseInputsUnion1 - TypeScript SDK -sidebarTitle: BaseInputsUnion1 -description: BaseInputsUnion1 type definition -seoTitle: BaseInputsUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/baseinputsunion1 -'og:site_name': OpenRouter Documentation -'og:title': BaseInputsUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - BaseInputsUnion1 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseInputsUnion1%20-%20TypeScript%20SDK&description=BaseInputsUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.BaseInputsMessage` - -```typescript lines -const value: models.BaseInputsMessage = { - content: "", - role: "user", -}; -``` - -### `models.OpenAIResponseInputMessageItem` - -```typescript lines -const value: models.OpenAIResponseInputMessageItem = { - content: [ - { - text: "Hello, how are you?", - type: "input_text", - }, - ], - id: "msg-abc123", - role: "user", -}; -``` - -### `models.OpenAIResponseFunctionToolCallOutput` - -```typescript lines -const value: models.OpenAIResponseFunctionToolCallOutput = { - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", - type: "function_call_output", -}; -``` - -### `models.OpenAIResponseFunctionToolCall` - -```typescript lines -const value: models.OpenAIResponseFunctionToolCall = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -### `models.OutputItemImageGenerationCall` - -```typescript lines -const value: models.OutputItemImageGenerationCall = { - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", - type: "image_generation_call", -}; -``` - -### `models.OutputMessage` - -```typescript lines -const value: models.OutputMessage = { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", -}; -``` - -### `models.OpenAIResponseCustomToolCall` - -```typescript lines -const value: models.OpenAIResponseCustomToolCall = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -### `models.OpenAIResponseCustomToolCallOutput` - -```typescript lines -const value: models.OpenAIResponseCustomToolCallOutput = { - callId: "call-abc123", - output: "patch applied successfully", - type: "custom_tool_call_output", -}; -``` - -### `models.ApplyPatchCallItem` - -```typescript lines -const value: models.ApplyPatchCallItem = { - callId: "call_abc123", - operation: { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", - }, - status: "completed", - type: "apply_patch_call", -}; -``` - -### `models.ApplyPatchCallOutputItem` - -```typescript lines -const value: models.ApplyPatchCallOutputItem = { - callId: "call_abc123", - status: "completed", - type: "apply_patch_call_output", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/basereasoningconfig.mdx b/client-sdks/typescript/api-reference/models/basereasoningconfig.mdx deleted file mode 100644 index 30abd07d..00000000 --- a/client-sdks/typescript/api-reference/models/basereasoningconfig.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BaseReasoningConfig - TypeScript SDK -sidebarTitle: BaseReasoningConfig -description: BaseReasoningConfig type definition -seoTitle: BaseReasoningConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/basereasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': BaseReasoningConfig Type | OpenRouter TypeScript SDK -'og:description': >- - BaseReasoningConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BaseReasoningConfig%20-%20TypeScript%20SDK&description=BaseReasoningConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BaseReasoningConfig } from "@openrouter/sdk/models"; - -let value: BaseReasoningConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `effort` | [models.ReasoningEffort](/client-sdks/typescript/api-reference/models/reasoningeffort) | :heavy_minus_sign: | N/A | medium | -| `summary` | [models.ReasoningSummaryVerbosity](/client-sdks/typescript/api-reference/models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersrequest.mdx b/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index bf99842e..00000000 --- a/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - TypeScript SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest type definition -seoTitle: BulkAddWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAddWorkspaceMembersRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20TypeScript%20SDK&description=BulkAddWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAddWorkspaceMembersRequest } from "@openrouter/sdk/models"; - -let value: BulkAddWorkspaceMembersRequest = { - userIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `userIds` | *string*[] | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersresponse.mdx b/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersresponse.mdx deleted file mode 100644 index 30ce15c0..00000000 --- a/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersresponse.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BulkAddWorkspaceMembersResponse - TypeScript SDK -sidebarTitle: BulkAddWorkspaceMembersResponse -description: BulkAddWorkspaceMembersResponse type definition -seoTitle: BulkAddWorkspaceMembersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkaddworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAddWorkspaceMembersResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersResponse%20-%20TypeScript%20SDK&description=BulkAddWorkspaceMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAddWorkspaceMembersResponse } from "@openrouter/sdk/models"; - -let value: BulkAddWorkspaceMembersResponse = { - addedCount: 1, - data: [ - { - createdAt: "2025-08-24T10:30:00Z", - id: "660e8400-e29b-41d4-a716-446655440000", - role: "member", - userId: "user_abc123", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `addedCount` | *number* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `data` | [models.WorkspaceMember](/client-sdks/typescript/api-reference/models/workspacemember)[] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkassignkeysrequest.mdx b/client-sdks/typescript/api-reference/models/bulkassignkeysrequest.mdx deleted file mode 100644 index 66e31869..00000000 --- a/client-sdks/typescript/api-reference/models/bulkassignkeysrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BulkAssignKeysRequest - TypeScript SDK -sidebarTitle: BulkAssignKeysRequest -description: BulkAssignKeysRequest type definition -seoTitle: BulkAssignKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkassignkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysRequest%20-%20TypeScript%20SDK&description=BulkAssignKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysRequest } from "@openrouter/sdk/models"; - -let value: BulkAssignKeysRequest = { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkassignkeysresponse.mdx b/client-sdks/typescript/api-reference/models/bulkassignkeysresponse.mdx deleted file mode 100644 index 5ecd3f8f..00000000 --- a/client-sdks/typescript/api-reference/models/bulkassignkeysresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkAssignKeysResponse - TypeScript SDK -sidebarTitle: BulkAssignKeysResponse -description: BulkAssignKeysResponse type definition -seoTitle: BulkAssignKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkassignkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysResponse%20-%20TypeScript%20SDK&description=BulkAssignKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysResponse } from "@openrouter/sdk/models"; - -let value: BulkAssignKeysResponse = { - assignedCount: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assignedCount` | *number* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkassignmembersrequest.mdx b/client-sdks/typescript/api-reference/models/bulkassignmembersrequest.mdx deleted file mode 100644 index 9015d478..00000000 --- a/client-sdks/typescript/api-reference/models/bulkassignmembersrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkAssignMembersRequest - TypeScript SDK -sidebarTitle: BulkAssignMembersRequest -description: BulkAssignMembersRequest type definition -seoTitle: BulkAssignMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersRequest%20-%20TypeScript%20SDK&description=BulkAssignMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersRequest } from "@openrouter/sdk/models"; - -let value: BulkAssignMembersRequest = { - memberUserIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkassignmembersresponse.mdx b/client-sdks/typescript/api-reference/models/bulkassignmembersresponse.mdx deleted file mode 100644 index afd9601a..00000000 --- a/client-sdks/typescript/api-reference/models/bulkassignmembersresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkAssignMembersResponse - TypeScript SDK -sidebarTitle: BulkAssignMembersResponse -description: BulkAssignMembersResponse type definition -seoTitle: BulkAssignMembersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersResponse%20-%20TypeScript%20SDK&description=BulkAssignMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersResponse } from "@openrouter/sdk/models"; - -let value: BulkAssignMembersResponse = { - assignedCount: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assignedCount` | *number* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersrequest.mdx b/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index e3d4b67e..00000000 --- a/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - TypeScript SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest type definition -seoTitle: BulkRemoveWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20TypeScript%20SDK&description=BulkRemoveWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkRemoveWorkspaceMembersRequest } from "@openrouter/sdk/models"; - -let value: BulkRemoveWorkspaceMembersRequest = { - userIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `userIds` | *string*[] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersresponse.mdx b/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersresponse.mdx deleted file mode 100644 index 6e26d5b5..00000000 --- a/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersResponse - TypeScript SDK -sidebarTitle: BulkRemoveWorkspaceMembersResponse -description: BulkRemoveWorkspaceMembersResponse type definition -seoTitle: BulkRemoveWorkspaceMembersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkremoveworkspacemembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkRemoveWorkspaceMembersResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersResponse%20-%20TypeScript%20SDK&description=BulkRemoveWorkspaceMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkRemoveWorkspaceMembersResponse } from "@openrouter/sdk/models"; - -let value: BulkRemoveWorkspaceMembersResponse = { - removedCount: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `removedCount` | *number* | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkunassignkeysrequest.mdx b/client-sdks/typescript/api-reference/models/bulkunassignkeysrequest.mdx deleted file mode 100644 index 1a86e4ab..00000000 --- a/client-sdks/typescript/api-reference/models/bulkunassignkeysrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BulkUnassignKeysRequest - TypeScript SDK -sidebarTitle: BulkUnassignKeysRequest -description: BulkUnassignKeysRequest type definition -seoTitle: BulkUnassignKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkunassignkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysRequest%20-%20TypeScript%20SDK&description=BulkUnassignKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysRequest } from "@openrouter/sdk/models"; - -let value: BulkUnassignKeysRequest = { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkunassignkeysresponse.mdx b/client-sdks/typescript/api-reference/models/bulkunassignkeysresponse.mdx deleted file mode 100644 index d5e47f17..00000000 --- a/client-sdks/typescript/api-reference/models/bulkunassignkeysresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkUnassignKeysResponse - TypeScript SDK -sidebarTitle: BulkUnassignKeysResponse -description: BulkUnassignKeysResponse type definition -seoTitle: BulkUnassignKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkunassignkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysResponse%20-%20TypeScript%20SDK&description=BulkUnassignKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysResponse } from "@openrouter/sdk/models"; - -let value: BulkUnassignKeysResponse = { - unassignedCount: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkunassignmembersrequest.mdx b/client-sdks/typescript/api-reference/models/bulkunassignmembersrequest.mdx deleted file mode 100644 index 1f427375..00000000 --- a/client-sdks/typescript/api-reference/models/bulkunassignmembersrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkUnassignMembersRequest - TypeScript SDK -sidebarTitle: BulkUnassignMembersRequest -description: BulkUnassignMembersRequest type definition -seoTitle: BulkUnassignMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkunassignmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersRequest%20-%20TypeScript%20SDK&description=BulkUnassignMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersRequest } from "@openrouter/sdk/models"; - -let value: BulkUnassignMembersRequest = { - memberUserIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/bulkunassignmembersresponse.mdx b/client-sdks/typescript/api-reference/models/bulkunassignmembersresponse.mdx deleted file mode 100644 index 14f57095..00000000 --- a/client-sdks/typescript/api-reference/models/bulkunassignmembersresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkUnassignMembersResponse - TypeScript SDK -sidebarTitle: BulkUnassignMembersResponse -description: BulkUnassignMembersResponse type definition -seoTitle: BulkUnassignMembersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/bulkunassignmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersResponse%20-%20TypeScript%20SDK&description=BulkUnassignMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersResponse } from "@openrouter/sdk/models"; - -let value: BulkUnassignMembersResponse = { - unassignedCount: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/by.mdx b/client-sdks/typescript/api-reference/models/by.mdx deleted file mode 100644 index e803cca3..00000000 --- a/client-sdks/typescript/api-reference/models/by.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: By - TypeScript SDK -sidebarTitle: By -description: By type definition -seoTitle: By Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/by' -'og:site_name': OpenRouter Documentation -'og:title': By Type | OpenRouter TypeScript SDK -'og:description': >- - By type reference for the OpenRouter TypeScript SDK. Complete type definition - and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=By%20-%20TypeScript%20SDK&description=By%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Example Usage - -```typescript lines -import { By } from "@openrouter/sdk/models"; - -let value: By = "price"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"price" | "throughput" | "latency" | "exacto" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/byokkey.mdx b/client-sdks/typescript/api-reference/models/byokkey.mdx deleted file mode 100644 index 2a265ab0..00000000 --- a/client-sdks/typescript/api-reference/models/byokkey.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: BYOKKey - TypeScript SDK -sidebarTitle: BYOKKey -description: BYOKKey type definition -seoTitle: BYOKKey Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/byokkey' -'og:site_name': OpenRouter Documentation -'og:title': BYOKKey Type | OpenRouter TypeScript SDK -'og:description': >- - BYOKKey type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKKey%20-%20TypeScript%20SDK&description=BYOKKey%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BYOKKey } from "@openrouter/sdk/models"; - -let value: BYOKKey = { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `allowedApiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowedModels` | *string*[] | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowedUserIds` | *string*[] | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `disabled` | *boolean* | :heavy_check_mark: | Whether this credential is currently disabled. | false | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `isFallback` | *boolean* | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false | -| `label` | *string* | :heavy_check_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](/client-sdks/typescript/api-reference/models/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `sortOrder` | *number* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this credential belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/byokproviderslug.mdx b/client-sdks/typescript/api-reference/models/byokproviderslug.mdx deleted file mode 100644 index 6eef43aa..00000000 --- a/client-sdks/typescript/api-reference/models/byokproviderslug.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BYOKProviderSlug - TypeScript SDK -sidebarTitle: BYOKProviderSlug -description: BYOKProviderSlug type definition -seoTitle: BYOKProviderSlug Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/byokproviderslug -'og:site_name': OpenRouter Documentation -'og:title': BYOKProviderSlug Type | OpenRouter TypeScript SDK -'og:description': >- - BYOKProviderSlug type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BYOKProviderSlug%20-%20TypeScript%20SDK&description=BYOKProviderSlug%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Example Usage - -```typescript lines -import { BYOKProviderSlug } from "@openrouter/sdk/models"; - -let value: BYOKProviderSlug = "openai"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"ai21" | "aion-labs" | "akashml" | "alibaba" | "amazon-bedrock" | "amazon-nova" | "ambient" | "anthropic" | "arcee-ai" | "atlas-cloud" | "avian" | "azure" | "baidu" | "baseten" | "black-forest-labs" | "byteplus" | "cerebras" | "chutes" | "cirrascale" | "clarifai" | "cloudflare" | "cohere" | "crusoe" | "darkbloom" | "deepinfra" | "deepseek" | "dekallm" | "digitalocean" | "featherless" | "fireworks" | "friendli" | "gmicloud" | "google-ai-studio" | "google-vertex" | "groq" | "hyperbolic" | "inception" | "inceptron" | "inference-net" | "infermatic" | "inflection" | "io-net" | "ionstream" | "liquid" | "mancer" | "mara" | "minimax" | "mistral" | "modelrun" | "modular" | "moonshotai" | "morph" | "ncompass" | "nebius" | "nex-agi" | "nextbit" | "novita" | "nvidia" | "open-inference" | "openai" | "parasail" | "perceptron" | "perplexity" | "phala" | "poolside" | "recraft" | "reka" | "relace" | "sambanova" | "seed" | "siliconflow" | "sourceful" | "stepfun" | "streamlake" | "switchpoint" | "together" | "upstage" | "venice" | "wandb" | "xai" | "xiaomi" | "z-ai" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/caching.mdx b/client-sdks/typescript/api-reference/models/caching.mdx deleted file mode 100644 index 33b46486..00000000 --- a/client-sdks/typescript/api-reference/models/caching.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Caching - TypeScript SDK -sidebarTitle: Caching -description: Caching type definition -seoTitle: Caching Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/caching' -'og:site_name': OpenRouter Documentation -'og:title': Caching Type | OpenRouter TypeScript SDK -'og:description': >- - Caching type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Caching%20-%20TypeScript%20SDK&description=Caching%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. Currently supported for Anthropic Claude models. - -## Example Usage - -```typescript lines -import { Caching } from "@openrouter/sdk/models"; - -let value: Caching = { - type: "ephemeral", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `ttl` | [models.AnthropicCacheControlTtl](/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.ToolTypeEphemeral](/client-sdks/typescript/api-reference/models/tooltypeephemeral) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatassistantimages.mdx b/client-sdks/typescript/api-reference/models/chatassistantimages.mdx deleted file mode 100644 index 31483214..00000000 --- a/client-sdks/typescript/api-reference/models/chatassistantimages.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatAssistantImages - TypeScript SDK -sidebarTitle: ChatAssistantImages -description: ChatAssistantImages type definition -seoTitle: ChatAssistantImages Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatassistantimages -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImages Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAssistantImages type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImages%20-%20TypeScript%20SDK&description=ChatAssistantImages%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatAssistantImages } from "@openrouter/sdk/models"; - -let value: ChatAssistantImages = { - imageUrl: { - url: "https://colorful-brochure.net", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatAssistantImagesImageUrl](/client-sdks/typescript/api-reference/models/chatassistantimagesimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatassistantimagesimageurl.mdx b/client-sdks/typescript/api-reference/models/chatassistantimagesimageurl.mdx deleted file mode 100644 index 171de3c3..00000000 --- a/client-sdks/typescript/api-reference/models/chatassistantimagesimageurl.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatAssistantImagesImageUrl - TypeScript SDK -sidebarTitle: ChatAssistantImagesImageUrl -description: ChatAssistantImagesImageUrl type definition -seoTitle: ChatAssistantImagesImageUrl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatassistantimagesimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantImagesImageUrl Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAssistantImagesImageUrl type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantImagesImageUrl%20-%20TypeScript%20SDK&description=ChatAssistantImagesImageUrl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatAssistantImagesImageUrl } from "@openrouter/sdk/models"; - -let value: ChatAssistantImagesImageUrl = { - url: "https://late-pleasure.org/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `url` | *string* | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatassistantmessage.mdx b/client-sdks/typescript/api-reference/models/chatassistantmessage.mdx deleted file mode 100644 index 0780f865..00000000 --- a/client-sdks/typescript/api-reference/models/chatassistantmessage.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatAssistantMessage - TypeScript SDK -sidebarTitle: ChatAssistantMessage -description: ChatAssistantMessage type definition -seoTitle: ChatAssistantMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatassistantmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAssistantMessage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessage%20-%20TypeScript%20SDK&description=ChatAssistantMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Assistant message for requests and responses - -## Example Usage - -```typescript lines -import { ChatAssistantMessage } from "@openrouter/sdk/models"; - -let value: ChatAssistantMessage = { - role: "assistant", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](/client-sdks/typescript/api-reference/models/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` | *models.ChatAssistantMessageContent* | :heavy_minus_sign: | Assistant message content | | -| `images` | [models.ChatAssistantImages](/client-sdks/typescript/api-reference/models/chatassistantimages)[] | :heavy_minus_sign: | Generated images from image generation models | [
`{"image_url": {"url": "data:image/png;base64,iVBORw0KGgo..."}`
\}
] | -| `name` | *string* | :heavy_minus_sign: | Optional name for the assistant | | -| `reasoning` | *string* | :heavy_minus_sign: | Reasoning output | | -| `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"thinking": "Let me work through this step by step...","type": "thinking"}`
] | -| `refusal` | *string* | :heavy_minus_sign: | Refusal message if content was refused | | -| `role` | [models.ChatAssistantMessageRole](/client-sdks/typescript/api-reference/models/chatassistantmessagerole) | :heavy_check_mark: | N/A | | -| `toolCalls` | [models.ChatToolCall](/client-sdks/typescript/api-reference/models/chattoolcall)[] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatassistantmessagecontent.mdx b/client-sdks/typescript/api-reference/models/chatassistantmessagecontent.mdx deleted file mode 100644 index 75df5e53..00000000 --- a/client-sdks/typescript/api-reference/models/chatassistantmessagecontent.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: ChatAssistantMessageContent - TypeScript SDK -sidebarTitle: ChatAssistantMessageContent -description: ChatAssistantMessageContent type definition -seoTitle: ChatAssistantMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatassistantmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAssistantMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageContent%20-%20TypeScript%20SDK&description=ChatAssistantMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Assistant message content - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatContentItems[]` - -```typescript lines -const value: models.ChatContentItems[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatassistantmessagerole.mdx b/client-sdks/typescript/api-reference/models/chatassistantmessagerole.mdx deleted file mode 100644 index cfed6137..00000000 --- a/client-sdks/typescript/api-reference/models/chatassistantmessagerole.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatAssistantMessageRole - TypeScript SDK -sidebarTitle: ChatAssistantMessageRole -description: ChatAssistantMessageRole type definition -seoTitle: ChatAssistantMessageRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatassistantmessagerole -'og:site_name': OpenRouter Documentation -'og:title': ChatAssistantMessageRole Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAssistantMessageRole type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAssistantMessageRole%20-%20TypeScript%20SDK&description=ChatAssistantMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatAssistantMessageRole } from "@openrouter/sdk/models"; - -let value: ChatAssistantMessageRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chataudiooutput.mdx b/client-sdks/typescript/api-reference/models/chataudiooutput.mdx deleted file mode 100644 index 8d22749d..00000000 --- a/client-sdks/typescript/api-reference/models/chataudiooutput.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatAudioOutput - TypeScript SDK -sidebarTitle: ChatAudioOutput -description: ChatAudioOutput type definition -seoTitle: ChatAudioOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chataudiooutput -'og:site_name': OpenRouter Documentation -'og:title': ChatAudioOutput Type | OpenRouter TypeScript SDK -'og:description': >- - ChatAudioOutput type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatAudioOutput%20-%20TypeScript%20SDK&description=ChatAudioOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Audio output data or reference - -## Example Usage - -```typescript lines -import { ChatAudioOutput } from "@openrouter/sdk/models"; - -let value: ChatAudioOutput = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `data` | *string* | :heavy_minus_sign: | Base64 encoded audio data | -| `expiresAt` | *number* | :heavy_minus_sign: | Audio expiration timestamp | -| `id` | *string* | :heavy_minus_sign: | Audio output identifier | -| `transcript` | *string* | :heavy_minus_sign: | Audio transcript | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatchoice.mdx b/client-sdks/typescript/api-reference/models/chatchoice.mdx deleted file mode 100644 index ed9212a3..00000000 --- a/client-sdks/typescript/api-reference/models/chatchoice.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ChatChoice - TypeScript SDK -sidebarTitle: ChatChoice -description: ChatChoice type definition -seoTitle: ChatChoice Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chatchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ChatChoice type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatChoice%20-%20TypeScript%20SDK&description=ChatChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Chat completion choice - -## Example Usage - -```typescript lines -import { ChatChoice } from "@openrouter/sdk/models"; - -let value: ChatChoice = { - finishReason: "stop", - index: 0, - message: { - role: "assistant", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finishReason` | [models.ChatFinishReasonEnum](/client-sdks/typescript/api-reference/models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | -| `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](/client-sdks/typescript/api-reference/models/chattokenlogprobs) | :heavy_minus_sign: | Log probabilities for the completion | `{"content": [{"bytes": null,"logprob": -0.612345,"token": " Hello","top_logprobs": []}`
],
"refusal": `null
`\} | -| `message` | [models.ChatAssistantMessage](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/chatcontentaudio.mdx b/client-sdks/typescript/api-reference/models/chatcontentaudio.mdx deleted file mode 100644 index 6d2bf464..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentaudio.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ChatContentAudio - TypeScript SDK -sidebarTitle: ChatContentAudio -description: ChatContentAudio type definition -seoTitle: ChatContentAudio Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudio Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentAudio type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudio%20-%20TypeScript%20SDK&description=ChatContentAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Audio input content part. Supported audio formats vary by provider. - -## Example Usage - -```typescript lines -import { ChatContentAudio } from "@openrouter/sdk/models"; - -let value: ChatContentAudio = { - inputAudio: { - data: "", - format: "", - }, - type: "input_audio", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `inputAudio` | [models.ChatContentAudioInputAudio](/client-sdks/typescript/api-reference/models/chatcontentaudioinputaudio) | :heavy_check_mark: | N/A | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentaudioinputaudio.mdx b/client-sdks/typescript/api-reference/models/chatcontentaudioinputaudio.mdx deleted file mode 100644 index 2928f6c5..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentaudioinputaudio.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatContentAudioInputAudio - TypeScript SDK -sidebarTitle: ChatContentAudioInputAudio -description: ChatContentAudioInputAudio type definition -seoTitle: ChatContentAudioInputAudio Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatContentAudioInputAudio Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentAudioInputAudio type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentAudioInputAudio%20-%20TypeScript%20SDK&description=ChatContentAudioInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatContentAudioInputAudio } from "@openrouter/sdk/models"; - -let value: ChatContentAudioInputAudio = { - data: "", - format: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | Base64 encoded audio data | -| `format` | *string* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentcachecontrol.mdx b/client-sdks/typescript/api-reference/models/chatcontentcachecontrol.mdx deleted file mode 100644 index af8b84e3..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentcachecontrol.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatContentCacheControl - TypeScript SDK -sidebarTitle: ChatContentCacheControl -description: ChatContentCacheControl type definition -seoTitle: ChatContentCacheControl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentcachecontrol -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControl Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentCacheControl type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControl%20-%20TypeScript%20SDK&description=ChatContentCacheControl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Cache control for the content part - -## Example Usage - -```typescript lines -import { ChatContentCacheControl } from "@openrouter/sdk/models"; - -let value: ChatContentCacheControl = { - type: "ephemeral", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ttl` | [models.AnthropicCacheControlTtl](/client-sdks/typescript/api-reference/models/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.ChatContentCacheControlType](/client-sdks/typescript/api-reference/models/chatcontentcachecontroltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentcachecontroltype.mdx b/client-sdks/typescript/api-reference/models/chatcontentcachecontroltype.mdx deleted file mode 100644 index 6f904161..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentcachecontroltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatContentCacheControlType - TypeScript SDK -sidebarTitle: ChatContentCacheControlType -description: ChatContentCacheControlType type definition -seoTitle: ChatContentCacheControlType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentcachecontroltype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentCacheControlType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentCacheControlType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentCacheControlType%20-%20TypeScript%20SDK&description=ChatContentCacheControlType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatContentCacheControlType } from "@openrouter/sdk/models"; - -let value: ChatContentCacheControlType = "ephemeral"; -``` - -## Values - -```typescript lines -"ephemeral" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentfile.mdx b/client-sdks/typescript/api-reference/models/chatcontentfile.mdx deleted file mode 100644 index b75d9c93..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentfile.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ChatContentFile - TypeScript SDK -sidebarTitle: ChatContentFile -description: ChatContentFile type definition -seoTitle: ChatContentFile Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentfile -'og:site_name': OpenRouter Documentation -'og:title': ChatContentFile Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentFile type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentFile%20-%20TypeScript%20SDK&description=ChatContentFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -File content part for document processing - -## Example Usage - -```typescript lines -import { ChatContentFile } from "@openrouter/sdk/models"; - -let value: ChatContentFile = { - file: {}, - type: "file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `file` | [models.FileT](/client-sdks/typescript/api-reference/models/filet) | :heavy_check_mark: | N/A | -| `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentimage.mdx b/client-sdks/typescript/api-reference/models/chatcontentimage.mdx deleted file mode 100644 index c5f629f8..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentimage.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatContentImage - TypeScript SDK -sidebarTitle: ChatContentImage -description: ChatContentImage type definition -seoTitle: ChatContentImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentimage -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentImage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImage%20-%20TypeScript%20SDK&description=ChatContentImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image content part for vision models - -## Example Usage - -```typescript lines -import { ChatContentImage } from "@openrouter/sdk/models"; - -let value: ChatContentImage = { - imageUrl: { - url: "https://vague-assist.org/", - }, - type: "image_url", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatContentImageImageUrl](/client-sdks/typescript/api-reference/models/chatcontentimageimageurl) | :heavy_check_mark: | N/A | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentimagedetail.mdx b/client-sdks/typescript/api-reference/models/chatcontentimagedetail.mdx deleted file mode 100644 index 1580ad8f..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentimagedetail.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatContentImageDetail - TypeScript SDK -sidebarTitle: ChatContentImageDetail -description: ChatContentImageDetail type definition -seoTitle: ChatContentImageDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentimagedetail -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageDetail Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentImageDetail type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageDetail%20-%20TypeScript%20SDK&description=ChatContentImageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image detail level for vision models - -## Example Usage - -```typescript lines -import { ChatContentImageDetail } from "@openrouter/sdk/models"; - -let value: ChatContentImageDetail = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "low" | "high" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentimageimageurl.mdx b/client-sdks/typescript/api-reference/models/chatcontentimageimageurl.mdx deleted file mode 100644 index 1ca4a20c..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentimageimageurl.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatContentImageImageUrl - TypeScript SDK -sidebarTitle: ChatContentImageImageUrl -description: ChatContentImageImageUrl type definition -seoTitle: ChatContentImageImageUrl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ChatContentImageImageUrl Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentImageImageUrl type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentImageImageUrl%20-%20TypeScript%20SDK&description=ChatContentImageImageUrl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatContentImageImageUrl } from "@openrouter/sdk/models"; - -let value: ChatContentImageImageUrl = { - url: "https://torn-knuckle.org/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.ChatContentImageDetail](/client-sdks/typescript/api-reference/models/chatcontentimagedetail) | :heavy_minus_sign: | Image detail level for vision models | -| `url` | *string* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentitems.mdx b/client-sdks/typescript/api-reference/models/chatcontentitems.mdx deleted file mode 100644 index efa0e852..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentitems.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: ChatContentItems - TypeScript SDK -sidebarTitle: ChatContentItems -description: ChatContentItems type definition -seoTitle: ChatContentItems Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentitems -'og:site_name': OpenRouter Documentation -'og:title': ChatContentItems Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentItems type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentItems%20-%20TypeScript%20SDK&description=ChatContentItems%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Content part for chat completion messages - -## Supported Types - -### `models.ChatContentFile` - -```typescript lines -const value: models.ChatContentFile = { - file: {}, - type: "file", -}; -``` - -### `models.ChatContentImage` - -```typescript lines -const value: models.ChatContentImage = { - imageUrl: { - url: "https://vague-assist.org/", - }, - type: "image_url", -}; -``` - -### `models.ChatContentAudio` - -```typescript lines -const value: models.ChatContentAudio = { - inputAudio: { - data: "", - format: "", - }, - type: "input_audio", -}; -``` - -### `models.LegacyChatContentVideo` - -```typescript lines -const value: models.LegacyChatContentVideo = { - type: "input_video", - videoUrl: { - url: "https://example.com/video.mp4", - }, -}; -``` - -### `models.ChatContentText` - -```typescript lines -const value: models.ChatContentText = { - text: "Hello, world!", - type: "text", -}; -``` - -### `models.ChatContentVideo` - -```typescript lines -const value: models.ChatContentVideo = { - type: "video_url", - videoUrl: { - url: "https://example.com/video.mp4", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontenttext.mdx b/client-sdks/typescript/api-reference/models/chatcontenttext.mdx deleted file mode 100644 index 20a69c58..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontenttext.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatContentText - TypeScript SDK -sidebarTitle: ChatContentText -description: ChatContentText type definition -seoTitle: ChatContentText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontenttext -'og:site_name': OpenRouter Documentation -'og:title': ChatContentText Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentText type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentText%20-%20TypeScript%20SDK&description=ChatContentText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text content part - -## Example Usage - -```typescript lines -import { ChatContentText } from "@openrouter/sdk/models"; - -let value: ChatContentText = { - text: "Hello, world!", - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](/client-sdks/typescript/api-reference/models/chatcontentcachecontrol) | :heavy_minus_sign: | Cache control for the content part | `{"ttl": "5m","type": "ephemeral"}` | -| `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.ChatContentTextType](/client-sdks/typescript/api-reference/models/chatcontenttexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontenttexttype.mdx b/client-sdks/typescript/api-reference/models/chatcontenttexttype.mdx deleted file mode 100644 index 666d5e58..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontenttexttype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatContentTextType - TypeScript SDK -sidebarTitle: ChatContentTextType -description: ChatContentTextType type definition -seoTitle: ChatContentTextType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontenttexttype -'og:site_name': OpenRouter Documentation -'og:title': ChatContentTextType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentTextType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentTextType%20-%20TypeScript%20SDK&description=ChatContentTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatContentTextType } from "@openrouter/sdk/models"; - -let value: ChatContentTextType = "text"; -``` - -## Values - -```typescript lines -"text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentvideo.mdx b/client-sdks/typescript/api-reference/models/chatcontentvideo.mdx deleted file mode 100644 index ad45b16d..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentvideo.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatContentVideo - TypeScript SDK -sidebarTitle: ChatContentVideo -description: ChatContentVideo type definition -seoTitle: ChatContentVideo Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentvideo -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideo Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentVideo type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideo%20-%20TypeScript%20SDK&description=ChatContentVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Video input content part - -## Example Usage - -```typescript lines -import { ChatContentVideo } from "@openrouter/sdk/models"; - -let value: ChatContentVideo = { - type: "video_url", - videoUrl: { - url: "https://example.com/video.mp4", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `type` | *"video_url"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.ChatContentVideoInput](/client-sdks/typescript/api-reference/models/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatcontentvideoinput.mdx b/client-sdks/typescript/api-reference/models/chatcontentvideoinput.mdx deleted file mode 100644 index 9cf7d222..00000000 --- a/client-sdks/typescript/api-reference/models/chatcontentvideoinput.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatContentVideoInput - TypeScript SDK -sidebarTitle: ChatContentVideoInput -description: ChatContentVideoInput type definition -seoTitle: ChatContentVideoInput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatcontentvideoinput -'og:site_name': OpenRouter Documentation -'og:title': ChatContentVideoInput Type | OpenRouter TypeScript SDK -'og:description': >- - ChatContentVideoInput type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatContentVideoInput%20-%20TypeScript%20SDK&description=ChatContentVideoInput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Video input object - -## Example Usage - -```typescript lines -import { ChatContentVideoInput } from "@openrouter/sdk/models"; - -let value: ChatContentVideoInput = { - url: "https://example.com/video.mp4", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `url` | *string* | :heavy_check_mark: | URL of the video (data: URLs supported) | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatdebugoptions.mdx b/client-sdks/typescript/api-reference/models/chatdebugoptions.mdx deleted file mode 100644 index d5f59730..00000000 --- a/client-sdks/typescript/api-reference/models/chatdebugoptions.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatDebugOptions - TypeScript SDK -sidebarTitle: ChatDebugOptions -description: ChatDebugOptions type definition -seoTitle: ChatDebugOptions Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatdebugoptions -'og:site_name': OpenRouter Documentation -'og:title': ChatDebugOptions Type | OpenRouter TypeScript SDK -'og:description': >- - ChatDebugOptions type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDebugOptions%20-%20TypeScript%20SDK&description=ChatDebugOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Debug options for inspecting request transformations (streaming only) - -## Example Usage - -```typescript lines -import { ChatDebugOptions } from "@openrouter/sdk/models"; - -let value: ChatDebugOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `echoUpstreamBody` | *boolean* | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatdevelopermessage.mdx b/client-sdks/typescript/api-reference/models/chatdevelopermessage.mdx deleted file mode 100644 index bf91cd9b..00000000 --- a/client-sdks/typescript/api-reference/models/chatdevelopermessage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatDeveloperMessage - TypeScript SDK -sidebarTitle: ChatDeveloperMessage -description: ChatDeveloperMessage type definition -seoTitle: ChatDeveloperMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatdevelopermessage -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatDeveloperMessage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessage%20-%20TypeScript%20SDK&description=ChatDeveloperMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Developer message - -## Example Usage - -```typescript lines -import { ChatDeveloperMessage } from "@openrouter/sdk/models"; - -let value: ChatDeveloperMessage = { - content: "What is the capital of France?", - role: "developer", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `content` | *models.ChatDeveloperMessageContent* | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `name` | *string* | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `role` | *"developer"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatdevelopermessagecontent.mdx b/client-sdks/typescript/api-reference/models/chatdevelopermessagecontent.mdx deleted file mode 100644 index 6cc3124e..00000000 --- a/client-sdks/typescript/api-reference/models/chatdevelopermessagecontent.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatDeveloperMessageContent - TypeScript SDK -sidebarTitle: ChatDeveloperMessageContent -description: ChatDeveloperMessageContent type definition -seoTitle: ChatDeveloperMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatdevelopermessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatDeveloperMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - ChatDeveloperMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatDeveloperMessageContent%20-%20TypeScript%20SDK&description=ChatDeveloperMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Developer message content - -## Supported Types - -### `string` - -```typescript lines -const value: string = "This is a message from the developer."; -``` - -### `models.ChatContentText[]` - -```typescript lines -const value: models.ChatContentText[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatfinishreasonenum.mdx b/client-sdks/typescript/api-reference/models/chatfinishreasonenum.mdx deleted file mode 100644 index 10168854..00000000 --- a/client-sdks/typescript/api-reference/models/chatfinishreasonenum.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatFinishReasonEnum - TypeScript SDK -sidebarTitle: ChatFinishReasonEnum -description: ChatFinishReasonEnum type definition -seoTitle: ChatFinishReasonEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatfinishreasonenum -'og:site_name': OpenRouter Documentation -'og:title': ChatFinishReasonEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFinishReasonEnum type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFinishReasonEnum%20-%20TypeScript%20SDK&description=ChatFinishReasonEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatFinishReasonEnum } from "@openrouter/sdk/models"; - -let value: ChatFinishReasonEnum = "stop"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"tool_calls" | "stop" | "length" | "content_filter" | "error" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatformatgrammarconfig.mdx b/client-sdks/typescript/api-reference/models/chatformatgrammarconfig.mdx deleted file mode 100644 index 2ef0a151..00000000 --- a/client-sdks/typescript/api-reference/models/chatformatgrammarconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ChatFormatGrammarConfig - TypeScript SDK -sidebarTitle: ChatFormatGrammarConfig -description: ChatFormatGrammarConfig type definition -seoTitle: ChatFormatGrammarConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatformatgrammarconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatGrammarConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFormatGrammarConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatGrammarConfig%20-%20TypeScript%20SDK&description=ChatFormatGrammarConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Custom grammar response format - -## Example Usage - -```typescript lines -import { ChatFormatGrammarConfig } from "@openrouter/sdk/models"; - -let value: ChatFormatGrammarConfig = { - grammar: "root ::= \"yes\" | \"no\"", - type: "grammar", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `grammar` | *string* | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `type` | *"grammar"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatformatjsonschemaconfig.mdx b/client-sdks/typescript/api-reference/models/chatformatjsonschemaconfig.mdx deleted file mode 100644 index 25cb5765..00000000 --- a/client-sdks/typescript/api-reference/models/chatformatjsonschemaconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatFormatJsonSchemaConfig - TypeScript SDK -sidebarTitle: ChatFormatJsonSchemaConfig -description: ChatFormatJsonSchemaConfig type definition -seoTitle: ChatFormatJsonSchemaConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatformatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatJsonSchemaConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFormatJsonSchemaConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatJsonSchemaConfig%20-%20TypeScript%20SDK&description=ChatFormatJsonSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON Schema response format for structured outputs - -## Example Usage - -```typescript lines -import { ChatFormatJsonSchemaConfig } from "@openrouter/sdk/models"; - -let value: ChatFormatJsonSchemaConfig = { - jsonSchema: { - name: "math_response", - }, - type: "json_schema", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `jsonSchema` | [models.ChatJsonSchemaConfig](/client-sdks/typescript/api-reference/models/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` | *"json_schema"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatformatpythonconfig.mdx b/client-sdks/typescript/api-reference/models/chatformatpythonconfig.mdx deleted file mode 100644 index f103501d..00000000 --- a/client-sdks/typescript/api-reference/models/chatformatpythonconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatFormatPythonConfig - TypeScript SDK -sidebarTitle: ChatFormatPythonConfig -description: ChatFormatPythonConfig type definition -seoTitle: ChatFormatPythonConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatformatpythonconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatPythonConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFormatPythonConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatPythonConfig%20-%20TypeScript%20SDK&description=ChatFormatPythonConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Python code response format - -## Example Usage - -```typescript lines -import { ChatFormatPythonConfig } from "@openrouter/sdk/models"; - -let value: ChatFormatPythonConfig = { - type: "python", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"python"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatformattextconfig.mdx b/client-sdks/typescript/api-reference/models/chatformattextconfig.mdx deleted file mode 100644 index 0d643ca6..00000000 --- a/client-sdks/typescript/api-reference/models/chatformattextconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatFormatTextConfig - TypeScript SDK -sidebarTitle: ChatFormatTextConfig -description: ChatFormatTextConfig type definition -seoTitle: ChatFormatTextConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatformattextconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatFormatTextConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFormatTextConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFormatTextConfig%20-%20TypeScript%20SDK&description=ChatFormatTextConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Default text response format - -## Example Usage - -```typescript lines -import { ChatFormatTextConfig } from "@openrouter/sdk/models"; - -let value: ChatFormatTextConfig = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatfunctiontool.mdx b/client-sdks/typescript/api-reference/models/chatfunctiontool.mdx deleted file mode 100644 index ba5a0a8b..00000000 --- a/client-sdks/typescript/api-reference/models/chatfunctiontool.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: ChatFunctionTool - TypeScript SDK -sidebarTitle: ChatFunctionTool -description: ChatFunctionTool type definition -seoTitle: ChatFunctionTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatfunctiontool -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionTool Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFunctionTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionTool%20-%20TypeScript%20SDK&description=ChatFunctionTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool definition for function calling (regular function or OpenRouter built-in server tool) - -## Supported Types - -### `models.ChatFunctionToolFunction` - -```typescript lines -const value: models.ChatFunctionToolFunction = { - function: { - name: "get_weather", - }, - type: "function", -}; -``` - -### `models.DatetimeServerTool` - -```typescript lines -const value: models.DatetimeServerTool = { - type: "openrouter:datetime", -}; -``` - -### `models.ImageGenerationServerToolOpenRouter` - -```typescript lines -const value: models.ImageGenerationServerToolOpenRouter = { - type: "openrouter:image_generation", -}; -``` - -### `models.ChatSearchModelsServerTool` - -```typescript lines -const value: models.ChatSearchModelsServerTool = { - type: "openrouter:experimental__search_models", -}; -``` - -### `models.WebFetchServerTool` - -```typescript lines -const value: models.WebFetchServerTool = { - type: "openrouter:web_fetch", -}; -``` - -### `models.OpenRouterWebSearchServerTool` - -```typescript lines -const value: models.OpenRouterWebSearchServerTool = { - type: "openrouter:web_search", -}; -``` - -### `models.ChatWebSearchShorthand` - -```typescript lines -const value: models.ChatWebSearchShorthand = { - type: "web_search", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatfunctiontoolfunction.mdx b/client-sdks/typescript/api-reference/models/chatfunctiontoolfunction.mdx deleted file mode 100644 index a0441f1d..00000000 --- a/client-sdks/typescript/api-reference/models/chatfunctiontoolfunction.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatFunctionToolFunction - TypeScript SDK -sidebarTitle: ChatFunctionToolFunction -description: ChatFunctionToolFunction type definition -seoTitle: ChatFunctionToolFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatfunctiontoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFunctionToolFunction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunction%20-%20TypeScript%20SDK&description=ChatFunctionToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatFunctionToolFunction } from "@openrouter/sdk/models"; - -let value: ChatFunctionToolFunction = { - function: { - name: "get_weather", - }, - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](/client-sdks/typescript/api-reference/models/chatcontentcachecontrol) | :heavy_minus_sign: | Cache control for the content part | `{"ttl": "5m","type": "ephemeral"}` | -| `function` | [models.ChatFunctionToolFunctionFunction](/client-sdks/typescript/api-reference/models/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` | [models.ChatFunctionToolType](/client-sdks/typescript/api-reference/models/chatfunctiontooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatfunctiontoolfunctionfunction.mdx b/client-sdks/typescript/api-reference/models/chatfunctiontoolfunctionfunction.mdx deleted file mode 100644 index f3c27096..00000000 --- a/client-sdks/typescript/api-reference/models/chatfunctiontoolfunctionfunction.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatFunctionToolFunctionFunction - TypeScript SDK -sidebarTitle: ChatFunctionToolFunctionFunction -description: ChatFunctionToolFunctionFunction type definition -seoTitle: ChatFunctionToolFunctionFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatfunctiontoolfunctionfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolFunctionFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFunctionToolFunctionFunction type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolFunctionFunction%20-%20TypeScript%20SDK&description=ChatFunctionToolFunctionFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function definition for tool calling - -## Example Usage - -```typescript lines -import { ChatFunctionToolFunctionFunction } from "@openrouter/sdk/models"; - -let value: ChatFunctionToolFunctionFunction = { - name: "get_weather", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `name` | *string* | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `parameters` | `Record` | :heavy_minus_sign: | Function parameters as JSON Schema object | `{"properties": {"location": {"description": "City name","type": "string"}`
\},
"required": [
"location"
],
"type": "object"
\} | -| `strict` | *boolean* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatfunctiontooltype.mdx b/client-sdks/typescript/api-reference/models/chatfunctiontooltype.mdx deleted file mode 100644 index 0383e7ae..00000000 --- a/client-sdks/typescript/api-reference/models/chatfunctiontooltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatFunctionToolType - TypeScript SDK -sidebarTitle: ChatFunctionToolType -description: ChatFunctionToolType type definition -seoTitle: ChatFunctionToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatfunctiontooltype -'og:site_name': OpenRouter Documentation -'og:title': ChatFunctionToolType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatFunctionToolType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatFunctionToolType%20-%20TypeScript%20SDK&description=ChatFunctionToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatFunctionToolType } from "@openrouter/sdk/models"; - -let value: ChatFunctionToolType = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatjsonschemaconfig.mdx b/client-sdks/typescript/api-reference/models/chatjsonschemaconfig.mdx deleted file mode 100644 index 5a21ae99..00000000 --- a/client-sdks/typescript/api-reference/models/chatjsonschemaconfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatJsonSchemaConfig - TypeScript SDK -sidebarTitle: ChatJsonSchemaConfig -description: ChatJsonSchemaConfig type definition -seoTitle: ChatJsonSchemaConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatJsonSchemaConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ChatJsonSchemaConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatJsonSchemaConfig%20-%20TypeScript%20SDK&description=ChatJsonSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON Schema configuration object - -## Example Usage - -```typescript lines -import { ChatJsonSchemaConfig } from "@openrouter/sdk/models"; - -let value: ChatJsonSchemaConfig = { - name: "math_response", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `description` | *string* | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `name` | *string* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `schema` | `Record` | :heavy_minus_sign: | JSON Schema object | `{"properties": {"answer": {"type": "number"}`
\},
"required": [
"answer"
],
"type": "object"
\} | -| `strict` | *boolean* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatmessages.mdx b/client-sdks/typescript/api-reference/models/chatmessages.mdx deleted file mode 100644 index b953ad06..00000000 --- a/client-sdks/typescript/api-reference/models/chatmessages.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: ChatMessages - TypeScript SDK -sidebarTitle: ChatMessages -description: ChatMessages type definition -seoTitle: ChatMessages Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chatmessages' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessages Type | OpenRouter TypeScript SDK -'og:description': >- - ChatMessages type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessages%20-%20TypeScript%20SDK&description=ChatMessages%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Chat completion message with role-based discrimination - -## Supported Types - -### `models.ChatAssistantMessage` - -```typescript lines -const value: models.ChatAssistantMessage = { - role: "assistant", -}; -``` - -### `models.ChatDeveloperMessage` - -```typescript lines -const value: models.ChatDeveloperMessage = { - content: "What is the capital of France?", - role: "developer", -}; -``` - -### `models.ChatSystemMessage` - -```typescript lines -const value: models.ChatSystemMessage = { - content: "What is the capital of France?", - role: "system", -}; -``` - -### `models.ChatToolMessage` - -```typescript lines -const value: models.ChatToolMessage = { - content: "What is the capital of France?", - role: "tool", - toolCallId: "call_abc123", -}; -``` - -### `models.ChatUserMessage` - -```typescript lines -const value: models.ChatUserMessage = { - content: "What is the capital of France?", - role: "user", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatnamedtoolchoice.mdx b/client-sdks/typescript/api-reference/models/chatnamedtoolchoice.mdx deleted file mode 100644 index 81309f51..00000000 --- a/client-sdks/typescript/api-reference/models/chatnamedtoolchoice.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatNamedToolChoice - TypeScript SDK -sidebarTitle: ChatNamedToolChoice -description: ChatNamedToolChoice type definition -seoTitle: ChatNamedToolChoice Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatnamedtoolchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ChatNamedToolChoice type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoice%20-%20TypeScript%20SDK&description=ChatNamedToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Named tool choice for specific function - -## Example Usage - -```typescript lines -import { ChatNamedToolChoice } from "@openrouter/sdk/models"; - -let value: ChatNamedToolChoice = { - function: { - name: "get_weather", - }, - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `function` | [models.ChatNamedToolChoiceFunction](/client-sdks/typescript/api-reference/models/chatnamedtoolchoicefunction) | :heavy_check_mark: | N/A | -| `type` | [models.ChatNamedToolChoiceType](/client-sdks/typescript/api-reference/models/chatnamedtoolchoicetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatnamedtoolchoicefunction.mdx b/client-sdks/typescript/api-reference/models/chatnamedtoolchoicefunction.mdx deleted file mode 100644 index a888f668..00000000 --- a/client-sdks/typescript/api-reference/models/chatnamedtoolchoicefunction.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatNamedToolChoiceFunction - TypeScript SDK -sidebarTitle: ChatNamedToolChoiceFunction -description: ChatNamedToolChoiceFunction type definition -seoTitle: ChatNamedToolChoiceFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatnamedtoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ChatNamedToolChoiceFunction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceFunction%20-%20TypeScript%20SDK&description=ChatNamedToolChoiceFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatNamedToolChoiceFunction } from "@openrouter/sdk/models"; - -let value: ChatNamedToolChoiceFunction = { - name: "get_weather", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatnamedtoolchoicetype.mdx b/client-sdks/typescript/api-reference/models/chatnamedtoolchoicetype.mdx deleted file mode 100644 index 08433209..00000000 --- a/client-sdks/typescript/api-reference/models/chatnamedtoolchoicetype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatNamedToolChoiceType - TypeScript SDK -sidebarTitle: ChatNamedToolChoiceType -description: ChatNamedToolChoiceType type definition -seoTitle: ChatNamedToolChoiceType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatnamedtoolchoicetype -'og:site_name': OpenRouter Documentation -'og:title': ChatNamedToolChoiceType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatNamedToolChoiceType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatNamedToolChoiceType%20-%20TypeScript%20SDK&description=ChatNamedToolChoiceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatNamedToolChoiceType } from "@openrouter/sdk/models"; - -let value: ChatNamedToolChoiceType = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatreasoningsummaryverbosityenum.mdx b/client-sdks/typescript/api-reference/models/chatreasoningsummaryverbosityenum.mdx deleted file mode 100644 index 4985fe36..00000000 --- a/client-sdks/typescript/api-reference/models/chatreasoningsummaryverbosityenum.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatReasoningSummaryVerbosityEnum - TypeScript SDK -sidebarTitle: ChatReasoningSummaryVerbosityEnum -description: ChatReasoningSummaryVerbosityEnum type definition -seoTitle: ChatReasoningSummaryVerbosityEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatreasoningsummaryverbosityenum -'og:site_name': OpenRouter Documentation -'og:title': ChatReasoningSummaryVerbosityEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ChatReasoningSummaryVerbosityEnum type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatReasoningSummaryVerbosityEnum%20-%20TypeScript%20SDK&description=ChatReasoningSummaryVerbosityEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatReasoningSummaryVerbosityEnum } from "@openrouter/sdk/models"; - -let value: ChatReasoningSummaryVerbosityEnum = "concise"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "concise" | "detailed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatrequest.mdx b/client-sdks/typescript/api-reference/models/chatrequest.mdx deleted file mode 100644 index 80aa5715..00000000 --- a/client-sdks/typescript/api-reference/models/chatrequest.mdx +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: ChatRequest - TypeScript SDK -sidebarTitle: ChatRequest -description: ChatRequest type definition -seoTitle: ChatRequest Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chatrequest' -'og:site_name': OpenRouter Documentation -'og:title': ChatRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ChatRequest type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequest%20-%20TypeScript%20SDK&description=ChatRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Chat completion request parameters - -## Example Usage - -```typescript lines -import { ChatRequest } from "@openrouter/sdk/models"; - -let value: ChatRequest = { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `debug` | [models.ChatDebugOptions](/client-sdks/typescript/api-reference/models/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | `{"echo_upstream_body": true}` | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `imageConfig` | `Record` | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | `{"aspect_ratio": "16:9","quality": "high"}` | -| `logitBias` | `Record` | :heavy_minus_sign: | Token logit bias adjustments | `{"50256": -100}` | -| `logprobs` | *boolean* | :heavy_minus_sign: | Return log probabilities | false | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `messages` | *models.ChatMessages*[] | :heavy_check_mark: | List of messages for the conversation | [
`{"content": "Hello!","role": "user"}`
] | -| `metadata` | `Record` | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | `{"session_id": "session-456","user_id": "user-123"}` | -| `modalities` | [models.Modality](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_minus_sign: | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | -| `plugins` | *models.ChatRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presencePenalty` | *number* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/api-reference/models/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [models.ChatRequestReasoning](/client-sdks/typescript/api-reference/models/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | `{"effort": "medium","summary": "concise"}` | -| `responseFormat` | *models.ResponseFormat* | :heavy_minus_sign: | Response format configuration | `{"type": "json_object"}` | -| `seed` | *number* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `serviceTier` | [models.ChatRequestServiceTier](/client-sdks/typescript/api-reference/models/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` | *models.Stop* | :heavy_minus_sign: | Stop sequences (up to 4) | [
""
] | -| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *boolean* | :heavy_minus_sign: | Enable streaming response | false | -| `streamOptions` | [models.ChatStreamOptions](/client-sdks/typescript/api-reference/models/chatstreamoptions) | :heavy_minus_sign: | Streaming configuration options | `{"include_usage": true}` | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `toolChoice` | *models.ChatToolChoice* | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | *models.ChatFunctionTool*[] | :heavy_minus_sign: | Available tools for function calling | [
`{"function": {"description": "Get weather","name": "get_weather"}`,
"type": "function"
\}
] | -| `topLogprobs` | *number* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [models.TraceConfig](/client-sdks/typescript/api-reference/models/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: | Unique user identifier | user-123 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatrequesteffort.mdx b/client-sdks/typescript/api-reference/models/chatrequesteffort.mdx deleted file mode 100644 index 2dbf21c9..00000000 --- a/client-sdks/typescript/api-reference/models/chatrequesteffort.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatRequestEffort - TypeScript SDK -sidebarTitle: ChatRequestEffort -description: ChatRequestEffort type definition -seoTitle: ChatRequestEffort Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatrequesteffort -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestEffort Type | OpenRouter TypeScript SDK -'og:description': >- - ChatRequestEffort type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestEffort%20-%20TypeScript%20SDK&description=ChatRequestEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Constrains effort on reasoning for reasoning models - -## Example Usage - -```typescript lines -import { ChatRequestEffort } from "@openrouter/sdk/models"; - -let value: ChatRequestEffort = "medium"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"xhigh" | "high" | "medium" | "low" | "minimal" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatrequestplugin.mdx b/client-sdks/typescript/api-reference/models/chatrequestplugin.mdx deleted file mode 100644 index 82ff33b1..00000000 --- a/client-sdks/typescript/api-reference/models/chatrequestplugin.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: ChatRequestPlugin - TypeScript SDK -sidebarTitle: ChatRequestPlugin -description: ChatRequestPlugin type definition -seoTitle: ChatRequestPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ChatRequestPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestPlugin%20-%20TypeScript%20SDK&description=ChatRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AutoRouterPlugin` - -```typescript lines -const value: models.AutoRouterPlugin = { - id: "auto-router", -}; -``` - -### `models.ContextCompressionPlugin` - -```typescript lines -const value: models.ContextCompressionPlugin = { - id: "context-compression", -}; -``` - -### `models.FileParserPlugin` - -```typescript lines -const value: models.FileParserPlugin = { - id: "file-parser", -}; -``` - -### `models.FusionPlugin` - -```typescript lines -const value: models.FusionPlugin = { - id: "fusion", -}; -``` - -### `models.ModerationPlugin` - -```typescript lines -const value: models.ModerationPlugin = { - id: "moderation", -}; -``` - -### `models.ParetoRouterPlugin` - -```typescript lines -const value: models.ParetoRouterPlugin = { - id: "pareto-router", -}; -``` - -### `models.ResponseHealingPlugin` - -```typescript lines -const value: models.ResponseHealingPlugin = { - id: "response-healing", -}; -``` - -### `models.WebSearchPlugin` - -```typescript lines -const value: models.WebSearchPlugin = { - id: "web", -}; -``` - -### `models.WebFetchPlugin` - -```typescript lines -const value: models.WebFetchPlugin = { - id: "web-fetch", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatrequestreasoning.mdx b/client-sdks/typescript/api-reference/models/chatrequestreasoning.mdx deleted file mode 100644 index 15e52e4f..00000000 --- a/client-sdks/typescript/api-reference/models/chatrequestreasoning.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatRequestReasoning - TypeScript SDK -sidebarTitle: ChatRequestReasoning -description: ChatRequestReasoning type definition -seoTitle: ChatRequestReasoning Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatrequestreasoning -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestReasoning Type | OpenRouter TypeScript SDK -'og:description': >- - ChatRequestReasoning type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestReasoning%20-%20TypeScript%20SDK&description=ChatRequestReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration options for reasoning models - -## Example Usage - -```typescript lines -import { ChatRequestReasoning } from "@openrouter/sdk/models"; - -let value: ChatRequestReasoning = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `effort` | [models.ChatRequestEffort](/client-sdks/typescript/api-reference/models/chatrequesteffort) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [models.ChatReasoningSummaryVerbosityEnum](/client-sdks/typescript/api-reference/models/chatreasoningsummaryverbosityenum) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatrequestservicetier.mdx b/client-sdks/typescript/api-reference/models/chatrequestservicetier.mdx deleted file mode 100644 index 19e5b6bf..00000000 --- a/client-sdks/typescript/api-reference/models/chatrequestservicetier.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatRequestServiceTier - TypeScript SDK -sidebarTitle: ChatRequestServiceTier -description: ChatRequestServiceTier type definition -seoTitle: ChatRequestServiceTier Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatrequestservicetier -'og:site_name': OpenRouter Documentation -'og:title': ChatRequestServiceTier Type | OpenRouter TypeScript SDK -'og:description': >- - ChatRequestServiceTier type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatRequestServiceTier%20-%20TypeScript%20SDK&description=ChatRequestServiceTier%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The service tier to use for processing this request. - -## Example Usage - -```typescript lines -import { ChatRequestServiceTier } from "@openrouter/sdk/models"; - -let value: ChatRequestServiceTier = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "default" | "flex" | "priority" | "scale" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatresult.mdx b/client-sdks/typescript/api-reference/models/chatresult.mdx deleted file mode 100644 index 35137d04..00000000 --- a/client-sdks/typescript/api-reference/models/chatresult.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: ChatResult - TypeScript SDK -sidebarTitle: ChatResult -description: ChatResult type definition -seoTitle: ChatResult Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chatresult' -'og:site_name': OpenRouter Documentation -'og:title': ChatResult Type | OpenRouter TypeScript SDK -'og:description': >- - ChatResult type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResult%20-%20TypeScript%20SDK&description=ChatResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Chat completion response - -## Example Usage - -```typescript lines -import { ChatResult } from "@openrouter/sdk/models"; - -let value: ChatResult = { - choices: [ - { - finishReason: "stop", - index: 0, - message: { - role: "assistant", - }, - }, - ], - created: 1677652288, - id: "chatcmpl-123", - model: "openai/gpt-4", - object: "chat.completion", - systemFingerprint: "fp_44709d6fcb", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatChoice](/client-sdks/typescript/api-reference/models/chatchoice)[] | :heavy_check_mark: | List of completion choices | | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `id` | *string* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | -| `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatResultObject](/client-sdks/typescript/api-reference/models/chatresultobject) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `systemFingerprint` | *string* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](/client-sdks/typescript/api-reference/models/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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatresultobject.mdx b/client-sdks/typescript/api-reference/models/chatresultobject.mdx deleted file mode 100644 index b10263ad..00000000 --- a/client-sdks/typescript/api-reference/models/chatresultobject.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatResultObject - TypeScript SDK -sidebarTitle: ChatResultObject -description: ChatResultObject type definition -seoTitle: ChatResultObject Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatresultobject -'og:site_name': OpenRouter Documentation -'og:title': ChatResultObject Type | OpenRouter TypeScript SDK -'og:description': >- - ChatResultObject type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResultObject%20-%20TypeScript%20SDK&description=ChatResultObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatResultObject } from "@openrouter/sdk/models"; - -let value: ChatResultObject = "chat.completion"; -``` - -## Values - -```typescript lines -"chat.completion" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatsearchmodelsservertool.mdx b/client-sdks/typescript/api-reference/models/chatsearchmodelsservertool.mdx deleted file mode 100644 index 30ad73bf..00000000 --- a/client-sdks/typescript/api-reference/models/chatsearchmodelsservertool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatSearchModelsServerTool - TypeScript SDK -sidebarTitle: ChatSearchModelsServerTool -description: ChatSearchModelsServerTool type definition -seoTitle: ChatSearchModelsServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatsearchmodelsservertool -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - ChatSearchModelsServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerTool%20-%20TypeScript%20SDK&description=ChatSearchModelsServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches and filters AI models available on OpenRouter - -## Example Usage - -```typescript lines -import { ChatSearchModelsServerTool } from "@openrouter/sdk/models"; - -let value: ChatSearchModelsServerTool = { - type: "openrouter:experimental__search_models", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `parameters` | [models.SearchModelsServerToolConfig](/client-sdks/typescript/api-reference/models/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | `{"max_results": 5}` | -| `type` | [models.ChatSearchModelsServerToolType](/client-sdks/typescript/api-reference/models/chatsearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatsearchmodelsservertooltype.mdx b/client-sdks/typescript/api-reference/models/chatsearchmodelsservertooltype.mdx deleted file mode 100644 index 0cc9e112..00000000 --- a/client-sdks/typescript/api-reference/models/chatsearchmodelsservertooltype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatSearchModelsServerToolType - TypeScript SDK -sidebarTitle: ChatSearchModelsServerToolType -description: ChatSearchModelsServerToolType type definition -seoTitle: ChatSearchModelsServerToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatsearchmodelsservertooltype -'og:site_name': OpenRouter Documentation -'og:title': ChatSearchModelsServerToolType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatSearchModelsServerToolType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSearchModelsServerToolType%20-%20TypeScript%20SDK&description=ChatSearchModelsServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatSearchModelsServerToolType } from "@openrouter/sdk/models"; - -let value: ChatSearchModelsServerToolType = - "openrouter:experimental__search_models"; -``` - -## Values - -```typescript lines -"openrouter:experimental__search_models" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatservertoolchoice.mdx b/client-sdks/typescript/api-reference/models/chatservertoolchoice.mdx deleted file mode 100644 index 9a2cd3a5..00000000 --- a/client-sdks/typescript/api-reference/models/chatservertoolchoice.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatServerToolChoice - TypeScript SDK -sidebarTitle: ChatServerToolChoice -description: ChatServerToolChoice type definition -seoTitle: ChatServerToolChoice Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatservertoolchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatServerToolChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ChatServerToolChoice type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatServerToolChoice%20-%20TypeScript%20SDK&description=ChatServerToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter extension: force a specific server tool by naming it directly in `tool_choice.type` instead of wrapping it in `{ type: "function", function: { name } }`. - -## Example Usage - -```typescript lines -import { ChatServerToolChoice } from "@openrouter/sdk/models"; - -let value: ChatServerToolChoice = { - type: "openrouter:web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamchoice.mdx b/client-sdks/typescript/api-reference/models/chatstreamchoice.mdx deleted file mode 100644 index 9c58c4ed..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamchoice.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ChatStreamChoice - TypeScript SDK -sidebarTitle: ChatStreamChoice -description: ChatStreamChoice type definition -seoTitle: ChatStreamChoice Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamchoice -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamChoice type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChoice%20-%20TypeScript%20SDK&description=ChatStreamChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Streaming completion choice chunk - -## Example Usage - -```typescript lines -import { ChatStreamChoice } from "@openrouter/sdk/models"; - -let value: ChatStreamChoice = { - delta: {}, - finishReason: null, - index: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [models.ChatStreamDelta](/client-sdks/typescript/api-reference/models/chatstreamdelta) | :heavy_check_mark: | Delta changes in streaming response | `{"content": "Hello","role": "assistant"}` | -| `finishReason` | [models.ChatFinishReasonEnum](/client-sdks/typescript/api-reference/models/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | -| `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/chatstreamchunk.mdx b/client-sdks/typescript/api-reference/models/chatstreamchunk.mdx deleted file mode 100644 index c8ea649c..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamchunk.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ChatStreamChunk - TypeScript SDK -sidebarTitle: ChatStreamChunk -description: ChatStreamChunk type definition -seoTitle: ChatStreamChunk Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamchunk -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunk Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamChunk type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunk%20-%20TypeScript%20SDK&description=ChatStreamChunk%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Streaming chat completion chunk - -## Example Usage - -```typescript lines -import { ChatStreamChunk } from "@openrouter/sdk/models"; - -let value: ChatStreamChunk = { - choices: [ - { - delta: {}, - finishReason: null, - index: 0, - }, - ], - created: 1677652288, - id: "chatcmpl-123", - model: "openai/gpt-4", - object: "chat.completion.chunk", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatStreamChoice](/client-sdks/typescript/api-reference/models/chatstreamchoice)[] | :heavy_check_mark: | List of streaming chunk choices | | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `error` | [models.ErrorT](/client-sdks/typescript/api-reference/models/errort) | :heavy_minus_sign: | Error information | `{"code": 429,"message": "Rate limit exceeded"}` | -| `id` | *string* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | -| `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatStreamChunkObject](/client-sdks/typescript/api-reference/models/chatstreamchunkobject) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `systemFingerprint` | *string* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](/client-sdks/typescript/api-reference/models/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}`,
"total_tokens": `25
`\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamchunkobject.mdx b/client-sdks/typescript/api-reference/models/chatstreamchunkobject.mdx deleted file mode 100644 index 37c8be02..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamchunkobject.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatStreamChunkObject - TypeScript SDK -sidebarTitle: ChatStreamChunkObject -description: ChatStreamChunkObject type definition -seoTitle: ChatStreamChunkObject Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamchunkobject -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamChunkObject Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamChunkObject type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamChunkObject%20-%20TypeScript%20SDK&description=ChatStreamChunkObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamChunkObject } from "@openrouter/sdk/models"; - -let value: ChatStreamChunkObject = "chat.completion.chunk"; -``` - -## Values - -```typescript lines -"chat.completion.chunk" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamdelta.mdx b/client-sdks/typescript/api-reference/models/chatstreamdelta.mdx deleted file mode 100644 index 31912f10..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamdelta.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatStreamDelta - TypeScript SDK -sidebarTitle: ChatStreamDelta -description: ChatStreamDelta type definition -seoTitle: ChatStreamDelta Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamdelta -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDelta Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamDelta type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDelta%20-%20TypeScript%20SDK&description=ChatStreamDelta%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Delta changes in streaming response - -## Example Usage - -```typescript lines -import { ChatStreamDelta } from "@openrouter/sdk/models"; - -let value: ChatStreamDelta = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](/client-sdks/typescript/api-reference/models/chataudiooutput) | :heavy_minus_sign: | N/A | `{"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f","expires_at": 1677652400,"id": "audio_abc123","transcript": "Hello! How can I help you today?"}` | -| `content` | *string* | :heavy_minus_sign: | Message content delta | Hello | -| `reasoning` | *string* | :heavy_minus_sign: | Reasoning content delta | I need to | -| `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
`{"text": "Let me think about this...","type": "text"}`
] | -| `refusal` | *string* | :heavy_minus_sign: | Refusal message delta | `` | -| `role` | [models.ChatStreamDeltaRole](/client-sdks/typescript/api-reference/models/chatstreamdeltarole) | :heavy_minus_sign: | The role of the message author | assistant | -| `toolCalls` | [models.ChatStreamToolCall](/client-sdks/typescript/api-reference/models/chatstreamtoolcall)[] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamdeltarole.mdx b/client-sdks/typescript/api-reference/models/chatstreamdeltarole.mdx deleted file mode 100644 index b9d17521..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamdeltarole.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatStreamDeltaRole - TypeScript SDK -sidebarTitle: ChatStreamDeltaRole -description: ChatStreamDeltaRole type definition -seoTitle: ChatStreamDeltaRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamdeltarole -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamDeltaRole Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamDeltaRole type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamDeltaRole%20-%20TypeScript%20SDK&description=ChatStreamDeltaRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The role of the message author - -## Example Usage - -```typescript lines -import { ChatStreamDeltaRole } from "@openrouter/sdk/models"; - -let value: ChatStreamDeltaRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamingresponse.mdx b/client-sdks/typescript/api-reference/models/chatstreamingresponse.mdx deleted file mode 100644 index cbbd27aa..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamingresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ChatStreamingResponse - TypeScript SDK -sidebarTitle: ChatStreamingResponse -description: ChatStreamingResponse type definition -seoTitle: ChatStreamingResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponse%20-%20TypeScript%20SDK&description=ChatStreamingResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingResponse } from "@openrouter/sdk/models"; - -let value: ChatStreamingResponse = { - data: { - choices: [ - { - delta: {}, - finishReason: null, - index: 0, - }, - ], - created: 1677652288, - id: "chatcmpl-123", - model: "openai/gpt-4", - object: "chat.completion.chunk", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ChatStreamChunk](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/chatstreamoptions.mdx b/client-sdks/typescript/api-reference/models/chatstreamoptions.mdx deleted file mode 100644 index 4fc16dc6..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamoptions.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatStreamOptions - TypeScript SDK -sidebarTitle: ChatStreamOptions -description: ChatStreamOptions type definition -seoTitle: ChatStreamOptions Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamoptions -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamOptions Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamOptions type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamOptions%20-%20TypeScript%20SDK&description=ChatStreamOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Streaming configuration options - -## Example Usage - -```typescript lines -import { ChatStreamOptions } from "@openrouter/sdk/models"; - -let value: ChatStreamOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`includeUsage`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamtoolcall.mdx b/client-sdks/typescript/api-reference/models/chatstreamtoolcall.mdx deleted file mode 100644 index 62e78ea8..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamtoolcall.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatStreamToolCall - TypeScript SDK -sidebarTitle: ChatStreamToolCall -description: ChatStreamToolCall type definition -seoTitle: ChatStreamToolCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamtoolcall -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCall Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamToolCall type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCall%20-%20TypeScript%20SDK&description=ChatStreamToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool call delta for streaming responses - -## Example Usage - -```typescript lines -import { ChatStreamToolCall } from "@openrouter/sdk/models"; - -let value: ChatStreamToolCall = { - index: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `function` | [models.ChatStreamToolCallFunction](/client-sdks/typescript/api-reference/models/chatstreamtoolcallfunction) | :heavy_minus_sign: | Function call details | | -| `id` | *string* | :heavy_minus_sign: | Tool call identifier | call_abc123 | -| `index` | *number* | :heavy_check_mark: | Tool call index in the array | 0 | -| `type` | [models.ChatStreamToolCallType](/client-sdks/typescript/api-reference/models/chatstreamtoolcalltype) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamtoolcallfunction.mdx b/client-sdks/typescript/api-reference/models/chatstreamtoolcallfunction.mdx deleted file mode 100644 index 4dca7880..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamtoolcallfunction.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamToolCallFunction - TypeScript SDK -sidebarTitle: ChatStreamToolCallFunction -description: ChatStreamToolCallFunction type definition -seoTitle: ChatStreamToolCallFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamtoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamToolCallFunction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallFunction%20-%20TypeScript%20SDK&description=ChatStreamToolCallFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function call details - -## Example Usage - -```typescript lines -import { ChatStreamToolCallFunction } from "@openrouter/sdk/models"; - -let value: ChatStreamToolCallFunction = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *string* | :heavy_minus_sign: | Function arguments as JSON string | `{"location": "..."}` | -| `name` | *string* | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatstreamtoolcalltype.mdx b/client-sdks/typescript/api-reference/models/chatstreamtoolcalltype.mdx deleted file mode 100644 index 7a6c5afb..00000000 --- a/client-sdks/typescript/api-reference/models/chatstreamtoolcalltype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatStreamToolCallType - TypeScript SDK -sidebarTitle: ChatStreamToolCallType -description: ChatStreamToolCallType type definition -seoTitle: ChatStreamToolCallType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatstreamtoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamToolCallType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamToolCallType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamToolCallType%20-%20TypeScript%20SDK&description=ChatStreamToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool call type - -## Example Usage - -```typescript lines -import { ChatStreamToolCallType } from "@openrouter/sdk/models"; - -let value: ChatStreamToolCallType = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatsystemmessage.mdx b/client-sdks/typescript/api-reference/models/chatsystemmessage.mdx deleted file mode 100644 index c3f2fbb3..00000000 --- a/client-sdks/typescript/api-reference/models/chatsystemmessage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatSystemMessage - TypeScript SDK -sidebarTitle: ChatSystemMessage -description: ChatSystemMessage type definition -seoTitle: ChatSystemMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatsystemmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatSystemMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessage%20-%20TypeScript%20SDK&description=ChatSystemMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -System message for setting behavior - -## Example Usage - -```typescript lines -import { ChatSystemMessage } from "@openrouter/sdk/models"; - -let value: ChatSystemMessage = { - content: "What is the capital of France?", - role: "system", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `content` | *models.ChatSystemMessageContent* | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `name` | *string* | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `role` | *"system"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatsystemmessagecontent.mdx b/client-sdks/typescript/api-reference/models/chatsystemmessagecontent.mdx deleted file mode 100644 index cdb39881..00000000 --- a/client-sdks/typescript/api-reference/models/chatsystemmessagecontent.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatSystemMessageContent - TypeScript SDK -sidebarTitle: ChatSystemMessageContent -description: ChatSystemMessageContent type definition -seoTitle: ChatSystemMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatsystemmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatSystemMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - ChatSystemMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatSystemMessageContent%20-%20TypeScript%20SDK&description=ChatSystemMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -System message content - -## Supported Types - -### `string` - -```typescript lines -const value: string = "You are a helpful assistant."; -``` - -### `models.ChatContentText[]` - -```typescript lines -const value: models.ChatContentText[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattokenlogprob.mdx b/client-sdks/typescript/api-reference/models/chattokenlogprob.mdx deleted file mode 100644 index e8cb7348..00000000 --- a/client-sdks/typescript/api-reference/models/chattokenlogprob.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ChatTokenLogprob - TypeScript SDK -sidebarTitle: ChatTokenLogprob -description: ChatTokenLogprob type definition -seoTitle: ChatTokenLogprob Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattokenlogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprob Type | OpenRouter TypeScript SDK -'og:description': >- - ChatTokenLogprob type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprob%20-%20TypeScript%20SDK&description=ChatTokenLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Token log probability information - -## Example Usage - -```typescript lines -import { ChatTokenLogprob } from "@openrouter/sdk/models"; - -let value: ChatTokenLogprob = { - bytes: null, - logprob: -0.612345, - token: " Hello", - topLogprobs: [ - { - bytes: null, - logprob: -0.612345, - token: " Hello", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | UTF-8 bytes of the token | -| `logprob` | *number* | :heavy_check_mark: | Log probability of the token | -| `token` | *string* | :heavy_check_mark: | The token | -| `topLogprobs` | [models.ChatTokenLogprobTopLogprob](/client-sdks/typescript/api-reference/models/chattokenlogprobtoplogprob)[] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattokenlogprobs.mdx b/client-sdks/typescript/api-reference/models/chattokenlogprobs.mdx deleted file mode 100644 index 8b7c67c5..00000000 --- a/client-sdks/typescript/api-reference/models/chattokenlogprobs.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatTokenLogprobs - TypeScript SDK -sidebarTitle: ChatTokenLogprobs -description: ChatTokenLogprobs type definition -seoTitle: ChatTokenLogprobs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chattokenlogprobs -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobs Type | OpenRouter TypeScript SDK -'og:description': >- - ChatTokenLogprobs type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobs%20-%20TypeScript%20SDK&description=ChatTokenLogprobs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Log probabilities for the completion - -## Example Usage - -```typescript lines -import { ChatTokenLogprobs } from "@openrouter/sdk/models"; - -let value: ChatTokenLogprobs = { - content: [ - { - bytes: null, - logprob: -0.612345, - token: " Hello", - topLogprobs: [], - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `content` | [models.ChatTokenLogprob](/client-sdks/typescript/api-reference/models/chattokenlogprob)[] | :heavy_check_mark: | Log probabilities for content tokens | -| `refusal` | [models.ChatTokenLogprob](/client-sdks/typescript/api-reference/models/chattokenlogprob)[] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattokenlogprobtoplogprob.mdx b/client-sdks/typescript/api-reference/models/chattokenlogprobtoplogprob.mdx deleted file mode 100644 index a5c77148..00000000 --- a/client-sdks/typescript/api-reference/models/chattokenlogprobtoplogprob.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ChatTokenLogprobTopLogprob - TypeScript SDK -sidebarTitle: ChatTokenLogprobTopLogprob -description: ChatTokenLogprobTopLogprob type definition -seoTitle: ChatTokenLogprobTopLogprob Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattokenlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatTokenLogprobTopLogprob Type | OpenRouter TypeScript SDK -'og:description': >- - ChatTokenLogprobTopLogprob type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatTokenLogprobTopLogprob%20-%20TypeScript%20SDK&description=ChatTokenLogprobTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatTokenLogprobTopLogprob } from "@openrouter/sdk/models"; - -let value: ChatTokenLogprobTopLogprob = { - bytes: [ - 661359, - 740557, - ], - logprob: 1354.72, - token: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolcall.mdx b/client-sdks/typescript/api-reference/models/chattoolcall.mdx deleted file mode 100644 index 7db988a4..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolcall.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ChatToolCall - TypeScript SDK -sidebarTitle: ChatToolCall -description: ChatToolCall type definition -seoTitle: ChatToolCall Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chattoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCall Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolCall type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCall%20-%20TypeScript%20SDK&description=ChatToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool call made by the assistant - -## Example Usage - -```typescript lines -import { ChatToolCall } from "@openrouter/sdk/models"; - -let value: ChatToolCall = { - function: { - arguments: "{\"location\": \"Boston, MA\"}", - name: "get_current_weather", - }, - id: "call_abc123", - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `function` | [models.ChatToolCallFunction](/client-sdks/typescript/api-reference/models/chattoolcallfunction) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | Tool call identifier | -| `type` | [models.ChatToolCallType](/client-sdks/typescript/api-reference/models/chattoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolcallfunction.mdx b/client-sdks/typescript/api-reference/models/chattoolcallfunction.mdx deleted file mode 100644 index 0fe40f8a..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolcallfunction.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatToolCallFunction - TypeScript SDK -sidebarTitle: ChatToolCallFunction -description: ChatToolCallFunction type definition -seoTitle: ChatToolCallFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolCallFunction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallFunction%20-%20TypeScript%20SDK&description=ChatToolCallFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatToolCallFunction } from "@openrouter/sdk/models"; - -let value: ChatToolCallFunction = { - arguments: "", - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | Function arguments as JSON string | -| `name` | *string* | :heavy_check_mark: | Function name to call | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolcalltype.mdx b/client-sdks/typescript/api-reference/models/chattoolcalltype.mdx deleted file mode 100644 index 191e695d..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolcalltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatToolCallType - TypeScript SDK -sidebarTitle: ChatToolCallType -description: ChatToolCallType type definition -seoTitle: ChatToolCallType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': ChatToolCallType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolCallType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolCallType%20-%20TypeScript%20SDK&description=ChatToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatToolCallType } from "@openrouter/sdk/models"; - -let value: ChatToolCallType = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolchoice.mdx b/client-sdks/typescript/api-reference/models/chattoolchoice.mdx deleted file mode 100644 index a920bd79..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolchoice.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ChatToolChoice - TypeScript SDK -sidebarTitle: ChatToolChoice -description: ChatToolChoice type definition -seoTitle: ChatToolChoice Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chattoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolChoice type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoice%20-%20TypeScript%20SDK&description=ChatToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool choice configuration - -## Supported Types - -### `models.ChatToolChoiceNone` - -```typescript lines -const value: models.ChatToolChoiceNone = "none"; -``` - -### `models.ChatToolChoiceAuto` - -```typescript lines -const value: models.ChatToolChoiceAuto = "auto"; -``` - -### `models.ChatToolChoiceRequired` - -```typescript lines -const value: models.ChatToolChoiceRequired = "required"; -``` - -### `models.ChatNamedToolChoice` - -```typescript lines -const value: models.ChatNamedToolChoice = { - function: { - name: "get_weather", - }, - type: "function", -}; -``` - -### `models.ChatServerToolChoice` - -```typescript lines -const value: models.ChatServerToolChoice = { - type: "openrouter:web_search", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolchoiceauto.mdx b/client-sdks/typescript/api-reference/models/chattoolchoiceauto.mdx deleted file mode 100644 index e9c0cdad..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolchoiceauto.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatToolChoiceAuto - TypeScript SDK -sidebarTitle: ChatToolChoiceAuto -description: ChatToolChoiceAuto type definition -seoTitle: ChatToolChoiceAuto Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceAuto Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolChoiceAuto type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceAuto%20-%20TypeScript%20SDK&description=ChatToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatToolChoiceAuto } from "@openrouter/sdk/models"; - -let value: ChatToolChoiceAuto = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolchoicenone.mdx b/client-sdks/typescript/api-reference/models/chattoolchoicenone.mdx deleted file mode 100644 index a956fc0b..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolchoicenone.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatToolChoiceNone - TypeScript SDK -sidebarTitle: ChatToolChoiceNone -description: ChatToolChoiceNone type definition -seoTitle: ChatToolChoiceNone Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceNone Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolChoiceNone type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceNone%20-%20TypeScript%20SDK&description=ChatToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatToolChoiceNone } from "@openrouter/sdk/models"; - -let value: ChatToolChoiceNone = "none"; -``` - -## Values - -```typescript lines -"none" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolchoicerequired.mdx b/client-sdks/typescript/api-reference/models/chattoolchoicerequired.mdx deleted file mode 100644 index 12605501..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolchoicerequired.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatToolChoiceRequired - TypeScript SDK -sidebarTitle: ChatToolChoiceRequired -description: ChatToolChoiceRequired type definition -seoTitle: ChatToolChoiceRequired Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': ChatToolChoiceRequired Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolChoiceRequired type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolChoiceRequired%20-%20TypeScript%20SDK&description=ChatToolChoiceRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatToolChoiceRequired } from "@openrouter/sdk/models"; - -let value: ChatToolChoiceRequired = "required"; -``` - -## Values - -```typescript lines -"required" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolmessage.mdx b/client-sdks/typescript/api-reference/models/chattoolmessage.mdx deleted file mode 100644 index 9696dd33..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolmessage.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatToolMessage - TypeScript SDK -sidebarTitle: ChatToolMessage -description: ChatToolMessage type definition -seoTitle: ChatToolMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolmessage -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessage%20-%20TypeScript%20SDK&description=ChatToolMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool response message - -## Example Usage - -```typescript lines -import { ChatToolMessage } from "@openrouter/sdk/models"; - -let value: ChatToolMessage = { - content: "What is the capital of France?", - role: "tool", - toolCallId: "call_abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `content` | *models.ChatToolMessageContent* | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `role` | *"tool"* | :heavy_check_mark: | N/A | | -| `toolCallId` | *string* | :heavy_check_mark: | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chattoolmessagecontent.mdx b/client-sdks/typescript/api-reference/models/chattoolmessagecontent.mdx deleted file mode 100644 index 971d6da7..00000000 --- a/client-sdks/typescript/api-reference/models/chattoolmessagecontent.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatToolMessageContent - TypeScript SDK -sidebarTitle: ChatToolMessageContent -description: ChatToolMessageContent type definition -seoTitle: ChatToolMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chattoolmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatToolMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - ChatToolMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatToolMessageContent%20-%20TypeScript%20SDK&description=ChatToolMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tool response content - -## Supported Types - -### `string` - -```typescript lines -const value: string = "The weather in San Francisco is 72°F and sunny."; -``` - -### `models.ChatContentItems[]` - -```typescript lines -const value: models.ChatContentItems[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatusage.mdx b/client-sdks/typescript/api-reference/models/chatusage.mdx deleted file mode 100644 index 4d3d1ad2..00000000 --- a/client-sdks/typescript/api-reference/models/chatusage.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatUsage - TypeScript SDK -sidebarTitle: ChatUsage -description: ChatUsage type definition -seoTitle: ChatUsage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/chatusage' -'og:site_name': OpenRouter Documentation -'og:title': ChatUsage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatUsage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUsage%20-%20TypeScript%20SDK&description=ChatUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Example Usage - -```typescript lines -import { ChatUsage } from "@openrouter/sdk/models"; - -let value: ChatUsage = { - completionTokens: 15, - promptTokens: 10, - totalTokens: 25, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | Number of tokens in the completion | | -| `completionTokensDetails` | [models.CompletionTokensDetails](/client-sdks/typescript/api-reference/models/completiontokensdetails) | :heavy_minus_sign: | Detailed completion token usage | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the prompt | | -| `promptTokensDetails` | [models.PromptTokensDetails](/client-sdks/typescript/api-reference/models/prompttokensdetails) | :heavy_minus_sign: | Detailed prompt token usage | | -| `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatusermessage.mdx b/client-sdks/typescript/api-reference/models/chatusermessage.mdx deleted file mode 100644 index 04efbec2..00000000 --- a/client-sdks/typescript/api-reference/models/chatusermessage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatUserMessage - TypeScript SDK -sidebarTitle: ChatUserMessage -description: ChatUserMessage type definition -seoTitle: ChatUserMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatusermessage -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessage Type | OpenRouter TypeScript SDK -'og:description': >- - ChatUserMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessage%20-%20TypeScript%20SDK&description=ChatUserMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -User message - -## Example Usage - -```typescript lines -import { ChatUserMessage } from "@openrouter/sdk/models"; - -let value: ChatUserMessage = { - content: "What is the capital of France?", - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `content` | *models.ChatUserMessageContent* | :heavy_check_mark: | User message content | What is the capital of France? | -| `name` | *string* | :heavy_minus_sign: | Optional name for the user | User | -| `role` | *"user"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatusermessagecontent.mdx b/client-sdks/typescript/api-reference/models/chatusermessagecontent.mdx deleted file mode 100644 index 05a41a7f..00000000 --- a/client-sdks/typescript/api-reference/models/chatusermessagecontent.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatUserMessageContent - TypeScript SDK -sidebarTitle: ChatUserMessageContent -description: ChatUserMessageContent type definition -seoTitle: ChatUserMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatusermessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ChatUserMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - ChatUserMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatUserMessageContent%20-%20TypeScript%20SDK&description=ChatUserMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -User message content - -## Supported Types - -### `string` - -```typescript lines -const value: string = "What is the capital of France?"; -``` - -### `models.ChatContentItems[]` - -```typescript lines -const value: models.ChatContentItems[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/chatwebsearchshorthand.mdx b/client-sdks/typescript/api-reference/models/chatwebsearchshorthand.mdx deleted file mode 100644 index c4b4c37a..00000000 --- a/client-sdks/typescript/api-reference/models/chatwebsearchshorthand.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatWebSearchShorthand - TypeScript SDK -sidebarTitle: ChatWebSearchShorthand -description: ChatWebSearchShorthand type definition -seoTitle: ChatWebSearchShorthand Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatwebsearchshorthand -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthand Type | OpenRouter TypeScript SDK -'og:description': >- - ChatWebSearchShorthand type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthand%20-%20TypeScript%20SDK&description=ChatWebSearchShorthand%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search tool using OpenAI Responses API syntax. Automatically converted to openrouter:web_search. - -## Example Usage - -```typescript lines -import { ChatWebSearchShorthand } from "@openrouter/sdk/models"; - -let value: ChatWebSearchShorthand = { - type: "web_search_2025_08_26", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `parameters` | [models.WebSearchConfig](/client-sdks/typescript/api-reference/models/websearchconfig) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `searchContextSize` | [models.SearchQualityLevel](/client-sdks/typescript/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `type` | [models.ChatWebSearchShorthandType](/client-sdks/typescript/api-reference/models/chatwebsearchshorthandtype) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocationServerTool](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/chatwebsearchshorthandtype.mdx b/client-sdks/typescript/api-reference/models/chatwebsearchshorthandtype.mdx deleted file mode 100644 index 9a6aa662..00000000 --- a/client-sdks/typescript/api-reference/models/chatwebsearchshorthandtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatWebSearchShorthandType - TypeScript SDK -sidebarTitle: ChatWebSearchShorthandType -description: ChatWebSearchShorthandType type definition -seoTitle: ChatWebSearchShorthandType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/chatwebsearchshorthandtype -'og:site_name': OpenRouter Documentation -'og:title': ChatWebSearchShorthandType Type | OpenRouter TypeScript SDK -'og:description': >- - ChatWebSearchShorthandType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatWebSearchShorthandType%20-%20TypeScript%20SDK&description=ChatWebSearchShorthandType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatWebSearchShorthandType } from "@openrouter/sdk/models"; - -let value: ChatWebSearchShorthandType = "web_search_preview"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"web_search" | "web_search_preview" | "web_search_preview_2025_03_11" | "web_search_2025_08_26" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/citation.mdx b/client-sdks/typescript/api-reference/models/citation.mdx deleted file mode 100644 index 1673ecdc..00000000 --- a/client-sdks/typescript/api-reference/models/citation.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: Citation - TypeScript SDK -sidebarTitle: Citation -description: Citation type definition -seoTitle: Citation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/citation' -'og:site_name': OpenRouter Documentation -'og:title': Citation Type | OpenRouter TypeScript SDK -'og:description': >- - Citation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Citation%20-%20TypeScript%20SDK&description=Citation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicCitationCharLocationParam` - -```typescript lines -const value: models.AnthropicCitationCharLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endCharIndex: 18, - startCharIndex: 0, - type: "char_location", -}; -``` - -### `models.AnthropicCitationContentBlockLocationParam` - -```typescript lines -const value: models.AnthropicCitationContentBlockLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endBlockIndex: 1, - startBlockIndex: 0, - type: "content_block_location", -}; -``` - -### `models.AnthropicCitationPageLocationParam` - -```typescript lines -const value: models.AnthropicCitationPageLocationParam = { - citedText: "Example cited text", - documentIndex: 0, - documentTitle: null, - endPageNumber: 2, - startPageNumber: 1, - type: "page_location", -}; -``` - -### `models.AnthropicCitationSearchResultLocation` - -```typescript lines -const value: models.AnthropicCitationSearchResultLocation = { - citedText: "Example cited text", - endBlockIndex: 1, - searchResultIndex: 0, - source: "example_source", - startBlockIndex: 0, - title: "Example Result", - type: "search_result_location", -}; -``` - -### `models.AnthropicCitationWebSearchResultLocation` - -```typescript lines -const value: models.AnthropicCitationWebSearchResultLocation = { - citedText: "Example cited text", - encryptedIndex: "enc_idx_0", - title: "Example Page", - type: "web_search_result_location", - url: "https://example.com", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/cleartoolinputs.mdx b/client-sdks/typescript/api-reference/models/cleartoolinputs.mdx deleted file mode 100644 index d0487ace..00000000 --- a/client-sdks/typescript/api-reference/models/cleartoolinputs.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ClearToolInputs - TypeScript SDK -sidebarTitle: ClearToolInputs -description: ClearToolInputs type definition -seoTitle: ClearToolInputs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/cleartoolinputs -'og:site_name': OpenRouter Documentation -'og:title': ClearToolInputs Type | OpenRouter TypeScript SDK -'og:description': >- - ClearToolInputs type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ClearToolInputs%20-%20TypeScript%20SDK&description=ClearToolInputs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `boolean` - -```typescript lines -const value: boolean = true; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/code.mdx b/client-sdks/typescript/api-reference/models/code.mdx deleted file mode 100644 index 14c4dada..00000000 --- a/client-sdks/typescript/api-reference/models/code.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Code - TypeScript SDK -sidebarTitle: Code -description: Code type definition -seoTitle: Code Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/code' -'og:site_name': OpenRouter Documentation -'og:title': Code Type | OpenRouter TypeScript SDK -'og:description': >- - Code type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Code%20-%20TypeScript%20SDK&description=Code%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Code } from "@openrouter/sdk/models"; - -let value: Code = "server_error"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"server_error" | "rate_limit_exceeded" | "invalid_prompt" | "vector_store_timeout" | "invalid_image" | "invalid_image_format" | "invalid_base64_image" | "invalid_image_url" | "image_too_large" | "image_too_small" | "image_parse_error" | "image_content_policy_violation" | "invalid_image_mode" | "image_file_too_large" | "unsupported_image_media_type" | "empty_image_file" | "failed_to_download_image" | "image_file_not_found" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/codeinterpreterservertool.mdx b/client-sdks/typescript/api-reference/models/codeinterpreterservertool.mdx deleted file mode 100644 index 9afb6697..00000000 --- a/client-sdks/typescript/api-reference/models/codeinterpreterservertool.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CodeInterpreterServerTool - TypeScript SDK -sidebarTitle: CodeInterpreterServerTool -description: CodeInterpreterServerTool type definition -seoTitle: CodeInterpreterServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/codeinterpreterservertool -'og:site_name': OpenRouter Documentation -'og:title': CodeInterpreterServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - CodeInterpreterServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodeInterpreterServerTool%20-%20TypeScript%20SDK&description=CodeInterpreterServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Code interpreter tool configuration - -## Example Usage - -```typescript lines -import { CodeInterpreterServerTool } from "@openrouter/sdk/models"; - -let value: CodeInterpreterServerTool = { - container: "auto", - type: "code_interpreter", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `container` | *models.Container* | :heavy_check_mark: | N/A | -| `type` | *"code_interpreter"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/codexlocalshelltool.mdx b/client-sdks/typescript/api-reference/models/codexlocalshelltool.mdx deleted file mode 100644 index 8f58c571..00000000 --- a/client-sdks/typescript/api-reference/models/codexlocalshelltool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CodexLocalShellTool - TypeScript SDK -sidebarTitle: CodexLocalShellTool -description: CodexLocalShellTool type definition -seoTitle: CodexLocalShellTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/codexlocalshelltool -'og:site_name': OpenRouter Documentation -'og:title': CodexLocalShellTool Type | OpenRouter TypeScript SDK -'og:description': >- - CodexLocalShellTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodexLocalShellTool%20-%20TypeScript%20SDK&description=CodexLocalShellTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Local shell tool configuration - -## Example Usage - -```typescript lines -import { CodexLocalShellTool } from "@openrouter/sdk/models"; - -let value: CodexLocalShellTool = { - type: "local_shell", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"local_shell"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/command.mdx b/client-sdks/typescript/api-reference/models/command.mdx deleted file mode 100644 index 64bed0be..00000000 --- a/client-sdks/typescript/api-reference/models/command.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Command - TypeScript SDK -sidebarTitle: Command -description: Command type definition -seoTitle: Command Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/command' -'og:site_name': OpenRouter Documentation -'og:title': Command Type | OpenRouter TypeScript SDK -'og:description': >- - Command type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Command%20-%20TypeScript%20SDK&description=Command%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Command } from "@openrouter/sdk/models"; - -let value: Command = "str_replace"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"view" | "create" | "str_replace" | "insert" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/compactionitem.mdx b/client-sdks/typescript/api-reference/models/compactionitem.mdx deleted file mode 100644 index 45e8ee08..00000000 --- a/client-sdks/typescript/api-reference/models/compactionitem.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CompactionItem - TypeScript SDK -sidebarTitle: CompactionItem -description: CompactionItem type definition -seoTitle: CompactionItem Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/compactionitem' -'og:site_name': OpenRouter Documentation -'og:title': CompactionItem Type | OpenRouter TypeScript SDK -'og:description': >- - CompactionItem type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItem%20-%20TypeScript%20SDK&description=CompactionItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A context compaction marker with encrypted summary - -## Example Usage - -```typescript lines -import { CompactionItem } from "@openrouter/sdk/models"; - -let value: CompactionItem = { - encryptedContent: "enc_abc123...", - type: "compaction", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.CompactionItemType](/client-sdks/typescript/api-reference/models/compactionitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/compactionitemtype.mdx b/client-sdks/typescript/api-reference/models/compactionitemtype.mdx deleted file mode 100644 index 9804a7a6..00000000 --- a/client-sdks/typescript/api-reference/models/compactionitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CompactionItemType - TypeScript SDK -sidebarTitle: CompactionItemType -description: CompactionItemType type definition -seoTitle: CompactionItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/compactionitemtype -'og:site_name': OpenRouter Documentation -'og:title': CompactionItemType Type | OpenRouter TypeScript SDK -'og:description': >- - CompactionItemType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompactionItemType%20-%20TypeScript%20SDK&description=CompactionItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompactionItemType } from "@openrouter/sdk/models"; - -let value: CompactionItemType = "compaction"; -``` - -## Values - -```typescript lines -"compaction" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/completiontokensdetails.mdx b/client-sdks/typescript/api-reference/models/completiontokensdetails.mdx deleted file mode 100644 index 1e6dfd91..00000000 --- a/client-sdks/typescript/api-reference/models/completiontokensdetails.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: CompletionTokensDetails - TypeScript SDK -sidebarTitle: CompletionTokensDetails -description: CompletionTokensDetails type definition -seoTitle: CompletionTokensDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/completiontokensdetails -'og:site_name': OpenRouter Documentation -'og:title': CompletionTokensDetails Type | OpenRouter TypeScript SDK -'og:description': >- - CompletionTokensDetails type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionTokensDetails%20-%20TypeScript%20SDK&description=CompletionTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Detailed completion token usage - -## Example Usage - -```typescript lines -import { CompletionTokensDetails } from "@openrouter/sdk/models"; - -let value: CompletionTokensDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `acceptedPredictionTokens` | *number* | :heavy_minus_sign: | Accepted prediction tokens | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for audio output | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens used for reasoning | -| `rejectedPredictionTokens` | *number* | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/compoundfilter.mdx b/client-sdks/typescript/api-reference/models/compoundfilter.mdx deleted file mode 100644 index 51fc1735..00000000 --- a/client-sdks/typescript/api-reference/models/compoundfilter.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CompoundFilter - TypeScript SDK -sidebarTitle: CompoundFilter -description: CompoundFilter type definition -seoTitle: CompoundFilter Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/compoundfilter' -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilter Type | OpenRouter TypeScript SDK -'og:description': >- - CompoundFilter type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilter%20-%20TypeScript%20SDK&description=CompoundFilter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A compound filter that combines multiple comparison or compound filters - -## Example Usage - -```typescript lines -import { CompoundFilter } from "@openrouter/sdk/models"; - -let value: CompoundFilter = { - filters: [ - { - "key": "author", - "type": "eq", - "value": "Alice", - }, - ], - type: "and", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `filters` | `Record`[] | :heavy_check_mark: | N/A | -| `type` | [models.CompoundFilterType](/client-sdks/typescript/api-reference/models/compoundfiltertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/compoundfiltertype.mdx b/client-sdks/typescript/api-reference/models/compoundfiltertype.mdx deleted file mode 100644 index 48ab806f..00000000 --- a/client-sdks/typescript/api-reference/models/compoundfiltertype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CompoundFilterType - TypeScript SDK -sidebarTitle: CompoundFilterType -description: CompoundFilterType type definition -seoTitle: CompoundFilterType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/compoundfiltertype -'og:site_name': OpenRouter Documentation -'og:title': CompoundFilterType Type | OpenRouter TypeScript SDK -'og:description': >- - CompoundFilterType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompoundFilterType%20-%20TypeScript%20SDK&description=CompoundFilterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompoundFilterType } from "@openrouter/sdk/models"; - -let value: CompoundFilterType = "or"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"and" | "or" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/computeruseservertool.mdx b/client-sdks/typescript/api-reference/models/computeruseservertool.mdx deleted file mode 100644 index 70819bf0..00000000 --- a/client-sdks/typescript/api-reference/models/computeruseservertool.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ComputerUseServerTool - TypeScript SDK -sidebarTitle: ComputerUseServerTool -description: ComputerUseServerTool type definition -seoTitle: ComputerUseServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/computeruseservertool -'og:site_name': OpenRouter Documentation -'og:title': ComputerUseServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - ComputerUseServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ComputerUseServerTool%20-%20TypeScript%20SDK&description=ComputerUseServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Computer use preview tool configuration - -## Example Usage - -```typescript lines -import { ComputerUseServerTool } from "@openrouter/sdk/models"; - -let value: ComputerUseServerTool = { - displayHeight: 768, - displayWidth: 1024, - environment: "linux", - type: "computer_use_preview", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `displayHeight` | *number* | :heavy_check_mark: | N/A | -| `displayWidth` | *number* | :heavy_check_mark: | N/A | -| `environment` | [models.Environment](/client-sdks/typescript/api-reference/models/environment) | :heavy_check_mark: | N/A | -| `type` | *"computer_use_preview"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/conflictresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/conflictresponseerrordata.mdx deleted file mode 100644 index 1bad8616..00000000 --- a/client-sdks/typescript/api-reference/models/conflictresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ConflictResponseErrorData - TypeScript SDK -sidebarTitle: ConflictResponseErrorData -description: ConflictResponseErrorData type definition -seoTitle: ConflictResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/conflictresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ConflictResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - ConflictResponseErrorData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConflictResponseErrorData%20-%20TypeScript%20SDK&description=ConflictResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ConflictResponse - -## Example Usage - -```typescript lines -import { ConflictResponseErrorData } from "@openrouter/sdk/models"; - -let value: ConflictResponseErrorData = { - code: 409, - message: "Resource conflict. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/connectorid.mdx b/client-sdks/typescript/api-reference/models/connectorid.mdx deleted file mode 100644 index 13a5bc98..00000000 --- a/client-sdks/typescript/api-reference/models/connectorid.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ConnectorId - TypeScript SDK -sidebarTitle: ConnectorId -description: ConnectorId type definition -seoTitle: ConnectorId Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/connectorid' -'og:site_name': OpenRouter Documentation -'og:title': ConnectorId Type | OpenRouter TypeScript SDK -'og:description': >- - ConnectorId type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ConnectorId%20-%20TypeScript%20SDK&description=ConnectorId%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ConnectorId } from "@openrouter/sdk/models"; - -let value: ConnectorId = "connector_dropbox"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"connector_dropbox" | "connector_gmail" | "connector_googlecalendar" | "connector_googledrive" | "connector_microsoftteams" | "connector_outlookcalendar" | "connector_outlookemail" | "connector_sharepoint" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/container.mdx b/client-sdks/typescript/api-reference/models/container.mdx deleted file mode 100644 index 0e8f12d8..00000000 --- a/client-sdks/typescript/api-reference/models/container.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Container - TypeScript SDK -sidebarTitle: Container -description: Container type definition -seoTitle: Container Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/container' -'og:site_name': OpenRouter Documentation -'og:title': Container Type | OpenRouter TypeScript SDK -'og:description': >- - Container type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Container%20-%20TypeScript%20SDK&description=Container%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ContainerAuto` - -```typescript lines -const value: models.ContainerAuto = { - type: "auto", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/containerauto.mdx b/client-sdks/typescript/api-reference/models/containerauto.mdx deleted file mode 100644 index 245f2883..00000000 --- a/client-sdks/typescript/api-reference/models/containerauto.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ContainerAuto - TypeScript SDK -sidebarTitle: ContainerAuto -description: ContainerAuto type definition -seoTitle: ContainerAuto Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/containerauto' -'og:site_name': OpenRouter Documentation -'og:title': ContainerAuto Type | OpenRouter TypeScript SDK -'og:description': >- - ContainerAuto type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerAuto%20-%20TypeScript%20SDK&description=ContainerAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContainerAuto } from "@openrouter/sdk/models"; - -let value: ContainerAuto = { - type: "auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `fileIds` | *string*[] | :heavy_minus_sign: | N/A | -| `memoryLimit` | [models.MemoryLimit](/client-sdks/typescript/api-reference/models/memorylimit) | :heavy_minus_sign: | N/A | -| `type` | [models.ContainerType](/client-sdks/typescript/api-reference/models/containertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/containertype.mdx b/client-sdks/typescript/api-reference/models/containertype.mdx deleted file mode 100644 index c2e25609..00000000 --- a/client-sdks/typescript/api-reference/models/containertype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ContainerType - TypeScript SDK -sidebarTitle: ContainerType -description: ContainerType type definition -seoTitle: ContainerType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/containertype' -'og:site_name': OpenRouter Documentation -'og:title': ContainerType Type | OpenRouter TypeScript SDK -'og:description': >- - ContainerType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContainerType%20-%20TypeScript%20SDK&description=ContainerType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContainerType } from "@openrouter/sdk/models"; - -let value: ContainerType = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentcompaction.mdx b/client-sdks/typescript/api-reference/models/contentcompaction.mdx deleted file mode 100644 index b2055ff0..00000000 --- a/client-sdks/typescript/api-reference/models/contentcompaction.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ContentCompaction - TypeScript SDK -sidebarTitle: ContentCompaction -description: ContentCompaction type definition -seoTitle: ContentCompaction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentcompaction -'og:site_name': OpenRouter Documentation -'og:title': ContentCompaction Type | OpenRouter TypeScript SDK -'og:description': >- - ContentCompaction type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentCompaction%20-%20TypeScript%20SDK&description=ContentCompaction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentCompaction } from "@openrouter/sdk/models"; - -let value: ContentCompaction = { - content: null, - type: "compaction", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"compaction"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilteraction.mdx b/client-sdks/typescript/api-reference/models/contentfilteraction.mdx deleted file mode 100644 index 2f2619ac..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilteraction.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentFilterAction - TypeScript SDK -sidebarTitle: ContentFilterAction -description: ContentFilterAction type definition -seoTitle: ContentFilterAction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilteraction -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterAction Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterAction type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterAction%20-%20TypeScript%20SDK&description=ContentFilterAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Action taken when the pattern matches - -## Example Usage - -```typescript lines -import { ContentFilterAction } from "@openrouter/sdk/models"; - -let value: ContentFilterAction = "block"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"redact" | "block" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilterbuiltinaction.mdx b/client-sdks/typescript/api-reference/models/contentfilterbuiltinaction.mdx deleted file mode 100644 index 3c7785e0..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilterbuiltinaction.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentFilterBuiltinAction - TypeScript SDK -sidebarTitle: ContentFilterBuiltinAction -description: ContentFilterBuiltinAction type definition -seoTitle: ContentFilterBuiltinAction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilterbuiltinaction -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinAction Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterBuiltinAction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinAction%20-%20TypeScript%20SDK&description=ContentFilterBuiltinAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Action taken when the builtin filter triggers - -## Example Usage - -```typescript lines -import { ContentFilterBuiltinAction } from "@openrouter/sdk/models"; - -let value: ContentFilterBuiltinAction = "block"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"redact" | "block" | "flag" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilterbuiltinentry.mdx b/client-sdks/typescript/api-reference/models/contentfilterbuiltinentry.mdx deleted file mode 100644 index 668046ec..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilterbuiltinentry.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentFilterBuiltinEntry - TypeScript SDK -sidebarTitle: ContentFilterBuiltinEntry -description: ContentFilterBuiltinEntry type definition -seoTitle: ContentFilterBuiltinEntry Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilterbuiltinentry -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntry Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterBuiltinEntry type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntry%20-%20TypeScript%20SDK&description=ContentFilterBuiltinEntry%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry. Builtin filters include PII detectors and the regex-based prompt injection detector. - -## Example Usage - -```typescript lines -import { ContentFilterBuiltinEntry } from "@openrouter/sdk/models"; - -let value: ContentFilterBuiltinEntry = { - action: "redact", - slug: "email", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](/client-sdks/typescript/api-reference/models/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] | -| `slug` | [models.ContentFilterBuiltinSlug](/client-sdks/typescript/api-reference/models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilterbuiltinentryinput.mdx b/client-sdks/typescript/api-reference/models/contentfilterbuiltinentryinput.mdx deleted file mode 100644 index a969525c..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilterbuiltinentryinput.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentFilterBuiltinEntryInput - TypeScript SDK -sidebarTitle: ContentFilterBuiltinEntryInput -description: ContentFilterBuiltinEntryInput type definition -seoTitle: ContentFilterBuiltinEntryInput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilterbuiltinentryinput -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinEntryInput Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterBuiltinEntryInput type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinEntryInput%20-%20TypeScript%20SDK&description=ContentFilterBuiltinEntryInput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A builtin content filter entry for create/update requests. Labels are system-assigned and cannot be set by the caller. - -## Example Usage - -```typescript lines -import { ContentFilterBuiltinEntryInput } from "@openrouter/sdk/models"; - -let value: ContentFilterBuiltinEntryInput = { - action: "redact", - slug: "email", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](/client-sdks/typescript/api-reference/models/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. | | -| `slug` | [models.ContentFilterBuiltinSlug](/client-sdks/typescript/api-reference/models/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilterbuiltinslug.mdx b/client-sdks/typescript/api-reference/models/contentfilterbuiltinslug.mdx deleted file mode 100644 index 2b44785d..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilterbuiltinslug.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentFilterBuiltinSlug - TypeScript SDK -sidebarTitle: ContentFilterBuiltinSlug -description: ContentFilterBuiltinSlug type definition -seoTitle: ContentFilterBuiltinSlug Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilterbuiltinslug -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterBuiltinSlug Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterBuiltinSlug type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterBuiltinSlug%20-%20TypeScript%20SDK&description=ContentFilterBuiltinSlug%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The builtin filter identifier - -## Example Usage - -```typescript lines -import { ContentFilterBuiltinSlug } from "@openrouter/sdk/models"; - -let value: ContentFilterBuiltinSlug = "regex-prompt-injection"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"email" | "phone" | "ssn" | "credit-card" | "ip-address" | "person-name" | "address" | "regex-prompt-injection" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentfilterentry.mdx b/client-sdks/typescript/api-reference/models/contentfilterentry.mdx deleted file mode 100644 index 4b026b56..00000000 --- a/client-sdks/typescript/api-reference/models/contentfilterentry.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentFilterEntry - TypeScript SDK -sidebarTitle: ContentFilterEntry -description: ContentFilterEntry type definition -seoTitle: ContentFilterEntry Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentfilterentry -'og:site_name': OpenRouter Documentation -'og:title': ContentFilterEntry Type | OpenRouter TypeScript SDK -'og:description': >- - ContentFilterEntry type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentFilterEntry%20-%20TypeScript%20SDK&description=ContentFilterEntry%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A custom regex content filter that scans request messages for matching patterns. - -## Example Usage - -```typescript lines -import { ContentFilterEntry } from "@openrouter/sdk/models"; - -let value: ContentFilterEntry = { - action: "redact", - pattern: "\\b(sk-[a-zA-Z0-9]{48})\\b", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `action` | [models.ContentFilterAction](/client-sdks/typescript/api-reference/models/contentfilteraction) | :heavy_check_mark: | Action taken when the pattern matches | block | -| `label` | *string* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `pattern` | *string* | :heavy_check_mark: | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]`{48}`)\b | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartaddedevent.mdx b/client-sdks/typescript/api-reference/models/contentpartaddedevent.mdx deleted file mode 100644 index dcd80d83..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartaddedevent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ContentPartAddedEvent - TypeScript SDK -sidebarTitle: ContentPartAddedEvent -description: ContentPartAddedEvent type definition -seoTitle: ContentPartAddedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartAddedEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEvent%20-%20TypeScript%20SDK&description=ContentPartAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a new content part is added to an output item - -## Example Usage - -```typescript lines -import { ContentPartAddedEvent } from "@openrouter/sdk/models"; - -let value: ContentPartAddedEvent = { - contentIndex: 286298, - itemId: "", - outputIndex: 549137, - part: { - text: "The capital of France is Paris.", - type: "output_text", - }, - sequenceNumber: 0, - type: "response.content_part.added", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.ContentPartAddedEventPart* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.content_part.added"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartaddedeventpart.mdx b/client-sdks/typescript/api-reference/models/contentpartaddedeventpart.mdx deleted file mode 100644 index 1ca9a831..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartaddedeventpart.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ContentPartAddedEventPart - TypeScript SDK -sidebarTitle: ContentPartAddedEventPart -description: ContentPartAddedEventPart type definition -seoTitle: ContentPartAddedEventPart Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartaddedeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartAddedEventPart Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartAddedEventPart type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartAddedEventPart%20-%20TypeScript%20SDK&description=ContentPartAddedEventPart%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -### `models.ReasoningTextContent` - -```typescript lines -const value: models.ReasoningTextContent = { - text: "Let me think step by step about this problem...", - type: "reasoning_text", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartdoneevent.mdx b/client-sdks/typescript/api-reference/models/contentpartdoneevent.mdx deleted file mode 100644 index b71f90b7..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartdoneevent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ContentPartDoneEvent - TypeScript SDK -sidebarTitle: ContentPartDoneEvent -description: ContentPartDoneEvent type definition -seoTitle: ContentPartDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartDoneEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEvent%20-%20TypeScript%20SDK&description=ContentPartDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a content part is complete - -## Example Usage - -```typescript lines -import { ContentPartDoneEvent } from "@openrouter/sdk/models"; - -let value: ContentPartDoneEvent = { - contentIndex: 928075, - itemId: "", - outputIndex: 289472, - part: { - text: "The capital of France is Paris.", - type: "output_text", - }, - sequenceNumber: 0, - type: "response.content_part.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.ContentPartDoneEventPart* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.content_part.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartdoneeventpart.mdx b/client-sdks/typescript/api-reference/models/contentpartdoneeventpart.mdx deleted file mode 100644 index c5a6dfa8..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartdoneeventpart.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ContentPartDoneEventPart - TypeScript SDK -sidebarTitle: ContentPartDoneEventPart -description: ContentPartDoneEventPart type definition -seoTitle: ContentPartDoneEventPart Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartdoneeventpart -'og:site_name': OpenRouter Documentation -'og:title': ContentPartDoneEventPart Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartDoneEventPart type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartDoneEventPart%20-%20TypeScript%20SDK&description=ContentPartDoneEventPart%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -### `models.ReasoningTextContent` - -```typescript lines -const value: models.ReasoningTextContent = { - text: "Let me think step by step about this problem...", - type: "reasoning_text", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartimage.mdx b/client-sdks/typescript/api-reference/models/contentpartimage.mdx deleted file mode 100644 index c24b3bdb..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartimage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartImage - TypeScript SDK -sidebarTitle: ContentPartImage -description: ContentPartImage type definition -seoTitle: ContentPartImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartimage -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImage Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartImage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImage%20-%20TypeScript%20SDK&description=ContentPartImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartImage } from "@openrouter/sdk/models"; - -let value: ContentPartImage = { - imageUrl: { - url: "https://example.com/image.png", - }, - type: "image_url", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ContentPartImageImageUrl](/client-sdks/typescript/api-reference/models/contentpartimageimageurl) | :heavy_check_mark: | N/A | -| `type` | [models.ContentPartImageType](/client-sdks/typescript/api-reference/models/contentpartimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartimageimageurl.mdx b/client-sdks/typescript/api-reference/models/contentpartimageimageurl.mdx deleted file mode 100644 index 8f900fb8..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartimageimageurl.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentPartImageImageUrl - TypeScript SDK -sidebarTitle: ContentPartImageImageUrl -description: ContentPartImageImageUrl type definition -seoTitle: ContentPartImageImageUrl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageImageUrl Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartImageImageUrl type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageImageUrl%20-%20TypeScript%20SDK&description=ContentPartImageImageUrl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartImageImageUrl } from "@openrouter/sdk/models"; - -let value: ContentPartImageImageUrl = { - url: "https://immense-parsnip.info/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartimagetype.mdx b/client-sdks/typescript/api-reference/models/contentpartimagetype.mdx deleted file mode 100644 index a528b346..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartimagetype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ContentPartImageType - TypeScript SDK -sidebarTitle: ContentPartImageType -description: ContentPartImageType type definition -seoTitle: ContentPartImageType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartimagetype -'og:site_name': OpenRouter Documentation -'og:title': ContentPartImageType Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartImageType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartImageType%20-%20TypeScript%20SDK&description=ContentPartImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartImageType } from "@openrouter/sdk/models"; - -let value: ContentPartImageType = "image_url"; -``` - -## Values - -```typescript lines -"image_url" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartinputaudio.mdx b/client-sdks/typescript/api-reference/models/contentpartinputaudio.mdx deleted file mode 100644 index 4e6810b7..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartinputaudio.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartInputAudio - TypeScript SDK -sidebarTitle: ContentPartInputAudio -description: ContentPartInputAudio type definition -seoTitle: ContentPartInputAudio Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputAudio Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartInputAudio type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputAudio%20-%20TypeScript%20SDK&description=ContentPartInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartInputAudio } from "@openrouter/sdk/models"; - -let value: ContentPartInputAudio = { - inputAudio: { - data: "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...", - }, - type: "input_audio", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputAudio` | [models.MultimodalMedia](/client-sdks/typescript/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartinputfile.mdx b/client-sdks/typescript/api-reference/models/contentpartinputfile.mdx deleted file mode 100644 index edd091a0..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartinputfile.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartInputFile - TypeScript SDK -sidebarTitle: ContentPartInputFile -description: ContentPartInputFile type definition -seoTitle: ContentPartInputFile Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartinputfile -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputFile Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartInputFile type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputFile%20-%20TypeScript%20SDK&description=ContentPartInputFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartInputFile } from "@openrouter/sdk/models"; - -let value: ContentPartInputFile = { - inputFile: { - data: "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAw...", - }, - type: "input_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputFile` | [models.MultimodalMedia](/client-sdks/typescript/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | *"input_file"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentpartinputvideo.mdx b/client-sdks/typescript/api-reference/models/contentpartinputvideo.mdx deleted file mode 100644 index 4dad00a6..00000000 --- a/client-sdks/typescript/api-reference/models/contentpartinputvideo.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentPartInputVideo - TypeScript SDK -sidebarTitle: ContentPartInputVideo -description: ContentPartInputVideo type definition -seoTitle: ContentPartInputVideo Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentpartinputvideo -'og:site_name': OpenRouter Documentation -'og:title': ContentPartInputVideo Type | OpenRouter TypeScript SDK -'og:description': >- - ContentPartInputVideo type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentPartInputVideo%20-%20TypeScript%20SDK&description=ContentPartInputVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentPartInputVideo } from "@openrouter/sdk/models"; - -let value: ContentPartInputVideo = { - inputVideo: { - data: "data:video/mp4;base64,AAAAGGZ0eXBtcDQyAAAAAGlzb21tcDQy...", - }, - type: "input_video", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputVideo` | [models.MultimodalMedia](/client-sdks/typescript/api-reference/models/multimodalmedia) | :heavy_check_mark: | N/A | `{"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...","format": "wav"}` | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentredactedthinking.mdx b/client-sdks/typescript/api-reference/models/contentredactedthinking.mdx deleted file mode 100644 index ac9b04bd..00000000 --- a/client-sdks/typescript/api-reference/models/contentredactedthinking.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentRedactedThinking - TypeScript SDK -sidebarTitle: ContentRedactedThinking -description: ContentRedactedThinking type definition -seoTitle: ContentRedactedThinking Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentredactedthinking -'og:site_name': OpenRouter Documentation -'og:title': ContentRedactedThinking Type | OpenRouter TypeScript SDK -'og:description': >- - ContentRedactedThinking type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentRedactedThinking%20-%20TypeScript%20SDK&description=ContentRedactedThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentRedactedThinking } from "@openrouter/sdk/models"; - -let value: ContentRedactedThinking = { - data: "", - type: "redacted_thinking", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | -| `type` | *"redacted_thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentservertooluse.mdx b/client-sdks/typescript/api-reference/models/contentservertooluse.mdx deleted file mode 100644 index 5a5011a0..00000000 --- a/client-sdks/typescript/api-reference/models/contentservertooluse.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ContentServerToolUse - TypeScript SDK -sidebarTitle: ContentServerToolUse -description: ContentServerToolUse type definition -seoTitle: ContentServerToolUse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentservertooluse -'og:site_name': OpenRouter Documentation -'og:title': ContentServerToolUse Type | OpenRouter TypeScript SDK -'og:description': >- - ContentServerToolUse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentServerToolUse%20-%20TypeScript%20SDK&description=ContentServerToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentServerToolUse } from "@openrouter/sdk/models"; - -let value: ContentServerToolUse = { - id: "", - name: "", - type: "server_tool_use", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"server_tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentthinking.mdx b/client-sdks/typescript/api-reference/models/contentthinking.mdx deleted file mode 100644 index d9c3ef08..00000000 --- a/client-sdks/typescript/api-reference/models/contentthinking.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentThinking - TypeScript SDK -sidebarTitle: ContentThinking -description: ContentThinking type definition -seoTitle: ContentThinking Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentthinking -'og:site_name': OpenRouter Documentation -'og:title': ContentThinking Type | OpenRouter TypeScript SDK -'og:description': >- - ContentThinking type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentThinking%20-%20TypeScript%20SDK&description=ContentThinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentThinking } from "@openrouter/sdk/models"; - -let value: ContentThinking = { - signature: "", - thinking: "", - type: "thinking", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `signature` | *string* | :heavy_check_mark: | N/A | -| `thinking` | *string* | :heavy_check_mark: | N/A | -| `type` | *"thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contenttoolreference.mdx b/client-sdks/typescript/api-reference/models/contenttoolreference.mdx deleted file mode 100644 index cabecc55..00000000 --- a/client-sdks/typescript/api-reference/models/contenttoolreference.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentToolReference - TypeScript SDK -sidebarTitle: ContentToolReference -description: ContentToolReference type definition -seoTitle: ContentToolReference Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contenttoolreference -'og:site_name': OpenRouter Documentation -'og:title': ContentToolReference Type | OpenRouter TypeScript SDK -'og:description': >- - ContentToolReference type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolReference%20-%20TypeScript%20SDK&description=ContentToolReference%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentToolReference } from "@openrouter/sdk/models"; - -let value: ContentToolReference = { - toolName: "", - type: "tool_reference", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `toolName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contenttoolresult.mdx b/client-sdks/typescript/api-reference/models/contenttoolresult.mdx deleted file mode 100644 index a46d77f3..00000000 --- a/client-sdks/typescript/api-reference/models/contenttoolresult.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentToolResult - TypeScript SDK -sidebarTitle: ContentToolResult -description: ContentToolResult type definition -seoTitle: ContentToolResult Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contenttoolresult -'og:site_name': OpenRouter Documentation -'og:title': ContentToolResult Type | OpenRouter TypeScript SDK -'og:description': >- - ContentToolResult type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolResult%20-%20TypeScript%20SDK&description=ContentToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentToolResult } from "@openrouter/sdk/models"; - -let value: ContentToolResult = { - toolUseId: "", - type: "tool_result", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | *models.MessagesMessageParamContentUnion2* | :heavy_minus_sign: | N/A | | -| `isError` | *boolean* | :heavy_minus_sign: | N/A | | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contenttooluse.mdx b/client-sdks/typescript/api-reference/models/contenttooluse.mdx deleted file mode 100644 index 97f6eae2..00000000 --- a/client-sdks/typescript/api-reference/models/contenttooluse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ContentToolUse - TypeScript SDK -sidebarTitle: ContentToolUse -description: ContentToolUse type definition -seoTitle: ContentToolUse Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/contenttooluse' -'og:site_name': OpenRouter Documentation -'og:title': ContentToolUse Type | OpenRouter TypeScript SDK -'og:description': >- - ContentToolUse type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentToolUse%20-%20TypeScript%20SDK&description=ContentToolUse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentToolUse } from "@openrouter/sdk/models"; - -let value: ContentToolUse = { - id: "", - name: "", - type: "tool_use", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentwebsearchtoolresult.mdx b/client-sdks/typescript/api-reference/models/contentwebsearchtoolresult.mdx deleted file mode 100644 index 67c5c171..00000000 --- a/client-sdks/typescript/api-reference/models/contentwebsearchtoolresult.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ContentWebSearchToolResult - TypeScript SDK -sidebarTitle: ContentWebSearchToolResult -description: ContentWebSearchToolResult type definition -seoTitle: ContentWebSearchToolResult Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentwebsearchtoolresult -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResult Type | OpenRouter TypeScript SDK -'og:description': >- - ContentWebSearchToolResult type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResult%20-%20TypeScript%20SDK&description=ContentWebSearchToolResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentWebSearchToolResult } from "@openrouter/sdk/models"; - -let value: ContentWebSearchToolResult = { - content: [ - { - encryptedContent: "enc_content_0", - title: "Example Page", - type: "web_search_result", - url: "https://example.com", - }, - ], - toolUseId: "", - type: "web_search_tool_result", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `content` | *models.MessagesMessageParamContentUnion3* | :heavy_check_mark: | N/A | | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"web_search_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contentwebsearchtoolresulterror.mdx b/client-sdks/typescript/api-reference/models/contentwebsearchtoolresulterror.mdx deleted file mode 100644 index 75961227..00000000 --- a/client-sdks/typescript/api-reference/models/contentwebsearchtoolresulterror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentWebSearchToolResultError - TypeScript SDK -sidebarTitle: ContentWebSearchToolResultError -description: ContentWebSearchToolResultError type definition -seoTitle: ContentWebSearchToolResultError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contentwebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': ContentWebSearchToolResultError Type | OpenRouter TypeScript SDK -'og:description': >- - ContentWebSearchToolResultError type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentWebSearchToolResultError%20-%20TypeScript%20SDK&description=ContentWebSearchToolResultError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentWebSearchToolResultError } from "@openrouter/sdk/models"; - -let value: ContentWebSearchToolResultError = { - errorCode: "unavailable", - type: "web_search_tool_result_error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `errorCode` | [models.ErrorCode](/client-sdks/typescript/api-reference/models/errorcode) | :heavy_check_mark: | N/A | -| `type` | [models.TypeWebSearchToolResultError](/client-sdks/typescript/api-reference/models/typewebsearchtoolresulterror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contextcompressionengine.mdx b/client-sdks/typescript/api-reference/models/contextcompressionengine.mdx deleted file mode 100644 index b0e14a32..00000000 --- a/client-sdks/typescript/api-reference/models/contextcompressionengine.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContextCompressionEngine - TypeScript SDK -sidebarTitle: ContextCompressionEngine -description: ContextCompressionEngine type definition -seoTitle: ContextCompressionEngine Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contextcompressionengine -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionEngine Type | OpenRouter TypeScript SDK -'og:description': >- - ContextCompressionEngine type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionEngine%20-%20TypeScript%20SDK&description=ContextCompressionEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The compression engine to use. Defaults to "middle-out". - -## Example Usage - -```typescript lines -import { ContextCompressionEngine } from "@openrouter/sdk/models"; - -let value: ContextCompressionEngine = "middle-out"; -``` - -## Values - -```typescript lines -"middle-out" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contextcompressionplugin.mdx b/client-sdks/typescript/api-reference/models/contextcompressionplugin.mdx deleted file mode 100644 index 3bb277be..00000000 --- a/client-sdks/typescript/api-reference/models/contextcompressionplugin.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContextCompressionPlugin - TypeScript SDK -sidebarTitle: ContextCompressionPlugin -description: ContextCompressionPlugin type definition -seoTitle: ContextCompressionPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contextcompressionplugin -'og:site_name': OpenRouter Documentation -'og:title': ContextCompressionPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ContextCompressionPlugin type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextCompressionPlugin%20-%20TypeScript%20SDK&description=ContextCompressionPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContextCompressionPlugin } from "@openrouter/sdk/models"; - -let value: ContextCompressionPlugin = { - id: "context-compression", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [models.ContextCompressionEngine](/client-sdks/typescript/api-reference/models/contextcompressionengine) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `id` | *"context-compression"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contextmanagement.mdx b/client-sdks/typescript/api-reference/models/contextmanagement.mdx deleted file mode 100644 index 1922c462..00000000 --- a/client-sdks/typescript/api-reference/models/contextmanagement.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ContextManagement - TypeScript SDK -sidebarTitle: ContextManagement -description: ContextManagement type definition -seoTitle: ContextManagement Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/contextmanagement -'og:site_name': OpenRouter Documentation -'og:title': ContextManagement Type | OpenRouter TypeScript SDK -'og:description': >- - ContextManagement type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContextManagement%20-%20TypeScript%20SDK&description=ContextManagement%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContextManagement } from "@openrouter/sdk/models"; - -let value: ContextManagement = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `edits` | *models.Edit*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/contradiction.mdx b/client-sdks/typescript/api-reference/models/contradiction.mdx deleted file mode 100644 index 54ead3ac..00000000 --- a/client-sdks/typescript/api-reference/models/contradiction.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Contradiction - TypeScript SDK -sidebarTitle: Contradiction -description: Contradiction type definition -seoTitle: Contradiction Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/contradiction' -'og:site_name': OpenRouter Documentation -'og:title': Contradiction Type | OpenRouter TypeScript SDK -'og:description': >- - Contradiction type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Contradiction%20-%20TypeScript%20SDK&description=Contradiction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Contradiction } from "@openrouter/sdk/models"; - -let value: Contradiction = { - stances: [ - { - model: "Roadster", - stance: "", - }, - ], - topic: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `stances` | [models.Stance](/client-sdks/typescript/api-reference/models/stance)[] | :heavy_check_mark: | N/A | -| `topic` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/costdetails.mdx b/client-sdks/typescript/api-reference/models/costdetails.mdx deleted file mode 100644 index 8b7128f6..00000000 --- a/client-sdks/typescript/api-reference/models/costdetails.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CostDetails - TypeScript SDK -sidebarTitle: CostDetails -description: CostDetails type definition -seoTitle: CostDetails Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/costdetails' -'og:site_name': OpenRouter Documentation -'og:title': CostDetails Type | OpenRouter TypeScript SDK -'og:description': >- - CostDetails type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CostDetails%20-%20TypeScript%20SDK&description=CostDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Breakdown of upstream inference costs - -## Example Usage - -```typescript lines -import { CostDetails } from "@openrouter/sdk/models"; - -let value: CostDetails = { - upstreamInferenceCompletionsCost: 0.0004, - upstreamInferencePromptCost: 0.0008, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `upstreamInferenceCompletionsCost` | *number* | :heavy_check_mark: | N/A | -| `upstreamInferenceCost` | *number* | :heavy_minus_sign: | N/A | -| `upstreamInferencePromptCost` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/createbyokkeyrequest.mdx b/client-sdks/typescript/api-reference/models/createbyokkeyrequest.mdx deleted file mode 100644 index 88ea001b..00000000 --- a/client-sdks/typescript/api-reference/models/createbyokkeyrequest.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: CreateBYOKKeyRequest - TypeScript SDK -sidebarTitle: CreateBYOKKeyRequest -description: CreateBYOKKeyRequest type definition -seoTitle: CreateBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyRequest%20-%20TypeScript%20SDK&description=CreateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateBYOKKeyRequest } from "@openrouter/sdk/models"; - -let value: CreateBYOKKeyRequest = { - key: "sk-proj-abc123...", - provider: "openai", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowedUserIds` | *string*[] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `isFallback` | *boolean* | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false | -| `key` | *string* | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/createbyokkeyresponse.mdx b/client-sdks/typescript/api-reference/models/createbyokkeyresponse.mdx deleted file mode 100644 index 2f81c6bb..00000000 --- a/client-sdks/typescript/api-reference/models/createbyokkeyresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: CreateBYOKKeyResponse - TypeScript SDK -sidebarTitle: CreateBYOKKeyResponse -description: CreateBYOKKeyResponse type definition -seoTitle: CreateBYOKKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createbyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateBYOKKeyResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyResponse%20-%20TypeScript%20SDK&description=CreateBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateBYOKKeyResponse } from "@openrouter/sdk/models"; - -let value: CreateBYOKKeyResponse = { - data: { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/createguardrailrequest.mdx b/client-sdks/typescript/api-reference/models/createguardrailrequest.mdx deleted file mode 100644 index b5264fc3..00000000 --- a/client-sdks/typescript/api-reference/models/createguardrailrequest.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: CreateGuardrailRequest - TypeScript SDK -sidebarTitle: CreateGuardrailRequest -description: CreateGuardrailRequest type definition -seoTitle: CreateGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20TypeScript%20SDK&description=CreateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateGuardrailRequest } from "@openrouter/sdk/models"; - -let value: CreateGuardrailRequest = { - name: "My New Guardrail", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](/client-sdks/typescript/api-reference/models/contentfilterbuiltinentryinput)[] | :heavy_minus_sign: | Builtin content filters to apply. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `contentFilters` | [models.ContentFilterEntry](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 50 | -| `name` | *string* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `resetInterval` | [models.GuardrailInterval](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/createguardrailresponse.mdx b/client-sdks/typescript/api-reference/models/createguardrailresponse.mdx deleted file mode 100644 index 6e1a43e7..00000000 --- a/client-sdks/typescript/api-reference/models/createguardrailresponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateGuardrailResponse - TypeScript SDK -sidebarTitle: CreateGuardrailResponse -description: CreateGuardrailResponse type definition -seoTitle: CreateGuardrailResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResponse%20-%20TypeScript%20SDK&description=CreateGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateGuardrailResponse } from "@openrouter/sdk/models"; - -let value: CreateGuardrailResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "My New Guardrail", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](/client-sdks/typescript/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequest.mdx deleted file mode 100644 index 376ee9d8..00000000 --- a/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: CreateObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: CreateObservabilityDestinationRequest -description: CreateObservabilityDestinationRequest type definition -seoTitle: CreateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=CreateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateObservabilityDestinationRequest } from "@openrouter/sdk/models"; - -let value: CreateObservabilityDestinationRequest = { - config: { - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, - name: "Production Langfuse", - type: "langfuse", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | `` | -| `config` | `Record` | :heavy_check_mark: | Provider-specific configuration. The shape depends on `type` and is validated server-side. | `{"baseUrl": "https://us.cloud.langfuse.com","publicKey": "pk-l...EfGh","secretKey": "sk-l...AbCd"}` | -| `enabled` | *boolean* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | `` | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [models.CreateObservabilityDestinationRequestType](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequesttype.mdx b/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequesttype.mdx deleted file mode 100644 index 868ddd33..00000000 --- a/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequesttype.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CreateObservabilityDestinationRequestType - TypeScript SDK -sidebarTitle: CreateObservabilityDestinationRequestType -description: CreateObservabilityDestinationRequestType type definition -seoTitle: CreateObservabilityDestinationRequestType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createobservabilitydestinationrequesttype -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequestType Type | OpenRouter TypeScript SDK -'og:description': >- - CreateObservabilityDestinationRequestType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequestType%20-%20TypeScript%20SDK&description=CreateObservabilityDestinationRequestType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The destination type. Only stable destination types are accepted. - -## Example Usage - -```typescript lines -import { CreateObservabilityDestinationRequestType } from "@openrouter/sdk/models"; - -let value: CreateObservabilityDestinationRequestType = "langfuse"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"arize" | "braintrust" | "clickhouse" | "datadog" | "grafana" | "langfuse" | "langsmith" | "newrelic" | "opik" | "otel-collector" | "posthog" | "ramp" | "s3" | "sentry" | "snowflake" | "weave" | "webhook" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/createobservabilitydestinationresponse.mdx b/client-sdks/typescript/api-reference/models/createobservabilitydestinationresponse.mdx deleted file mode 100644 index c5da266f..00000000 --- a/client-sdks/typescript/api-reference/models/createobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: CreateObservabilityDestinationResponse - TypeScript SDK -sidebarTitle: CreateObservabilityDestinationResponse -description: CreateObservabilityDestinationResponse type definition -seoTitle: CreateObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateObservabilityDestinationResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationResponse%20-%20TypeScript%20SDK&description=CreateObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { CreateObservabilityDestinationResponse } from "@openrouter/sdk/models"; - -let value: CreateObservabilityDestinationResponse = { - data: { - apiKeyHashes: null, - config: { - baseUrl: "https://us.cloud.langfuse.com", - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.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/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse.mdx b/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse.mdx deleted file mode 100644 index 64a1fc61..00000000 --- a/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: CreatePresetFromInferenceResponse - TypeScript SDK -sidebarTitle: CreatePresetFromInferenceResponse -description: CreatePresetFromInferenceResponse type definition -seoTitle: CreatePresetFromInferenceResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createpresetfrominferenceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetFromInferenceResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetFromInferenceResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetFromInferenceResponse%20-%20TypeScript%20SDK&description=CreatePresetFromInferenceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Response containing the created preset with its designated version. - -## Example Usage - -```typescript expandable lines -import { CreatePresetFromInferenceResponse } from "@openrouter/sdk/models"; - -let value: CreatePresetFromInferenceResponse = { - data: { - createdAt: "2026-04-20T10:00:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - description: null, - designatedVersion: { - config: { - "model": "openai/gpt-4o", - "temperature": 0.7, - }, - createdAt: "2026-04-20T10:00:00Z", - creatorId: "user_2dHFtVWx2n56w6HkM0000000000", - id: "550e8400-e29b-41d4-a716-446655440000", - presetId: "650e8400-e29b-41d4-a716-446655440001", - systemPrompt: "You are a helpful assistant.", - updatedAt: "2026-04-20T10:00:00Z", - version: 1, - }, - designatedVersionId: "550e8400-e29b-41d4-a716-446655440000", - id: "650e8400-e29b-41d4-a716-446655440001", - name: "my-preset", - slug: "my-preset", - status: "active", - statusUpdatedAt: null, - updatedAt: "2026-04-20T10:00:00Z", - workspaceId: "750e8400-e29b-41d4-a716-446655440002", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetWithDesignatedVersion](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/createworkspacerequest.mdx b/client-sdks/typescript/api-reference/models/createworkspacerequest.mdx deleted file mode 100644 index 63f851bc..00000000 --- a/client-sdks/typescript/api-reference/models/createworkspacerequest.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateWorkspaceRequest - TypeScript SDK -sidebarTitle: CreateWorkspaceRequest -description: CreateWorkspaceRequest type definition -seoTitle: CreateWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateWorkspaceRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceRequest%20-%20TypeScript%20SDK&description=CreateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateWorkspaceRequest } from "@openrouter/sdk/models"; - -let value: CreateWorkspaceRequest = { - name: "Production", - slug: "production", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `defaultImageModel` | *string* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `ioLoggingSamplingRate` | *number* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *string* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *string* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/createworkspaceresponse.mdx b/client-sdks/typescript/api-reference/models/createworkspaceresponse.mdx deleted file mode 100644 index 38302c3a..00000000 --- a/client-sdks/typescript/api-reference/models/createworkspaceresponse.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: CreateWorkspaceResponse - TypeScript SDK -sidebarTitle: CreateWorkspaceResponse -description: CreateWorkspaceResponse type definition -seoTitle: CreateWorkspaceResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/createworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateWorkspaceResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceResponse%20-%20TypeScript%20SDK&description=CreateWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { CreateWorkspaceResponse } from "@openrouter/sdk/models"; - -let value: CreateWorkspaceResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Production", - slug: "production", - updatedAt: null, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](/client-sdks/typescript/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/typescript/api-reference/models/customtool.mdx b/client-sdks/typescript/api-reference/models/customtool.mdx deleted file mode 100644 index 707590e6..00000000 --- a/client-sdks/typescript/api-reference/models/customtool.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CustomTool - TypeScript SDK -sidebarTitle: CustomTool -description: CustomTool type definition -seoTitle: CustomTool Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/customtool' -'og:site_name': OpenRouter Documentation -'og:title': CustomTool Type | OpenRouter TypeScript SDK -'og:description': >- - CustomTool type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomTool%20-%20TypeScript%20SDK&description=CustomTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Custom tool configuration - -## Example Usage - -```typescript lines -import { CustomTool } from "@openrouter/sdk/models"; - -let value: CustomTool = { - name: "my_tool", - type: "custom", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `format` | *models.Format* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | *"custom"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcallinputdeltaevent.mdx b/client-sdks/typescript/api-reference/models/customtoolcallinputdeltaevent.mdx deleted file mode 100644 index 0763c119..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcallinputdeltaevent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: CustomToolCallInputDeltaEvent - TypeScript SDK -sidebarTitle: CustomToolCallInputDeltaEvent -description: CustomToolCallInputDeltaEvent type definition -seoTitle: CustomToolCallInputDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcallinputdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallInputDeltaEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDeltaEvent%20-%20TypeScript%20SDK&description=CustomToolCallInputDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input is being streamed. Mirrors `response.function_call_arguments.delta` but for `custom` tools whose input is opaque text rather than JSON arguments. - -## Example Usage - -```typescript lines -import { CustomToolCallInputDeltaEvent } from "@openrouter/sdk/models"; - -let value: CustomToolCallInputDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 992628, - sequenceNumber: 0, - type: "response.custom_tool_call_input.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.custom_tool_call_input.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcallinputdoneevent.mdx b/client-sdks/typescript/api-reference/models/customtoolcallinputdoneevent.mdx deleted file mode 100644 index e6d9a697..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcallinputdoneevent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: CustomToolCallInputDoneEvent - TypeScript SDK -sidebarTitle: CustomToolCallInputDoneEvent -description: CustomToolCallInputDoneEvent type definition -seoTitle: CustomToolCallInputDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcallinputdoneevent -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallInputDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallInputDoneEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallInputDoneEvent%20-%20TypeScript%20SDK&description=CustomToolCallInputDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a custom tool call's freeform input streaming is complete. Mirrors `response.function_call_arguments.done` but for `custom` tools. - -## Example Usage - -```typescript lines -import { CustomToolCallInputDoneEvent } from "@openrouter/sdk/models"; - -let value: CustomToolCallInputDoneEvent = { - input: "", - itemId: "", - outputIndex: 276069, - sequenceNumber: 0, - type: "response.custom_tool_call_input.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `input` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.custom_tool_call_input.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcallitem.mdx b/client-sdks/typescript/api-reference/models/customtoolcallitem.mdx deleted file mode 100644 index bd5026ea..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcallitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: CustomToolCallItem - TypeScript SDK -sidebarTitle: CustomToolCallItem -description: CustomToolCallItem type definition -seoTitle: CustomToolCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcallitem -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItem%20-%20TypeScript%20SDK&description=CustomToolCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Example Usage - -```typescript lines -import { CustomToolCallItem } from "@openrouter/sdk/models"; - -let value: CustomToolCallItem = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `input` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.CustomToolCallItemType](/client-sdks/typescript/api-reference/models/customtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcallitemtype.mdx b/client-sdks/typescript/api-reference/models/customtoolcallitemtype.mdx deleted file mode 100644 index 2f974c26..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CustomToolCallItemType - TypeScript SDK -sidebarTitle: CustomToolCallItemType -description: CustomToolCallItemType type definition -seoTitle: CustomToolCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallItemType%20-%20TypeScript%20SDK&description=CustomToolCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CustomToolCallItemType } from "@openrouter/sdk/models"; - -let value: CustomToolCallItemType = "custom_tool_call"; -``` - -## Values - -```typescript lines -"custom_tool_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitem.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitem.mdx deleted file mode 100644 index 66ba98c1..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: CustomToolCallOutputItem - TypeScript SDK -sidebarTitle: CustomToolCallOutputItem -description: CustomToolCallOutputItem type definition -seoTitle: CustomToolCallOutputItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItem Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallOutputItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItem%20-%20TypeScript%20SDK&description=CustomToolCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The output from a custom (freeform-grammar) tool call execution. Mirrors `function_call_output` but is matched to a `custom_tool_call` rather than a `function_call`. - -## Example Usage - -```typescript lines -import { CustomToolCallOutputItem } from "@openrouter/sdk/models"; - -let value: CustomToolCallOutputItem = { - callId: "call-abc123", - output: "patch applied successfully", - type: "custom_tool_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *models.CustomToolCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | -| `type` | [models.CustomToolCallOutputItemTypeCustomToolCallOutput](/client-sdks/typescript/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemdetail.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitemdetail.mdx deleted file mode 100644 index d186dc37..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemdetail.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CustomToolCallOutputItemDetail - TypeScript SDK -sidebarTitle: CustomToolCallOutputItemDetail -description: CustomToolCallOutputItemDetail type definition -seoTitle: CustomToolCallOutputItemDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemDetail Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallOutputItemDetail type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemDetail%20-%20TypeScript%20SDK&description=CustomToolCallOutputItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CustomToolCallOutputItemDetail } from "@openrouter/sdk/models"; - -let value: CustomToolCallOutputItemDetail = "low"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "high" | "low" | "original" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx deleted file mode 100644 index 1c9bcff0..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputInputImage - TypeScript SDK -sidebarTitle: CustomToolCallOutputItemOutputInputImage -description: CustomToolCallOutputItemOutputInputImage type definition -seoTitle: CustomToolCallOutputItemOutputInputImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputInputImage Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallOutputItemOutputInputImage type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputInputImage%20-%20TypeScript%20SDK&description=CustomToolCallOutputItemOutputInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { CustomToolCallOutputItemOutputInputImage } from "@openrouter/sdk/models"; - -let value: CustomToolCallOutputItemOutputInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `detail` | [models.CustomToolCallOutputItemDetail](/client-sdks/typescript/api-reference/models/customtoolcalloutputitemdetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion1.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion1.mdx deleted file mode 100644 index d021309f..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion1 - TypeScript SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion1 -description: CustomToolCallOutputItemOutputUnion1 type definition -seoTitle: CustomToolCallOutputItemOutputUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion1 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion1%20-%20TypeScript%20SDK&description=CustomToolCallOutputItemOutputUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -### `models.CustomToolCallOutputItemOutputInputImage` - -```typescript lines -const value: models.CustomToolCallOutputItemOutputInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion2.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion2.mdx deleted file mode 100644 index 07547641..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CustomToolCallOutputItemOutputUnion2 - TypeScript SDK -sidebarTitle: CustomToolCallOutputItemOutputUnion2 -description: CustomToolCallOutputItemOutputUnion2 type definition -seoTitle: CustomToolCallOutputItemOutputUnion2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': CustomToolCallOutputItemOutputUnion2 Type | OpenRouter TypeScript SDK -'og:description': >- - CustomToolCallOutputItemOutputUnion2 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemOutputUnion2%20-%20TypeScript%20SDK&description=CustomToolCallOutputItemOutputUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.CustomToolCallOutputItemOutputUnion1[]` - -```typescript lines -const value: models.CustomToolCallOutputItemOutputUnion1[] = []; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx b/client-sdks/typescript/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx deleted file mode 100644 index 97c22dc9..00000000 --- a/client-sdks/typescript/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: CustomToolCallOutputItemTypeCustomToolCallOutput - TypeScript SDK -sidebarTitle: CustomToolCallOutputItemTypeCustomToolCallOutput -description: CustomToolCallOutputItemTypeCustomToolCallOutput type definition -seoTitle: >- - CustomToolCallOutputItemTypeCustomToolCallOutput Type | OpenRouter TypeScript - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/customtoolcalloutputitemtypecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': >- - CustomToolCallOutputItemTypeCustomToolCallOutput Type | OpenRouter TypeScript - SDK -'og:description': >- - CustomToolCallOutputItemTypeCustomToolCallOutput type reference for the - OpenRouter TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CustomToolCallOutputItemTypeCustomToolCallOutput%20-%20TypeScript%20SDK&description=CustomToolCallOutputItemTypeCustomToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CustomToolCallOutputItemTypeCustomToolCallOutput } from "@openrouter/sdk/models"; - -let value: CustomToolCallOutputItemTypeCustomToolCallOutput = - "custom_tool_call_output"; -``` - -## Values - -```typescript lines -"custom_tool_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/datacollection.mdx b/client-sdks/typescript/api-reference/models/datacollection.mdx deleted file mode 100644 index 424aa976..00000000 --- a/client-sdks/typescript/api-reference/models/datacollection.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: DataCollection - TypeScript SDK -sidebarTitle: DataCollection -description: DataCollection type definition -seoTitle: DataCollection Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/datacollection' -'og:site_name': OpenRouter Documentation -'og:title': DataCollection Type | OpenRouter TypeScript SDK -'og:description': >- - DataCollection type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DataCollection%20-%20TypeScript%20SDK&description=DataCollection%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { DataCollection } from "@openrouter/sdk/models"; - -let value: DataCollection = "allow"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"deny" | "allow" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/datetimeservertool.mdx b/client-sdks/typescript/api-reference/models/datetimeservertool.mdx deleted file mode 100644 index a9ea7a3e..00000000 --- a/client-sdks/typescript/api-reference/models/datetimeservertool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DatetimeServerTool - TypeScript SDK -sidebarTitle: DatetimeServerTool -description: DatetimeServerTool type definition -seoTitle: DatetimeServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/datetimeservertool -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - DatetimeServerTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerTool%20-%20TypeScript%20SDK&description=DatetimeServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: returns the current date and time - -## Example Usage - -```typescript lines -import { DatetimeServerTool } from "@openrouter/sdk/models"; - -let value: DatetimeServerTool = { - type: "openrouter:datetime", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.DatetimeServerToolConfig](/client-sdks/typescript/api-reference/models/datetimeservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | `{"timezone": "America/New_York"}` | -| `type` | [models.DatetimeServerToolType](/client-sdks/typescript/api-reference/models/datetimeservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/datetimeservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/datetimeservertoolconfig.mdx deleted file mode 100644 index 76d82ce1..00000000 --- a/client-sdks/typescript/api-reference/models/datetimeservertoolconfig.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DatetimeServerToolConfig - TypeScript SDK -sidebarTitle: DatetimeServerToolConfig -description: DatetimeServerToolConfig type definition -seoTitle: DatetimeServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/datetimeservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - DatetimeServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolConfig%20-%20TypeScript%20SDK&description=DatetimeServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:datetime server tool - -## Example Usage - -```typescript lines -import { DatetimeServerToolConfig } from "@openrouter/sdk/models"; - -let value: DatetimeServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `timezone` | *string* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/datetimeservertooltype.mdx b/client-sdks/typescript/api-reference/models/datetimeservertooltype.mdx deleted file mode 100644 index f4dbbe8b..00000000 --- a/client-sdks/typescript/api-reference/models/datetimeservertooltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: DatetimeServerToolType - TypeScript SDK -sidebarTitle: DatetimeServerToolType -description: DatetimeServerToolType type definition -seoTitle: DatetimeServerToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/datetimeservertooltype -'og:site_name': OpenRouter Documentation -'og:title': DatetimeServerToolType Type | OpenRouter TypeScript SDK -'og:description': >- - DatetimeServerToolType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DatetimeServerToolType%20-%20TypeScript%20SDK&description=DatetimeServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DatetimeServerToolType } from "@openrouter/sdk/models"; - -let value: DatetimeServerToolType = "openrouter:datetime"; -``` - -## Values - -```typescript lines -"openrouter:datetime" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/defaultparameters.mdx b/client-sdks/typescript/api-reference/models/defaultparameters.mdx deleted file mode 100644 index a9652e95..00000000 --- a/client-sdks/typescript/api-reference/models/defaultparameters.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: DefaultParameters - TypeScript SDK -sidebarTitle: DefaultParameters -description: DefaultParameters type definition -seoTitle: DefaultParameters Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/defaultparameters -'og:site_name': OpenRouter Documentation -'og:title': DefaultParameters Type | OpenRouter TypeScript SDK -'og:description': >- - DefaultParameters type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DefaultParameters%20-%20TypeScript%20SDK&description=DefaultParameters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Default parameters for this model - -## Example Usage - -```typescript lines -import { DefaultParameters } from "@openrouter/sdk/models"; - -let value: DefaultParameters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `repetitionPenalty` | *number* | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `topK` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/deletebyokkeyresponse.mdx b/client-sdks/typescript/api-reference/models/deletebyokkeyresponse.mdx deleted file mode 100644 index 9ba8f21f..00000000 --- a/client-sdks/typescript/api-reference/models/deletebyokkeyresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteBYOKKeyResponse - TypeScript SDK -sidebarTitle: DeleteBYOKKeyResponse -description: DeleteBYOKKeyResponse type definition -seoTitle: DeleteBYOKKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/deletebyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteBYOKKeyResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyResponse%20-%20TypeScript%20SDK&description=DeleteBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteBYOKKeyResponse } from "@openrouter/sdk/models"; - -let value: DeleteBYOKKeyResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/deleteguardrailresponse.mdx b/client-sdks/typescript/api-reference/models/deleteguardrailresponse.mdx deleted file mode 100644 index 5f9a2fd0..00000000 --- a/client-sdks/typescript/api-reference/models/deleteguardrailresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteGuardrailResponse - TypeScript SDK -sidebarTitle: DeleteGuardrailResponse -description: DeleteGuardrailResponse type definition -seoTitle: DeleteGuardrailResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/deleteguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailResponse Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteGuardrailResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailResponse%20-%20TypeScript%20SDK&description=DeleteGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteGuardrailResponse } from "@openrouter/sdk/models"; - -let value: DeleteGuardrailResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/deleteobservabilitydestinationresponse.mdx b/client-sdks/typescript/api-reference/models/deleteobservabilitydestinationresponse.mdx deleted file mode 100644 index 60bb4c70..00000000 --- a/client-sdks/typescript/api-reference/models/deleteobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteObservabilityDestinationResponse - TypeScript SDK -sidebarTitle: DeleteObservabilityDestinationResponse -description: DeleteObservabilityDestinationResponse type definition -seoTitle: DeleteObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/deleteobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteObservabilityDestinationResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationResponse%20-%20TypeScript%20SDK&description=DeleteObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteObservabilityDestinationResponse } from "@openrouter/sdk/models"; - -let value: DeleteObservabilityDestinationResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/deleteworkspaceresponse.mdx b/client-sdks/typescript/api-reference/models/deleteworkspaceresponse.mdx deleted file mode 100644 index 3901471a..00000000 --- a/client-sdks/typescript/api-reference/models/deleteworkspaceresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteWorkspaceResponse - TypeScript SDK -sidebarTitle: DeleteWorkspaceResponse -description: DeleteWorkspaceResponse type definition -seoTitle: DeleteWorkspaceResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/deleteworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceResponse Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteWorkspaceResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceResponse%20-%20TypeScript%20SDK&description=DeleteWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteWorkspaceResponse } from "@openrouter/sdk/models"; - -let value: DeleteWorkspaceResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessage.mdx b/client-sdks/typescript/api-reference/models/easyinputmessage.mdx deleted file mode 100644 index 2e2aca19..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessage.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: EasyInputMessage - TypeScript SDK -sidebarTitle: EasyInputMessage -description: EasyInputMessage type definition -seoTitle: EasyInputMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessage Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessage%20-%20TypeScript%20SDK&description=EasyInputMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessage } from "@openrouter/sdk/models"; - -let value: EasyInputMessage = { - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.EasyInputMessageContentUnion2* | :heavy_minus_sign: | N/A | | -| `phase` | *models.EasyInputMessagePhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | -| `role` | *models.EasyInputMessageRoleUnion* | :heavy_check_mark: | N/A | | -| `type` | [models.EasyInputMessageTypeMessage](/client-sdks/typescript/api-reference/models/easyinputmessagetypemessage) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagecontentinputimage.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagecontentinputimage.mdx deleted file mode 100644 index b79063f3..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagecontentinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: EasyInputMessageContentInputImage - TypeScript SDK -sidebarTitle: EasyInputMessageContentInputImage -description: EasyInputMessageContentInputImage type definition -seoTitle: EasyInputMessageContentInputImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagecontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentInputImage Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageContentInputImage type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentInputImage%20-%20TypeScript%20SDK&description=EasyInputMessageContentInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { EasyInputMessageContentInputImage } from "@openrouter/sdk/models"; - -let value: EasyInputMessageContentInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.EasyInputMessageDetail](/client-sdks/typescript/api-reference/models/easyinputmessagedetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion1.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion1.mdx deleted file mode 100644 index 010e1d22..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion1.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: EasyInputMessageContentUnion1 - TypeScript SDK -sidebarTitle: EasyInputMessageContentUnion1 -description: EasyInputMessageContentUnion1 type definition -seoTitle: EasyInputMessageContentUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagecontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageContentUnion1 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion1%20-%20TypeScript%20SDK&description=EasyInputMessageContentUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -### `models.EasyInputMessageContentInputImage` - -```typescript lines -const value: models.EasyInputMessageContentInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputAudio` - -```typescript lines -const value: models.InputAudio = { - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, - type: "input_audio", -}; -``` - -### `models.InputVideo` - -```typescript lines -const value: models.InputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion2.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion2.mdx deleted file mode 100644 index 3f245a50..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagecontentunion2.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: EasyInputMessageContentUnion2 - TypeScript SDK -sidebarTitle: EasyInputMessageContentUnion2 -description: EasyInputMessageContentUnion2 type definition -seoTitle: EasyInputMessageContentUnion2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagecontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageContentUnion2 Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageContentUnion2 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageContentUnion2%20-%20TypeScript%20SDK&description=EasyInputMessageContentUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.EasyInputMessageContentUnion1[]` - -```typescript lines -const value: models.EasyInputMessageContentUnion1[] = []; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagedetail.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagedetail.mdx deleted file mode 100644 index d974fe17..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagedetail.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EasyInputMessageDetail - TypeScript SDK -sidebarTitle: EasyInputMessageDetail -description: EasyInputMessageDetail type definition -seoTitle: EasyInputMessageDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagedetail -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageDetail Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageDetail type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageDetail%20-%20TypeScript%20SDK&description=EasyInputMessageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageDetail } from "@openrouter/sdk/models"; - -let value: EasyInputMessageDetail = "low"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "high" | "low" | "original" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagephasecommentary.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagephasecommentary.mdx deleted file mode 100644 index d8124154..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagephasecommentary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessagePhaseCommentary - TypeScript SDK -sidebarTitle: EasyInputMessagePhaseCommentary -description: EasyInputMessagePhaseCommentary type definition -seoTitle: EasyInputMessagePhaseCommentary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseCommentary Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessagePhaseCommentary type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseCommentary%20-%20TypeScript%20SDK&description=EasyInputMessagePhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessagePhaseCommentary } from "@openrouter/sdk/models"; - -let value: EasyInputMessagePhaseCommentary = "commentary"; -``` - -## Values - -```typescript lines -"commentary" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagephasefinalanswer.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagephasefinalanswer.mdx deleted file mode 100644 index 454e3b0e..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessagePhaseFinalAnswer - TypeScript SDK -sidebarTitle: EasyInputMessagePhaseFinalAnswer -description: EasyInputMessagePhaseFinalAnswer type definition -seoTitle: EasyInputMessagePhaseFinalAnswer Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseFinalAnswer Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessagePhaseFinalAnswer type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseFinalAnswer%20-%20TypeScript%20SDK&description=EasyInputMessagePhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessagePhaseFinalAnswer } from "@openrouter/sdk/models"; - -let value: EasyInputMessagePhaseFinalAnswer = "final_answer"; -``` - -## Values - -```typescript lines -"final_answer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagephaseunion.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagephaseunion.mdx deleted file mode 100644 index b0868ca9..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagephaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: EasyInputMessagePhaseUnion - TypeScript SDK -sidebarTitle: EasyInputMessagePhaseUnion -description: EasyInputMessagePhaseUnion type definition -seoTitle: EasyInputMessagePhaseUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessagePhaseUnion Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessagePhaseUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessagePhaseUnion%20-%20TypeScript%20SDK&description=EasyInputMessagePhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `models.EasyInputMessagePhaseCommentary` - -```typescript lines -const value: models.EasyInputMessagePhaseCommentary = "commentary"; -``` - -### `models.EasyInputMessagePhaseFinalAnswer` - -```typescript lines -const value: models.EasyInputMessagePhaseFinalAnswer = "final_answer"; -``` - -### `any` - -```typescript lines -const value: any = "final_answer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessageroleassistant.mdx b/client-sdks/typescript/api-reference/models/easyinputmessageroleassistant.mdx deleted file mode 100644 index 8dcf43dd..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessageroleassistant.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessageRoleAssistant - TypeScript SDK -sidebarTitle: EasyInputMessageRoleAssistant -description: EasyInputMessageRoleAssistant type definition -seoTitle: EasyInputMessageRoleAssistant Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessageroleassistant -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleAssistant Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageRoleAssistant type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleAssistant%20-%20TypeScript%20SDK&description=EasyInputMessageRoleAssistant%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageRoleAssistant } from "@openrouter/sdk/models"; - -let value: EasyInputMessageRoleAssistant = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessageroledeveloper.mdx b/client-sdks/typescript/api-reference/models/easyinputmessageroledeveloper.mdx deleted file mode 100644 index f9aad305..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessageroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessageRoleDeveloper - TypeScript SDK -sidebarTitle: EasyInputMessageRoleDeveloper -description: EasyInputMessageRoleDeveloper type definition -seoTitle: EasyInputMessageRoleDeveloper Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessageroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleDeveloper Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageRoleDeveloper type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleDeveloper%20-%20TypeScript%20SDK&description=EasyInputMessageRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageRoleDeveloper } from "@openrouter/sdk/models"; - -let value: EasyInputMessageRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagerolesystem.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagerolesystem.mdx deleted file mode 100644 index e000fe76..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagerolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessageRoleSystem - TypeScript SDK -sidebarTitle: EasyInputMessageRoleSystem -description: EasyInputMessageRoleSystem type definition -seoTitle: EasyInputMessageRoleSystem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagerolesystem -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleSystem Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageRoleSystem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleSystem%20-%20TypeScript%20SDK&description=EasyInputMessageRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageRoleSystem } from "@openrouter/sdk/models"; - -let value: EasyInputMessageRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessageroleunion.mdx b/client-sdks/typescript/api-reference/models/easyinputmessageroleunion.mdx deleted file mode 100644 index d4c904c0..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessageroleunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: EasyInputMessageRoleUnion - TypeScript SDK -sidebarTitle: EasyInputMessageRoleUnion -description: EasyInputMessageRoleUnion type definition -seoTitle: EasyInputMessageRoleUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessageroleunion -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUnion Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageRoleUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUnion%20-%20TypeScript%20SDK&description=EasyInputMessageRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.EasyInputMessageRoleUser` - -```typescript lines -const value: models.EasyInputMessageRoleUser = "user"; -``` - -### `models.EasyInputMessageRoleSystem` - -```typescript lines -const value: models.EasyInputMessageRoleSystem = "system"; -``` - -### `models.EasyInputMessageRoleAssistant` - -```typescript lines -const value: models.EasyInputMessageRoleAssistant = "assistant"; -``` - -### `models.EasyInputMessageRoleDeveloper` - -```typescript lines -const value: models.EasyInputMessageRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessageroleuser.mdx b/client-sdks/typescript/api-reference/models/easyinputmessageroleuser.mdx deleted file mode 100644 index 311d0ec5..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessageroleuser.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessageRoleUser - TypeScript SDK -sidebarTitle: EasyInputMessageRoleUser -description: EasyInputMessageRoleUser type definition -seoTitle: EasyInputMessageRoleUser Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessageroleuser -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageRoleUser Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageRoleUser type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageRoleUser%20-%20TypeScript%20SDK&description=EasyInputMessageRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageRoleUser } from "@openrouter/sdk/models"; - -let value: EasyInputMessageRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/easyinputmessagetypemessage.mdx b/client-sdks/typescript/api-reference/models/easyinputmessagetypemessage.mdx deleted file mode 100644 index 0c6f32d3..00000000 --- a/client-sdks/typescript/api-reference/models/easyinputmessagetypemessage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EasyInputMessageTypeMessage - TypeScript SDK -sidebarTitle: EasyInputMessageTypeMessage -description: EasyInputMessageTypeMessage type definition -seoTitle: EasyInputMessageTypeMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/easyinputmessagetypemessage -'og:site_name': OpenRouter Documentation -'og:title': EasyInputMessageTypeMessage Type | OpenRouter TypeScript SDK -'og:description': >- - EasyInputMessageTypeMessage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EasyInputMessageTypeMessage%20-%20TypeScript%20SDK&description=EasyInputMessageTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EasyInputMessageTypeMessage } from "@openrouter/sdk/models"; - -let value: EasyInputMessageTypeMessage = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/edgenetworktimeoutresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/edgenetworktimeoutresponseerrordata.mdx deleted file mode 100644 index 18747978..00000000 --- a/client-sdks/typescript/api-reference/models/edgenetworktimeoutresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseErrorData - TypeScript SDK -sidebarTitle: EdgeNetworkTimeoutResponseErrorData -description: EdgeNetworkTimeoutResponseErrorData type definition -seoTitle: EdgeNetworkTimeoutResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/edgenetworktimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - EdgeNetworkTimeoutResponseErrorData type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseErrorData%20-%20TypeScript%20SDK&description=EdgeNetworkTimeoutResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for EdgeNetworkTimeoutResponse - -## Example Usage - -```typescript lines -import { EdgeNetworkTimeoutResponseErrorData } from "@openrouter/sdk/models"; - -let value: EdgeNetworkTimeoutResponseErrorData = { - code: 524, - message: "Request timed out. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/edit.mdx b/client-sdks/typescript/api-reference/models/edit.mdx deleted file mode 100644 index eac80bf6..00000000 --- a/client-sdks/typescript/api-reference/models/edit.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Edit - TypeScript SDK -sidebarTitle: Edit -description: Edit type definition -seoTitle: Edit Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/edit' -'og:site_name': OpenRouter Documentation -'og:title': Edit Type | OpenRouter TypeScript SDK -'og:description': >- - Edit type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Edit%20-%20TypeScript%20SDK&description=Edit%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.EditClearToolUses20250919` - -```typescript lines -const value: models.EditClearToolUses20250919 = { - type: "clear_tool_uses_20250919", -}; -``` - -### `models.EditClearThinking20251015` - -```typescript lines -const value: models.EditClearThinking20251015 = { - type: "clear_thinking_20251015", -}; -``` - -### `models.EditCompact20260112` - -```typescript lines -const value: models.EditCompact20260112 = { - type: "compact_20260112", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/editclearthinking20251015.mdx b/client-sdks/typescript/api-reference/models/editclearthinking20251015.mdx deleted file mode 100644 index 333e86b1..00000000 --- a/client-sdks/typescript/api-reference/models/editclearthinking20251015.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: EditClearThinking20251015 - TypeScript SDK -sidebarTitle: EditClearThinking20251015 -description: EditClearThinking20251015 type definition -seoTitle: EditClearThinking20251015 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/editclearthinking20251015 -'og:site_name': OpenRouter Documentation -'og:title': EditClearThinking20251015 Type | OpenRouter TypeScript SDK -'og:description': >- - EditClearThinking20251015 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearThinking20251015%20-%20TypeScript%20SDK&description=EditClearThinking20251015%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EditClearThinking20251015 } from "@openrouter/sdk/models"; - -let value: EditClearThinking20251015 = { - type: "clear_thinking_20251015", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `keep` | *models.Keep* | :heavy_minus_sign: | N/A | -| `type` | *"clear_thinking_20251015"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/editcleartooluses20250919.mdx b/client-sdks/typescript/api-reference/models/editcleartooluses20250919.mdx deleted file mode 100644 index a936d433..00000000 --- a/client-sdks/typescript/api-reference/models/editcleartooluses20250919.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: EditClearToolUses20250919 - TypeScript SDK -sidebarTitle: EditClearToolUses20250919 -description: EditClearToolUses20250919 type definition -seoTitle: EditClearToolUses20250919 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/editcleartooluses20250919 -'og:site_name': OpenRouter Documentation -'og:title': EditClearToolUses20250919 Type | OpenRouter TypeScript SDK -'og:description': >- - EditClearToolUses20250919 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditClearToolUses20250919%20-%20TypeScript%20SDK&description=EditClearToolUses20250919%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EditClearToolUses20250919 } from "@openrouter/sdk/models"; - -let value: EditClearToolUses20250919 = { - type: "clear_tool_uses_20250919", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `clearAtLeast` | [models.AnthropicInputTokensClearAtLeast](/client-sdks/typescript/api-reference/models/anthropicinputtokensclearatleast) | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 50000}` | -| `clearToolInputs` | *models.ClearToolInputs* | :heavy_minus_sign: | N/A | | -| `excludeTools` | *string*[] | :heavy_minus_sign: | N/A | | -| `keep` | [models.AnthropicToolUsesKeep](/client-sdks/typescript/api-reference/models/anthropictooluseskeep) | :heavy_minus_sign: | N/A | `{"type": "tool_uses","value": 5}` | -| `trigger` | *models.Trigger* | :heavy_minus_sign: | N/A | | -| `type` | *"clear_tool_uses_20250919"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/editcompact20260112.mdx b/client-sdks/typescript/api-reference/models/editcompact20260112.mdx deleted file mode 100644 index fae5c6f4..00000000 --- a/client-sdks/typescript/api-reference/models/editcompact20260112.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: EditCompact20260112 - TypeScript SDK -sidebarTitle: EditCompact20260112 -description: EditCompact20260112 type definition -seoTitle: EditCompact20260112 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/editcompact20260112 -'og:site_name': OpenRouter Documentation -'og:title': EditCompact20260112 Type | OpenRouter TypeScript SDK -'og:description': >- - EditCompact20260112 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditCompact20260112%20-%20TypeScript%20SDK&description=EditCompact20260112%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EditCompact20260112 } from "@openrouter/sdk/models"; - -let value: EditCompact20260112 = { - type: "compact_20260112", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `instructions` | *string* | :heavy_minus_sign: | N/A | | -| `pauseAfterCompaction` | *boolean* | :heavy_minus_sign: | N/A | | -| `trigger` | [models.TriggerInputTokens](/client-sdks/typescript/api-reference/models/triggerinputtokens) | :heavy_minus_sign: | N/A | `{"type": "input_tokens","value": 100000}` | -| `type` | *"compact_20260112"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/edittypeinputtokens.mdx b/client-sdks/typescript/api-reference/models/edittypeinputtokens.mdx deleted file mode 100644 index 3eaea2ef..00000000 --- a/client-sdks/typescript/api-reference/models/edittypeinputtokens.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EditTypeInputTokens - TypeScript SDK -sidebarTitle: EditTypeInputTokens -description: EditTypeInputTokens type definition -seoTitle: EditTypeInputTokens Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/edittypeinputtokens -'og:site_name': OpenRouter Documentation -'og:title': EditTypeInputTokens Type | OpenRouter TypeScript SDK -'og:description': >- - EditTypeInputTokens type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EditTypeInputTokens%20-%20TypeScript%20SDK&description=EditTypeInputTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EditTypeInputTokens } from "@openrouter/sdk/models"; - -let value: EditTypeInputTokens = "input_tokens"; -``` - -## Values - -```typescript lines -"input_tokens" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/endpointinfo.mdx b/client-sdks/typescript/api-reference/models/endpointinfo.mdx deleted file mode 100644 index c310825e..00000000 --- a/client-sdks/typescript/api-reference/models/endpointinfo.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: EndpointInfo - TypeScript SDK -sidebarTitle: EndpointInfo -description: EndpointInfo type definition -seoTitle: EndpointInfo Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/endpointinfo' -'og:site_name': OpenRouter Documentation -'og:title': EndpointInfo Type | OpenRouter TypeScript SDK -'og:description': >- - EndpointInfo type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointInfo%20-%20TypeScript%20SDK&description=EndpointInfo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EndpointInfo } from "@openrouter/sdk/models"; - -let value: EndpointInfo = { - model: "openai/gpt-4o", - provider: "OpenAI", - selected: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_check_mark: | N/A | -| `selected` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/endpointsmetadata.mdx b/client-sdks/typescript/api-reference/models/endpointsmetadata.mdx deleted file mode 100644 index f8c24804..00000000 --- a/client-sdks/typescript/api-reference/models/endpointsmetadata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: EndpointsMetadata - TypeScript SDK -sidebarTitle: EndpointsMetadata -description: EndpointsMetadata type definition -seoTitle: EndpointsMetadata Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/endpointsmetadata -'og:site_name': OpenRouter Documentation -'og:title': EndpointsMetadata Type | OpenRouter TypeScript SDK -'og:description': >- - EndpointsMetadata type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointsMetadata%20-%20TypeScript%20SDK&description=EndpointsMetadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EndpointsMetadata } from "@openrouter/sdk/models"; - -let value: EndpointsMetadata = { - available: [ - { - model: "openai/gpt-4o", - provider: "OpenAI", - selected: true, - }, - ], - total: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `available` | [models.EndpointInfo](/client-sdks/typescript/api-reference/models/endpointinfo)[] | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/endpointstatus.mdx b/client-sdks/typescript/api-reference/models/endpointstatus.mdx deleted file mode 100644 index aa446272..00000000 --- a/client-sdks/typescript/api-reference/models/endpointstatus.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: EndpointStatus - TypeScript SDK -sidebarTitle: EndpointStatus -description: EndpointStatus type definition -seoTitle: EndpointStatus Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/endpointstatus' -'og:site_name': OpenRouter Documentation -'og:title': EndpointStatus Type | OpenRouter TypeScript SDK -'og:description': >- - EndpointStatus type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointStatus%20-%20TypeScript%20SDK&description=EndpointStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EndpointStatus } from "@openrouter/sdk/models"; - -let value: EndpointStatus = 0; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -0 | -1 | -2 | -3 | -5 | -10 | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/environment.mdx b/client-sdks/typescript/api-reference/models/environment.mdx deleted file mode 100644 index 7235b1df..00000000 --- a/client-sdks/typescript/api-reference/models/environment.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Environment - TypeScript SDK -sidebarTitle: Environment -description: Environment type definition -seoTitle: Environment Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/environment' -'og:site_name': OpenRouter Documentation -'og:title': Environment Type | OpenRouter TypeScript SDK -'og:description': >- - Environment type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Environment%20-%20TypeScript%20SDK&description=Environment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Environment } from "@openrouter/sdk/models"; - -let value: Environment = "ubuntu"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"windows" | "mac" | "linux" | "ubuntu" | "browser" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/errorcode.mdx b/client-sdks/typescript/api-reference/models/errorcode.mdx deleted file mode 100644 index 18d81859..00000000 --- a/client-sdks/typescript/api-reference/models/errorcode.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ErrorCode - TypeScript SDK -sidebarTitle: ErrorCode -description: ErrorCode type definition -seoTitle: ErrorCode Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/errorcode' -'og:site_name': OpenRouter Documentation -'og:title': ErrorCode Type | OpenRouter TypeScript SDK -'og:description': >- - ErrorCode type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorCode%20-%20TypeScript%20SDK&description=ErrorCode%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ErrorCode } from "@openrouter/sdk/models"; - -let value: ErrorCode = "too_many_requests"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"invalid_tool_input" | "unavailable" | "max_uses_exceeded" | "too_many_requests" | "query_too_long" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/errorevent.mdx b/client-sdks/typescript/api-reference/models/errorevent.mdx deleted file mode 100644 index 2fa0ecf5..00000000 --- a/client-sdks/typescript/api-reference/models/errorevent.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ErrorEvent - TypeScript SDK -sidebarTitle: ErrorEvent -description: ErrorEvent type definition -seoTitle: ErrorEvent Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/errorevent' -'og:site_name': OpenRouter Documentation -'og:title': ErrorEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ErrorEvent type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorEvent%20-%20TypeScript%20SDK&description=ErrorEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when an error occurs during streaming - -## Example Usage - -```typescript lines -import { ErrorEvent } from "@openrouter/sdk/models"; - -let value: ErrorEvent = { - code: "", - message: "", - param: "", - sequenceNumber: 0, - type: "error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `param` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"error"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/errort.mdx b/client-sdks/typescript/api-reference/models/errort.mdx deleted file mode 100644 index de78ec36..00000000 --- a/client-sdks/typescript/api-reference/models/errort.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ErrorT - TypeScript SDK -sidebarTitle: ErrorT -description: ErrorT type definition -seoTitle: ErrorT Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/errort' -'og:site_name': OpenRouter Documentation -'og:title': ErrorT Type | OpenRouter TypeScript SDK -'og:description': >- - ErrorT type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ErrorT%20-%20TypeScript%20SDK&description=ErrorT%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error information - -## Example Usage - -```typescript lines -import { ErrorT } from "@openrouter/sdk/models"; - -let value: ErrorT = { - code: 429, - message: "Rate limit exceeded", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `code` | *number* | :heavy_check_mark: | Error code | 429 | -| `message` | *string* | :heavy_check_mark: | Error message | Rate limit exceeded | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/failedmodel.mdx b/client-sdks/typescript/api-reference/models/failedmodel.mdx deleted file mode 100644 index 29825b80..00000000 --- a/client-sdks/typescript/api-reference/models/failedmodel.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FailedModel - TypeScript SDK -sidebarTitle: FailedModel -description: FailedModel type definition -seoTitle: FailedModel Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/failedmodel' -'og:site_name': OpenRouter Documentation -'og:title': FailedModel Type | OpenRouter TypeScript SDK -'og:description': >- - FailedModel type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FailedModel%20-%20TypeScript%20SDK&description=FailedModel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FailedModel } from "@openrouter/sdk/models"; - -let value: FailedModel = { - error: "", - model: "XTS", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `error` | *string* | :heavy_check_mark: | Error message describing why the model failed. | -| `model` | *string* | :heavy_check_mark: | Slug of the analysis model that failed. | -| `statusCode` | *number* | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/field.mdx b/client-sdks/typescript/api-reference/models/field.mdx deleted file mode 100644 index 327868e9..00000000 --- a/client-sdks/typescript/api-reference/models/field.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Field - TypeScript SDK -sidebarTitle: Field -description: Field type definition -seoTitle: Field Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/field' -'og:site_name': OpenRouter Documentation -'og:title': Field Type | OpenRouter TypeScript SDK -'og:description': >- - Field type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Field%20-%20TypeScript%20SDK&description=Field%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Field } from "@openrouter/sdk/models"; - -let value: Field = "user_id"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"model" | "provider" | "session_id" | "user_id" | "api_key_name" | "finish_reason" | "input" | "output" | "total_cost" | "total_tokens" | "prompt_tokens" | "completion_tokens" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filecitation.mdx b/client-sdks/typescript/api-reference/models/filecitation.mdx deleted file mode 100644 index 4bfe4a8c..00000000 --- a/client-sdks/typescript/api-reference/models/filecitation.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FileCitation - TypeScript SDK -sidebarTitle: FileCitation -description: FileCitation type definition -seoTitle: FileCitation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filecitation' -'og:site_name': OpenRouter Documentation -'og:title': FileCitation Type | OpenRouter TypeScript SDK -'og:description': >- - FileCitation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitation%20-%20TypeScript%20SDK&description=FileCitation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FileCitation } from "@openrouter/sdk/models"; - -let value: FileCitation = { - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, - type: "file_citation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `type` | *"file_citation"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/fileparserplugin.mdx b/client-sdks/typescript/api-reference/models/fileparserplugin.mdx deleted file mode 100644 index c20a1ce9..00000000 --- a/client-sdks/typescript/api-reference/models/fileparserplugin.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FileParserPlugin - TypeScript SDK -sidebarTitle: FileParserPlugin -description: FileParserPlugin type definition -seoTitle: FileParserPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/fileparserplugin -'og:site_name': OpenRouter Documentation -'og:title': FileParserPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - FileParserPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileParserPlugin%20-%20TypeScript%20SDK&description=FileParserPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FileParserPlugin } from "@openrouter/sdk/models"; - -let value: FileParserPlugin = { - id: "file-parser", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `id` | *"file-parser"* | :heavy_check_mark: | N/A | | -| `pdf` | [models.PDFParserOptions](/client-sdks/typescript/api-reference/models/pdfparseroptions) | :heavy_minus_sign: | Options for PDF parsing. | `{"engine": "cloudflare-ai"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filepath.mdx b/client-sdks/typescript/api-reference/models/filepath.mdx deleted file mode 100644 index 605923b6..00000000 --- a/client-sdks/typescript/api-reference/models/filepath.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FilePath - TypeScript SDK -sidebarTitle: FilePath -description: FilePath type definition -seoTitle: FilePath Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filepath' -'og:site_name': OpenRouter Documentation -'og:title': FilePath Type | OpenRouter TypeScript SDK -'og:description': >- - FilePath type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePath%20-%20TypeScript%20SDK&description=FilePath%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FilePath } from "@openrouter/sdk/models"; - -let value: FilePath = { - fileId: "file-abc123", - index: 0, - type: "file_path", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `type` | *"file_path"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filesearchservertool.mdx b/client-sdks/typescript/api-reference/models/filesearchservertool.mdx deleted file mode 100644 index e2a93fdb..00000000 --- a/client-sdks/typescript/api-reference/models/filesearchservertool.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: FileSearchServerTool - TypeScript SDK -sidebarTitle: FileSearchServerTool -description: FileSearchServerTool type definition -seoTitle: FileSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/filesearchservertool -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - FileSearchServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerTool%20-%20TypeScript%20SDK&description=FileSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -File search tool configuration - -## Example Usage - -```typescript lines -import { FileSearchServerTool } from "@openrouter/sdk/models"; - -let value: FileSearchServerTool = { - type: "file_search", - vectorStoreIds: [ - "vs_abc123", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `filters` | *models.FiltersUnion* | :heavy_minus_sign: | N/A | -| `maxNumResults` | *number* | :heavy_minus_sign: | N/A | -| `rankingOptions` | [models.RankingOptions](/client-sdks/typescript/api-reference/models/rankingoptions) | :heavy_minus_sign: | N/A | -| `type` | *"file_search"* | :heavy_check_mark: | N/A | -| `vectorStoreIds` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filesearchservertoolvalue1.mdx b/client-sdks/typescript/api-reference/models/filesearchservertoolvalue1.mdx deleted file mode 100644 index 7e8e4a9d..00000000 --- a/client-sdks/typescript/api-reference/models/filesearchservertoolvalue1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FileSearchServerToolValue1 - TypeScript SDK -sidebarTitle: FileSearchServerToolValue1 -description: FileSearchServerToolValue1 type definition -seoTitle: FileSearchServerToolValue1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/filesearchservertoolvalue1 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue1 Type | OpenRouter TypeScript SDK -'og:description': >- - FileSearchServerToolValue1 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue1%20-%20TypeScript%20SDK&description=FileSearchServerToolValue1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filesearchservertoolvalue2.mdx b/client-sdks/typescript/api-reference/models/filesearchservertoolvalue2.mdx deleted file mode 100644 index 969ea53b..00000000 --- a/client-sdks/typescript/api-reference/models/filesearchservertoolvalue2.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: FileSearchServerToolValue2 - TypeScript SDK -sidebarTitle: FileSearchServerToolValue2 -description: FileSearchServerToolValue2 type definition -seoTitle: FileSearchServerToolValue2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/filesearchservertoolvalue2 -'og:site_name': OpenRouter Documentation -'og:title': FileSearchServerToolValue2 Type | OpenRouter TypeScript SDK -'og:description': >- - FileSearchServerToolValue2 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileSearchServerToolValue2%20-%20TypeScript%20SDK&description=FileSearchServerToolValue2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` - -### `boolean` - -```typescript lines -const value: boolean = true; -``` - -### `models.FileSearchServerToolValue1[]` - -```typescript lines -const value: models.FileSearchServerToolValue1[] = []; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filet.mdx b/client-sdks/typescript/api-reference/models/filet.mdx deleted file mode 100644 index 3ca7fb0a..00000000 --- a/client-sdks/typescript/api-reference/models/filet.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FileT - TypeScript SDK -sidebarTitle: FileT -description: FileT type definition -seoTitle: FileT Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filet' -'og:site_name': OpenRouter Documentation -'og:title': FileT Type | OpenRouter TypeScript SDK -'og:description': >- - FileT type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileT%20-%20TypeScript%20SDK&description=FileT%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FileT } from "@openrouter/sdk/models"; - -let value: FileT = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `fileData` | *string* | :heavy_minus_sign: | File content as base64 data URL or URL | -| `fileId` | *string* | :heavy_minus_sign: | File ID for previously uploaded files | -| `filename` | *string* | :heavy_minus_sign: | Original filename | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filters.mdx b/client-sdks/typescript/api-reference/models/filters.mdx deleted file mode 100644 index 863c1880..00000000 --- a/client-sdks/typescript/api-reference/models/filters.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Filters - TypeScript SDK -sidebarTitle: Filters -description: Filters type definition -seoTitle: Filters Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filters' -'og:site_name': OpenRouter Documentation -'og:title': Filters Type | OpenRouter TypeScript SDK -'og:description': >- - Filters type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Filters%20-%20TypeScript%20SDK&description=Filters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Filters } from "@openrouter/sdk/models"; - -let value: Filters = { - key: "", - type: "eq", - value: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.FiltersType](/client-sdks/typescript/api-reference/models/filterstype) | :heavy_check_mark: | N/A | -| `value` | *models.FileSearchServerToolValue2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filterstype.mdx b/client-sdks/typescript/api-reference/models/filterstype.mdx deleted file mode 100644 index e6aa01ca..00000000 --- a/client-sdks/typescript/api-reference/models/filterstype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FiltersType - TypeScript SDK -sidebarTitle: FiltersType -description: FiltersType type definition -seoTitle: FiltersType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filterstype' -'og:site_name': OpenRouter Documentation -'og:title': FiltersType Type | OpenRouter TypeScript SDK -'og:description': >- - FiltersType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersType%20-%20TypeScript%20SDK&description=FiltersType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FiltersType } from "@openrouter/sdk/models"; - -let value: FiltersType = "gt"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"eq" | "ne" | "gt" | "gte" | "lt" | "lte" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/filtersunion.mdx b/client-sdks/typescript/api-reference/models/filtersunion.mdx deleted file mode 100644 index e8007b8d..00000000 --- a/client-sdks/typescript/api-reference/models/filtersunion.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: FiltersUnion - TypeScript SDK -sidebarTitle: FiltersUnion -description: FiltersUnion type definition -seoTitle: FiltersUnion Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/filtersunion' -'og:site_name': OpenRouter Documentation -'og:title': FiltersUnion Type | OpenRouter TypeScript SDK -'og:description': >- - FiltersUnion type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FiltersUnion%20-%20TypeScript%20SDK&description=FiltersUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.Filters` - -```typescript lines -const value: models.Filters = { - key: "", - type: "eq", - value: [], -}; -``` - -### `models.CompoundFilter` - -```typescript lines -const value: models.CompoundFilter = { - filters: [ - { - "key": "author", - "type": "eq", - "value": "Alice", - }, - ], - type: "and", -}; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/forbiddenresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/forbiddenresponseerrordata.mdx deleted file mode 100644 index 8a3a40c2..00000000 --- a/client-sdks/typescript/api-reference/models/forbiddenresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ForbiddenResponseErrorData - TypeScript SDK -sidebarTitle: ForbiddenResponseErrorData -description: ForbiddenResponseErrorData type definition -seoTitle: ForbiddenResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/forbiddenresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - ForbiddenResponseErrorData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseErrorData%20-%20TypeScript%20SDK&description=ForbiddenResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ForbiddenResponse - -## Example Usage - -```typescript lines -import { ForbiddenResponseErrorData } from "@openrouter/sdk/models"; - -let value: ForbiddenResponseErrorData = { - code: 403, - message: "Only management keys can perform this operation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/format.mdx b/client-sdks/typescript/api-reference/models/format.mdx deleted file mode 100644 index c5e72bbb..00000000 --- a/client-sdks/typescript/api-reference/models/format.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Format - TypeScript SDK -sidebarTitle: Format -description: Format type definition -seoTitle: Format Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/format' -'og:site_name': OpenRouter Documentation -'og:title': Format Type | OpenRouter TypeScript SDK -'og:description': >- - Format type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Format%20-%20TypeScript%20SDK&description=Format%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.FormatText` - -```typescript lines -const value: models.FormatText = { - type: "text", -}; -``` - -### `models.FormatGrammar` - -```typescript lines -const value: models.FormatGrammar = { - definition: "", - syntax: "lark", - type: "grammar", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formatenum.mdx b/client-sdks/typescript/api-reference/models/formatenum.mdx deleted file mode 100644 index 4d267ef2..00000000 --- a/client-sdks/typescript/api-reference/models/formatenum.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormatEnum - TypeScript SDK -sidebarTitle: FormatEnum -description: FormatEnum type definition -seoTitle: FormatEnum Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/formatenum' -'og:site_name': OpenRouter Documentation -'og:title': FormatEnum Type | OpenRouter TypeScript SDK -'og:description': >- - FormatEnum type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatEnum%20-%20TypeScript%20SDK&description=FormatEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FormatEnum } from "@openrouter/sdk/models"; - -let value: FormatEnum = "wav"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"mp3" | "wav" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formatgrammar.mdx b/client-sdks/typescript/api-reference/models/formatgrammar.mdx deleted file mode 100644 index 4d8eacd4..00000000 --- a/client-sdks/typescript/api-reference/models/formatgrammar.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FormatGrammar - TypeScript SDK -sidebarTitle: FormatGrammar -description: FormatGrammar type definition -seoTitle: FormatGrammar Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/formatgrammar' -'og:site_name': OpenRouter Documentation -'og:title': FormatGrammar Type | OpenRouter TypeScript SDK -'og:description': >- - FormatGrammar type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatGrammar%20-%20TypeScript%20SDK&description=FormatGrammar%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FormatGrammar } from "@openrouter/sdk/models"; - -let value: FormatGrammar = { - definition: "", - syntax: "lark", - type: "grammar", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `definition` | *string* | :heavy_check_mark: | N/A | -| `syntax` | [models.Syntax](/client-sdks/typescript/api-reference/models/syntax) | :heavy_check_mark: | N/A | -| `type` | *"grammar"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formatjsonobjectconfig.mdx b/client-sdks/typescript/api-reference/models/formatjsonobjectconfig.mdx deleted file mode 100644 index 0a4af989..00000000 --- a/client-sdks/typescript/api-reference/models/formatjsonobjectconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FormatJsonObjectConfig - TypeScript SDK -sidebarTitle: FormatJsonObjectConfig -description: FormatJsonObjectConfig type definition -seoTitle: FormatJsonObjectConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/formatjsonobjectconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatJsonObjectConfig Type | OpenRouter TypeScript SDK -'og:description': >- - FormatJsonObjectConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJsonObjectConfig%20-%20TypeScript%20SDK&description=FormatJsonObjectConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON object response format - -## Example Usage - -```typescript lines -import { FormatJsonObjectConfig } from "@openrouter/sdk/models"; - -let value: FormatJsonObjectConfig = { - type: "json_object", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formatjsonschemaconfig.mdx b/client-sdks/typescript/api-reference/models/formatjsonschemaconfig.mdx deleted file mode 100644 index 0572c303..00000000 --- a/client-sdks/typescript/api-reference/models/formatjsonschemaconfig.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: FormatJsonSchemaConfig - TypeScript SDK -sidebarTitle: FormatJsonSchemaConfig -description: FormatJsonSchemaConfig type definition -seoTitle: FormatJsonSchemaConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/formatjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatJsonSchemaConfig Type | OpenRouter TypeScript SDK -'og:description': >- - FormatJsonSchemaConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatJsonSchemaConfig%20-%20TypeScript%20SDK&description=FormatJsonSchemaConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON schema constrained response format - -## Example Usage - -```typescript lines -import { FormatJsonSchemaConfig } from "@openrouter/sdk/models"; - -let value: FormatJsonSchemaConfig = { - name: "", - schema: { - "key": "", - }, - type: "json_schema", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `schema` | `Record` | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formats.mdx b/client-sdks/typescript/api-reference/models/formats.mdx deleted file mode 100644 index f43978f0..00000000 --- a/client-sdks/typescript/api-reference/models/formats.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Formats - TypeScript SDK -sidebarTitle: Formats -description: Formats type definition -seoTitle: Formats Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/formats' -'og:site_name': OpenRouter Documentation -'og:title': Formats Type | OpenRouter TypeScript SDK -'og:description': >- - Formats type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Formats%20-%20TypeScript%20SDK&description=Formats%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text response format configuration - -## Supported Types - -### `models.FormatTextConfig` - -```typescript lines -const value: models.FormatTextConfig = { - type: "text", -}; -``` - -### `models.FormatJsonObjectConfig` - -```typescript lines -const value: models.FormatJsonObjectConfig = { - type: "json_object", -}; -``` - -### `models.FormatJsonSchemaConfig` - -```typescript lines -const value: models.FormatJsonSchemaConfig = { - name: "", - schema: {}, - type: "json_schema", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formattext.mdx b/client-sdks/typescript/api-reference/models/formattext.mdx deleted file mode 100644 index 92bca361..00000000 --- a/client-sdks/typescript/api-reference/models/formattext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FormatText - TypeScript SDK -sidebarTitle: FormatText -description: FormatText type definition -seoTitle: FormatText Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/formattext' -'og:site_name': OpenRouter Documentation -'og:title': FormatText Type | OpenRouter TypeScript SDK -'og:description': >- - FormatText type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatText%20-%20TypeScript%20SDK&description=FormatText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FormatText } from "@openrouter/sdk/models"; - -let value: FormatText = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/formattextconfig.mdx b/client-sdks/typescript/api-reference/models/formattextconfig.mdx deleted file mode 100644 index 61393b05..00000000 --- a/client-sdks/typescript/api-reference/models/formattextconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FormatTextConfig - TypeScript SDK -sidebarTitle: FormatTextConfig -description: FormatTextConfig type definition -seoTitle: FormatTextConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/formattextconfig -'og:site_name': OpenRouter Documentation -'og:title': FormatTextConfig Type | OpenRouter TypeScript SDK -'og:description': >- - FormatTextConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FormatTextConfig%20-%20TypeScript%20SDK&description=FormatTextConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Plain text response format - -## Example Usage - -```typescript lines -import { FormatTextConfig } from "@openrouter/sdk/models"; - -let value: FormatTextConfig = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/frameimage.mdx b/client-sdks/typescript/api-reference/models/frameimage.mdx deleted file mode 100644 index 3b1e9660..00000000 --- a/client-sdks/typescript/api-reference/models/frameimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FrameImage - TypeScript SDK -sidebarTitle: FrameImage -description: FrameImage type definition -seoTitle: FrameImage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/frameimage' -'og:site_name': OpenRouter Documentation -'og:title': FrameImage Type | OpenRouter TypeScript SDK -'og:description': >- - FrameImage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImage%20-%20TypeScript%20SDK&description=FrameImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FrameImage } from "@openrouter/sdk/models"; - -let value: FrameImage = { - imageUrl: { - url: "https://example.com/image.png", - }, - type: "image_url", - frameType: "first_frame", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `imageUrl` | [models.FrameImageImageUrl](/client-sdks/typescript/api-reference/models/frameimageimageurl) | :heavy_check_mark: | N/A | | -| `type` | [models.FrameImageType](/client-sdks/typescript/api-reference/models/frameimagetype) | :heavy_check_mark: | N/A | | -| `frameType` | [models.FrameType](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/frameimageimageurl.mdx b/client-sdks/typescript/api-reference/models/frameimageimageurl.mdx deleted file mode 100644 index 1d3aa44d..00000000 --- a/client-sdks/typescript/api-reference/models/frameimageimageurl.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FrameImageImageUrl - TypeScript SDK -sidebarTitle: FrameImageImageUrl -description: FrameImageImageUrl type definition -seoTitle: FrameImageImageUrl Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/frameimageimageurl -'og:site_name': OpenRouter Documentation -'og:title': FrameImageImageUrl Type | OpenRouter TypeScript SDK -'og:description': >- - FrameImageImageUrl type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageImageUrl%20-%20TypeScript%20SDK&description=FrameImageImageUrl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FrameImageImageUrl } from "@openrouter/sdk/models"; - -let value: FrameImageImageUrl = { - url: "https://responsible-conservation.org", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/frameimagetype.mdx b/client-sdks/typescript/api-reference/models/frameimagetype.mdx deleted file mode 100644 index d690b7ea..00000000 --- a/client-sdks/typescript/api-reference/models/frameimagetype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: FrameImageType - TypeScript SDK -sidebarTitle: FrameImageType -description: FrameImageType type definition -seoTitle: FrameImageType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/frameimagetype' -'og:site_name': OpenRouter Documentation -'og:title': FrameImageType Type | OpenRouter TypeScript SDK -'og:description': >- - FrameImageType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameImageType%20-%20TypeScript%20SDK&description=FrameImageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FrameImageType } from "@openrouter/sdk/models"; - -let value: FrameImageType = "image_url"; -``` - -## Values - -```typescript lines -"image_url" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/frametype.mdx b/client-sdks/typescript/api-reference/models/frametype.mdx deleted file mode 100644 index af2e4743..00000000 --- a/client-sdks/typescript/api-reference/models/frametype.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: FrameType - TypeScript SDK -sidebarTitle: FrameType -description: FrameType type definition -seoTitle: FrameType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/frametype' -'og:site_name': OpenRouter Documentation -'og:title': FrameType Type | OpenRouter TypeScript SDK -'og:description': >- - FrameType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FrameType%20-%20TypeScript%20SDK&description=FrameType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Whether this image represents the first or last frame of the video - -## Example Usage - -```typescript lines -import { FrameType } from "@openrouter/sdk/models"; - -let value: FrameType = "first_frame"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"first_frame" | "last_frame" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncallargsdeltaevent.mdx b/client-sdks/typescript/api-reference/models/functioncallargsdeltaevent.mdx deleted file mode 100644 index 0ce168bc..00000000 --- a/client-sdks/typescript/api-reference/models/functioncallargsdeltaevent.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: FunctionCallArgsDeltaEvent - TypeScript SDK -sidebarTitle: FunctionCallArgsDeltaEvent -description: FunctionCallArgsDeltaEvent type definition -seoTitle: FunctionCallArgsDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncallargsdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallArgsDeltaEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDeltaEvent%20-%20TypeScript%20SDK&description=FunctionCallArgsDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments are being streamed - -## Example Usage - -```typescript lines -import { FunctionCallArgsDeltaEvent } from "@openrouter/sdk/models"; - -let value: FunctionCallArgsDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 986115, - sequenceNumber: 0, - type: "response.function_call_arguments.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.function_call_arguments.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncallargsdoneevent.mdx b/client-sdks/typescript/api-reference/models/functioncallargsdoneevent.mdx deleted file mode 100644 index 670f225e..00000000 --- a/client-sdks/typescript/api-reference/models/functioncallargsdoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: FunctionCallArgsDoneEvent - TypeScript SDK -sidebarTitle: FunctionCallArgsDoneEvent -description: FunctionCallArgsDoneEvent type definition -seoTitle: FunctionCallArgsDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncallargsdoneevent -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallArgsDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallArgsDoneEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallArgsDoneEvent%20-%20TypeScript%20SDK&description=FunctionCallArgsDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments streaming is complete - -## Example Usage - -```typescript lines -import { FunctionCallArgsDoneEvent } from "@openrouter/sdk/models"; - -let value: FunctionCallArgsDoneEvent = { - arguments: "", - itemId: "", - name: "", - outputIndex: 51328, - sequenceNumber: 0, - type: "response.function_call_arguments.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.function_call_arguments.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncallitem.mdx b/client-sdks/typescript/api-reference/models/functioncallitem.mdx deleted file mode 100644 index ade63760..00000000 --- a/client-sdks/typescript/api-reference/models/functioncallitem.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: FunctionCallItem - TypeScript SDK -sidebarTitle: FunctionCallItem -description: FunctionCallItem type definition -seoTitle: FunctionCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncallitem -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItem%20-%20TypeScript%20SDK&description=FunctionCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A function call initiated by the model - -## Example Usage - -```typescript lines -import { FunctionCallItem } from "@openrouter/sdk/models"; - -let value: FunctionCallItem = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - id: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `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` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.FunctionCallItemType](/client-sdks/typescript/api-reference/models/functioncallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncallitemtype.mdx b/client-sdks/typescript/api-reference/models/functioncallitemtype.mdx deleted file mode 100644 index 5fd7e901..00000000 --- a/client-sdks/typescript/api-reference/models/functioncallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FunctionCallItemType - TypeScript SDK -sidebarTitle: FunctionCallItemType -description: FunctionCallItemType type definition -seoTitle: FunctionCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncallitemtype -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallItemType%20-%20TypeScript%20SDK&description=FunctionCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FunctionCallItemType } from "@openrouter/sdk/models"; - -let value: FunctionCallItemType = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitem.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitem.mdx deleted file mode 100644 index 9a2edfd3..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: FunctionCallOutputItem - TypeScript SDK -sidebarTitle: FunctionCallOutputItem -description: FunctionCallOutputItem type definition -seoTitle: FunctionCallOutputItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItem Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItem%20-%20TypeScript%20SDK&description=FunctionCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The output from a function call execution - -## Example Usage - -```typescript lines -import { FunctionCallOutputItem } from "@openrouter/sdk/models"; - -let value: FunctionCallOutputItem = { - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", - type: "function_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `output` | *models.FunctionCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | | -| `status` | [models.FunctionCallOutputItemStatus](/client-sdks/typescript/api-reference/models/functioncalloutputitemstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.FunctionCallOutputItemTypeFunctionCallOutput](/client-sdks/typescript/api-reference/models/functioncalloutputitemtypefunctioncalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemdetail.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemdetail.mdx deleted file mode 100644 index 6e4fd47b..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemdetail.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallOutputItemDetail - TypeScript SDK -sidebarTitle: FunctionCallOutputItemDetail -description: FunctionCallOutputItemDetail type definition -seoTitle: FunctionCallOutputItemDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemdetail -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemDetail Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemDetail type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemDetail%20-%20TypeScript%20SDK&description=FunctionCallOutputItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FunctionCallOutputItemDetail } from "@openrouter/sdk/models"; - -let value: FunctionCallOutputItemDetail = "high"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "high" | "low" | "original" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputinputimage.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputinputimage.mdx deleted file mode 100644 index 9bf82b8f..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FunctionCallOutputItemOutputInputImage - TypeScript SDK -sidebarTitle: FunctionCallOutputItemOutputInputImage -description: FunctionCallOutputItemOutputInputImage type definition -seoTitle: FunctionCallOutputItemOutputInputImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemoutputinputimage -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputInputImage Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemOutputInputImage type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputInputImage%20-%20TypeScript%20SDK&description=FunctionCallOutputItemOutputInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { FunctionCallOutputItemOutputInputImage } from "@openrouter/sdk/models"; - -let value: FunctionCallOutputItemOutputInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `detail` | [models.FunctionCallOutputItemDetail](/client-sdks/typescript/api-reference/models/functioncalloutputitemdetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion1.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion1.mdx deleted file mode 100644 index 96ae7cef..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion1.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion1 - TypeScript SDK -sidebarTitle: FunctionCallOutputItemOutputUnion1 -description: FunctionCallOutputItemOutputUnion1 type definition -seoTitle: FunctionCallOutputItemOutputUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemoutputunion1 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemOutputUnion1 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion1%20-%20TypeScript%20SDK&description=FunctionCallOutputItemOutputUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -### `models.FunctionCallOutputItemOutputInputImage` - -```typescript lines -const value: models.FunctionCallOutputItemOutputInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion2.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion2.mdx deleted file mode 100644 index 89d210e2..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemoutputunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: FunctionCallOutputItemOutputUnion2 - TypeScript SDK -sidebarTitle: FunctionCallOutputItemOutputUnion2 -description: FunctionCallOutputItemOutputUnion2 type definition -seoTitle: FunctionCallOutputItemOutputUnion2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemoutputunion2 -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemOutputUnion2 Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemOutputUnion2 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemOutputUnion2%20-%20TypeScript%20SDK&description=FunctionCallOutputItemOutputUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.FunctionCallOutputItemOutputUnion1[]` - -```typescript lines -const value: models.FunctionCallOutputItemOutputUnion1[] = []; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemstatus.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemstatus.mdx deleted file mode 100644 index 21bd1ee2..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: FunctionCallOutputItemStatus - TypeScript SDK -sidebarTitle: FunctionCallOutputItemStatus -description: FunctionCallOutputItemStatus type definition -seoTitle: FunctionCallOutputItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemStatus type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemStatus%20-%20TypeScript%20SDK&description=FunctionCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FunctionCallOutputItemStatus } from "@openrouter/sdk/models"; - -let value: FunctionCallOutputItemStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx b/client-sdks/typescript/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx deleted file mode 100644 index f188ddfa..00000000 --- a/client-sdks/typescript/api-reference/models/functioncalloutputitemtypefunctioncalloutput.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: FunctionCallOutputItemTypeFunctionCallOutput - TypeScript SDK -sidebarTitle: FunctionCallOutputItemTypeFunctionCallOutput -description: FunctionCallOutputItemTypeFunctionCallOutput type definition -seoTitle: FunctionCallOutputItemTypeFunctionCallOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/functioncalloutputitemtypefunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': FunctionCallOutputItemTypeFunctionCallOutput Type | OpenRouter TypeScript SDK -'og:description': >- - FunctionCallOutputItemTypeFunctionCallOutput type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FunctionCallOutputItemTypeFunctionCallOutput%20-%20TypeScript%20SDK&description=FunctionCallOutputItemTypeFunctionCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FunctionCallOutputItemTypeFunctionCallOutput } from "@openrouter/sdk/models"; - -let value: FunctionCallOutputItemTypeFunctionCallOutput = - "function_call_output"; -``` - -## Values - -```typescript lines -"function_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/fusionplugin.mdx b/client-sdks/typescript/api-reference/models/fusionplugin.mdx deleted file mode 100644 index ecf56f74..00000000 --- a/client-sdks/typescript/api-reference/models/fusionplugin.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FusionPlugin - TypeScript SDK -sidebarTitle: FusionPlugin -description: FusionPlugin type definition -seoTitle: FusionPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/fusionplugin' -'og:site_name': OpenRouter Documentation -'og:title': FusionPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - FusionPlugin type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionPlugin%20-%20TypeScript%20SDK&description=FusionPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FusionPlugin } from "@openrouter/sdk/models"; - -let value: FusionPlugin = { - id: "fusion", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysisModels` | *string*[] | :heavy_minus_sign: | Slugs of models to run in parallel as the "expert panel" the judge 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` | *boolean* | :heavy_minus_sign: | Set to false to disable the fusion plugin for this request. Defaults to true. | | -| `id` | *"fusion"* | :heavy_check_mark: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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 judge 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 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/fusionservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/fusionservertoolconfig.mdx deleted file mode 100644 index c78cfd27..00000000 --- a/client-sdks/typescript/api-reference/models/fusionservertoolconfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: FusionServerToolConfig - TypeScript SDK -sidebarTitle: FusionServerToolConfig -description: FusionServerToolConfig type definition -seoTitle: FusionServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/fusionservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - FusionServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfig%20-%20TypeScript%20SDK&description=FusionServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:fusion server tool. - -## Example Usage - -```typescript lines -import { FusionServerToolConfig } from "@openrouter/sdk/models"; - -let value: FusionServerToolConfig = {}; -``` - -## Fields - -| 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 a judge 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"
] | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the judge 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, the provider's default applies. | 16384 | -| `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the judge 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 judge model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `reasoning` | [models.FusionServerToolConfigReasoning](/client-sdks/typescript/api-reference/models/fusionservertoolconfigreasoning) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature forwarded to panelist and judge inner calls. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/fusionservertoolconfigeffort.mdx b/client-sdks/typescript/api-reference/models/fusionservertoolconfigeffort.mdx deleted file mode 100644 index ac5e08fb..00000000 --- a/client-sdks/typescript/api-reference/models/fusionservertoolconfigeffort.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FusionServerToolConfigEffort - TypeScript SDK -sidebarTitle: FusionServerToolConfigEffort -description: FusionServerToolConfigEffort type definition -seoTitle: FusionServerToolConfigEffort Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/fusionservertoolconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigEffort Type | OpenRouter TypeScript SDK -'og:description': >- - FusionServerToolConfigEffort type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigEffort%20-%20TypeScript%20SDK&description=FusionServerToolConfigEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning effort level for panelist and judge inner calls. - -## Example Usage - -```typescript lines -import { FusionServerToolConfigEffort } from "@openrouter/sdk/models"; - -let value: FusionServerToolConfigEffort = "high"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"xhigh" | "high" | "medium" | "low" | "minimal" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/fusionservertoolconfigreasoning.mdx b/client-sdks/typescript/api-reference/models/fusionservertoolconfigreasoning.mdx deleted file mode 100644 index 1799a485..00000000 --- a/client-sdks/typescript/api-reference/models/fusionservertoolconfigreasoning.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: FusionServerToolConfigReasoning - TypeScript SDK -sidebarTitle: FusionServerToolConfigReasoning -description: FusionServerToolConfigReasoning type definition -seoTitle: FusionServerToolConfigReasoning Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/fusionservertoolconfigreasoning -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolConfigReasoning Type | OpenRouter TypeScript SDK -'og:description': >- - FusionServerToolConfigReasoning type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolConfigReasoning%20-%20TypeScript%20SDK&description=FusionServerToolConfigReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning configuration forwarded to panelist and judge inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. - -## Example Usage - -```typescript lines -import { FusionServerToolConfigReasoning } from "@openrouter/sdk/models"; - -let value: FusionServerToolConfigReasoning = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [models.FusionServerToolConfigEffort](/client-sdks/typescript/api-reference/models/fusionservertoolconfigeffort) | :heavy_minus_sign: | Reasoning effort level for panelist and judge inner calls. | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and judge 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/client-sdks/typescript/api-reference/models/fusionservertoolopenrouter.mdx b/client-sdks/typescript/api-reference/models/fusionservertoolopenrouter.mdx deleted file mode 100644 index 14c6a097..00000000 --- a/client-sdks/typescript/api-reference/models/fusionservertoolopenrouter.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: FusionServerToolOpenRouter - TypeScript SDK -sidebarTitle: FusionServerToolOpenRouter -description: FusionServerToolOpenRouter type definition -seoTitle: FusionServerToolOpenRouter Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/fusionservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': FusionServerToolOpenRouter Type | OpenRouter TypeScript SDK -'og:description': >- - FusionServerToolOpenRouter type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FusionServerToolOpenRouter%20-%20TypeScript%20SDK&description=FusionServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fans out the user prompt to a panel of analysis models, then asks a judge model to summarize their collective output as structured JSON the outer model can synthesize from. - -## Example Usage - -```typescript lines -import { FusionServerToolOpenRouter } from "@openrouter/sdk/models"; - -let value: FusionServerToolOpenRouter = { - type: "openrouter:fusion", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.FusionServerToolConfig](/client-sdks/typescript/api-reference/models/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` | *"openrouter:fusion"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/generationcontentdata.mdx b/client-sdks/typescript/api-reference/models/generationcontentdata.mdx deleted file mode 100644 index d161d791..00000000 --- a/client-sdks/typescript/api-reference/models/generationcontentdata.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: GenerationContentData - TypeScript SDK -sidebarTitle: GenerationContentData -description: GenerationContentData type definition -seoTitle: GenerationContentData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/generationcontentdata -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentData Type | OpenRouter TypeScript SDK -'og:description': >- - GenerationContentData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentData%20-%20TypeScript%20SDK&description=GenerationContentData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content - -## Example Usage - -```typescript lines -import { GenerationContentData } from "@openrouter/sdk/models"; - -let value: GenerationContentData = { - input: { - messages: [ - { - "content": "What is the meaning of life?", - "role": "user", - }, - ], - }, - output: { - completion: "The meaning of life is a philosophical question...", - reasoning: null, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `input` | *models.InputUnion* | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | -| `output` | [models.GenerationContentDataOutput](/client-sdks/typescript/api-reference/models/generationcontentdataoutput) | :heavy_check_mark: | The output from the generation | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/generationcontentdataoutput.mdx b/client-sdks/typescript/api-reference/models/generationcontentdataoutput.mdx deleted file mode 100644 index c3a60ad9..00000000 --- a/client-sdks/typescript/api-reference/models/generationcontentdataoutput.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: GenerationContentDataOutput - TypeScript SDK -sidebarTitle: GenerationContentDataOutput -description: GenerationContentDataOutput type definition -seoTitle: GenerationContentDataOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/generationcontentdataoutput -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentDataOutput Type | OpenRouter TypeScript SDK -'og:description': >- - GenerationContentDataOutput type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentDataOutput%20-%20TypeScript%20SDK&description=GenerationContentDataOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The output from the generation - -## Example Usage - -```typescript lines -import { GenerationContentDataOutput } from "@openrouter/sdk/models"; - -let value: GenerationContentDataOutput = { - completion: "The meaning of life is a philosophical question...", - reasoning: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `completion` | *string* | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `reasoning` | *string* | :heavy_check_mark: | Reasoning/thinking output, if any | `` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/generationcontentresponse.mdx b/client-sdks/typescript/api-reference/models/generationcontentresponse.mdx deleted file mode 100644 index a11de625..00000000 --- a/client-sdks/typescript/api-reference/models/generationcontentresponse.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: GenerationContentResponse - TypeScript SDK -sidebarTitle: GenerationContentResponse -description: GenerationContentResponse type definition -seoTitle: GenerationContentResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/generationcontentresponse -'og:site_name': OpenRouter Documentation -'og:title': GenerationContentResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GenerationContentResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationContentResponse%20-%20TypeScript%20SDK&description=GenerationContentResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stored prompt and completion content for a generation - -## Example Usage - -```typescript lines -import { GenerationContentResponse } from "@openrouter/sdk/models"; - -let value: GenerationContentResponse = { - data: { - input: { - messages: [ - { - "content": "What is the meaning of life?", - "role": "user", - }, - ], - }, - output: { - completion: "The meaning of life is a philosophical question...", - reasoning: null, - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.GenerationContentData](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/generationresponse.mdx b/client-sdks/typescript/api-reference/models/generationresponse.mdx deleted file mode 100644 index 2f068b1c..00000000 --- a/client-sdks/typescript/api-reference/models/generationresponse.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: GenerationResponse - TypeScript SDK -sidebarTitle: GenerationResponse -description: GenerationResponse type definition -seoTitle: GenerationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/generationresponse -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GenerationResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponse%20-%20TypeScript%20SDK&description=GenerationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Generation response - -## Example Usage - -```typescript expandable lines -import { GenerationResponse } from "@openrouter/sdk/models"; - -let value: GenerationResponse = { - data: { - apiType: "completions", - appId: 12345, - cacheDiscount: null, - cancelled: false, - createdAt: "2024-07-15T23:33:19.433273+00:00", - externalUser: "user-123", - finishReason: "stop", - generationTime: 1200, - httpReferer: "https://openrouter.ai/", - id: "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", - isByok: false, - latency: 1250, - model: "sao10k/l3-stheno-8b", - moderationLatency: 50, - nativeFinishReason: "stop", - nativeTokensCached: 3, - nativeTokensCompletion: 25, - nativeTokensCompletionImages: 0, - nativeTokensPrompt: 10, - nativeTokensReasoning: 5, - numFetches: 0, - numInputAudioPrompt: 0, - numMediaCompletion: 0, - numMediaPrompt: 1, - numSearchResults: 5, - origin: "https://openrouter.ai/", - presetId: "a9e8d400-592a-494f-908c-375efa66cafd", - providerName: "Infermatic", - providerResponses: null, - router: "openrouter/auto", - serviceTier: "priority", - streamed: true, - tokensCompletion: 25, - tokensPrompt: 10, - totalCost: 0.0015, - upstreamId: "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", - upstreamInferenceCost: 0.0012, - usage: 0.0015, - userAgent: "Mozilla/5.0", - webSearchEngine: "exa", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | [models.GenerationResponseData](/client-sdks/typescript/api-reference/models/generationresponsedata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/generationresponsedata.mdx b/client-sdks/typescript/api-reference/models/generationresponsedata.mdx deleted file mode 100644 index 0d1a677c..00000000 --- a/client-sdks/typescript/api-reference/models/generationresponsedata.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: GenerationResponseData - TypeScript SDK -sidebarTitle: GenerationResponseData -description: GenerationResponseData type definition -seoTitle: GenerationResponseData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/generationresponsedata -'og:site_name': OpenRouter Documentation -'og:title': GenerationResponseData Type | OpenRouter TypeScript SDK -'og:description': >- - GenerationResponseData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GenerationResponseData%20-%20TypeScript%20SDK&description=GenerationResponseData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Generation data - -## Example Usage - -```typescript expandable lines -import { GenerationResponseData } from "@openrouter/sdk/models"; - -let value: GenerationResponseData = { - apiType: "tts", - appId: 12345, - cacheDiscount: 0.0002, - cancelled: false, - createdAt: "2024-07-15T23:33:19.433273+00:00", - externalUser: "user-123", - finishReason: "stop", - generationTime: 1200, - httpReferer: "", - id: "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", - isByok: false, - latency: 1250, - model: "sao10k/l3-stheno-8b", - moderationLatency: 50, - nativeFinishReason: "stop", - nativeTokensCached: 3, - nativeTokensCompletion: 25, - nativeTokensCompletionImages: 0, - nativeTokensPrompt: 10, - nativeTokensReasoning: 5, - numFetches: 0, - numInputAudioPrompt: 0, - numMediaCompletion: 0, - numMediaPrompt: 1, - numSearchResults: 5, - origin: "https://openrouter.ai/", - presetId: "a9e8d400-592a-494f-908c-375efa66cafd", - providerName: "Infermatic", - providerResponses: [ - { - status: 200, - }, - ], - router: "openrouter/auto", - serviceTier: "priority", - streamed: true, - tokensCompletion: 25, - tokensPrompt: 10, - totalCost: 0.0015, - upstreamId: "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", - upstreamInferenceCost: 0.0012, - usage: 0.0015, - userAgent: "", - webSearchEngine: "exa", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `apiType` | [models.ApiType](/client-sdks/typescript/api-reference/models/apitype) | :heavy_check_mark: | Type of API used for the generation | | -| `appId` | *number* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `cacheDiscount` | *number* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `cancelled` | *boolean* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `externalUser` | *string* | :heavy_check_mark: | External user identifier | user-123 | -| `finishReason` | *string* | :heavy_check_mark: | Reason the generation finished | stop | -| `generationTime` | *number* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `httpReferer` | *string* | :heavy_check_mark: | Referer header from the request | | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `isByok` | *boolean* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `latency` | *number* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `model` | *string* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `moderationLatency` | *number* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `nativeFinishReason` | *string* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `nativeTokensCached` | *number* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `nativeTokensCompletion` | *number* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `nativeTokensCompletionImages` | *number* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `nativeTokensPrompt` | *number* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `nativeTokensReasoning` | *number* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `numFetches` | *number* | :heavy_check_mark: | Number of web fetches performed | 0 | -| `numInputAudioPrompt` | *number* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `numMediaCompletion` | *number* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `numMediaPrompt` | *number* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `numSearchResults` | *number* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *string* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `providerResponses` | [models.ProviderResponse](/client-sdks/typescript/api-reference/models/providerresponse)[] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | -| `requestId` | *string* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `responseCacheSourceId` | *string* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `router` | *string* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `serviceTier` | *string* | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `sessionId` | *string* | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `streamed` | *boolean* | :heavy_check_mark: | Whether the response was streamed | true | -| `tokensCompletion` | *number* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `tokensPrompt` | *number* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `totalCost` | *number* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `upstreamId` | *string* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `upstreamInferenceCost` | *number* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `usage` | *number* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `userAgent` | *string* | :heavy_check_mark: | User-Agent header from the request | | -| `webSearchEngine` | *string* | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/getbyokkeyresponse.mdx b/client-sdks/typescript/api-reference/models/getbyokkeyresponse.mdx deleted file mode 100644 index 3459a361..00000000 --- a/client-sdks/typescript/api-reference/models/getbyokkeyresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: GetBYOKKeyResponse - TypeScript SDK -sidebarTitle: GetBYOKKeyResponse -description: GetBYOKKeyResponse type definition -seoTitle: GetBYOKKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/getbyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetBYOKKeyResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyResponse%20-%20TypeScript%20SDK&description=GetBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetBYOKKeyResponse } from "@openrouter/sdk/models"; - -let value: GetBYOKKeyResponse = { - data: { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/getguardrailresponse.mdx b/client-sdks/typescript/api-reference/models/getguardrailresponse.mdx deleted file mode 100644 index 3c9ab57a..00000000 --- a/client-sdks/typescript/api-reference/models/getguardrailresponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: GetGuardrailResponse - TypeScript SDK -sidebarTitle: GetGuardrailResponse -description: GetGuardrailResponse type definition -seoTitle: GetGuardrailResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/getguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResponse%20-%20TypeScript%20SDK&description=GetGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGuardrailResponse } from "@openrouter/sdk/models"; - -let value: GetGuardrailResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](/client-sdks/typescript/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/typescript/api-reference/models/getobservabilitydestinationresponse.mdx b/client-sdks/typescript/api-reference/models/getobservabilitydestinationresponse.mdx deleted file mode 100644 index 1fa36870..00000000 --- a/client-sdks/typescript/api-reference/models/getobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: GetObservabilityDestinationResponse - TypeScript SDK -sidebarTitle: GetObservabilityDestinationResponse -description: GetObservabilityDestinationResponse type definition -seoTitle: GetObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/getobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetObservabilityDestinationResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationResponse%20-%20TypeScript%20SDK&description=GetObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { GetObservabilityDestinationResponse } from "@openrouter/sdk/models"; - -let value: GetObservabilityDestinationResponse = { - data: { - apiKeyHashes: null, - config: { - baseUrl: "https://us.cloud.langfuse.com", - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.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/client-sdks/typescript/api-reference/models/getworkspaceresponse.mdx b/client-sdks/typescript/api-reference/models/getworkspaceresponse.mdx deleted file mode 100644 index 9d2644ca..00000000 --- a/client-sdks/typescript/api-reference/models/getworkspaceresponse.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: GetWorkspaceResponse - TypeScript SDK -sidebarTitle: GetWorkspaceResponse -description: GetWorkspaceResponse type definition -seoTitle: GetWorkspaceResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/getworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetWorkspaceResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceResponse%20-%20TypeScript%20SDK&description=GetWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { GetWorkspaceResponse } from "@openrouter/sdk/models"; - -let value: GetWorkspaceResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Production", - slug: "production", - updatedAt: "2025-08-24T15:45:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](/client-sdks/typescript/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/typescript/api-reference/models/group.mdx b/client-sdks/typescript/api-reference/models/group.mdx deleted file mode 100644 index 76bf71ae..00000000 --- a/client-sdks/typescript/api-reference/models/group.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Group - TypeScript SDK -sidebarTitle: Group -description: Group type definition -seoTitle: Group Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/group' -'og:site_name': OpenRouter Documentation -'og:title': Group Type | OpenRouter TypeScript SDK -'og:description': >- - Group type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Group%20-%20TypeScript%20SDK&description=Group%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Group } from "@openrouter/sdk/models"; - -let value: Group = { - rules: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `logic` | [models.Logic](/client-sdks/typescript/api-reference/models/logic) | :heavy_minus_sign: | N/A | -| `rules` | [models.Rule](/client-sdks/typescript/api-reference/models/rule)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/guardrail.mdx b/client-sdks/typescript/api-reference/models/guardrail.mdx deleted file mode 100644 index 6a69fd98..00000000 --- a/client-sdks/typescript/api-reference/models/guardrail.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Guardrail - TypeScript SDK -sidebarTitle: Guardrail -description: Guardrail type definition -seoTitle: Guardrail Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/guardrail' -'og:site_name': OpenRouter Documentation -'og:title': Guardrail Type | OpenRouter TypeScript SDK -'og:description': >- - Guardrail type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Guardrail%20-%20TypeScript%20SDK&description=Guardrail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Guardrail } from "@openrouter/sdk/models"; - -let value: Guardrail = { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntry](/client-sdks/typescript/api-reference/models/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` | [models.ContentFilterEntry](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | false | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `resetInterval` | [models.GuardrailInterval](/client-sdks/typescript/api-reference/models/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this guardrail belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/guardrailinterval.mdx b/client-sdks/typescript/api-reference/models/guardrailinterval.mdx deleted file mode 100644 index cb5adcac..00000000 --- a/client-sdks/typescript/api-reference/models/guardrailinterval.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: GuardrailInterval - TypeScript SDK -sidebarTitle: GuardrailInterval -description: GuardrailInterval type definition -seoTitle: GuardrailInterval Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/guardrailinterval -'og:site_name': OpenRouter Documentation -'og:title': GuardrailInterval Type | OpenRouter TypeScript SDK -'og:description': >- - GuardrailInterval type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GuardrailInterval%20-%20TypeScript%20SDK&description=GuardrailInterval%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { GuardrailInterval } from "@openrouter/sdk/models"; - -let value: GuardrailInterval = "monthly"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/ignore.mdx b/client-sdks/typescript/api-reference/models/ignore.mdx deleted file mode 100644 index 3dbd533c..00000000 --- a/client-sdks/typescript/api-reference/models/ignore.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Ignore - TypeScript SDK -sidebarTitle: Ignore -description: Ignore type definition -seoTitle: Ignore Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/ignore' -'og:site_name': OpenRouter Documentation -'og:title': Ignore Type | OpenRouter TypeScript SDK -'og:description': >- - Ignore type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ignore%20-%20TypeScript%20SDK&description=Ignore%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imageconfig.mdx b/client-sdks/typescript/api-reference/models/imageconfig.mdx deleted file mode 100644 index eca798d5..00000000 --- a/client-sdks/typescript/api-reference/models/imageconfig.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ImageConfig - TypeScript SDK -sidebarTitle: ImageConfig -description: ImageConfig type definition -seoTitle: ImageConfig Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/imageconfig' -'og:site_name': OpenRouter Documentation -'og:title': ImageConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ImageConfig type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageConfig%20-%20TypeScript%20SDK&description=ImageConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` - -### `any[]` - -```typescript lines -const value: any[] = [ - "", - "", - "", -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegencallcompletedevent.mdx b/client-sdks/typescript/api-reference/models/imagegencallcompletedevent.mdx deleted file mode 100644 index 060157cf..00000000 --- a/client-sdks/typescript/api-reference/models/imagegencallcompletedevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ImageGenCallCompletedEvent - TypeScript SDK -sidebarTitle: ImageGenCallCompletedEvent -description: ImageGenCallCompletedEvent type definition -seoTitle: ImageGenCallCompletedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegencallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallCompletedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenCallCompletedEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallCompletedEvent%20-%20TypeScript%20SDK&description=ImageGenCallCompletedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call completed - -## Example Usage - -```typescript lines -import { ImageGenCallCompletedEvent } from "@openrouter/sdk/models"; - -let value: ImageGenCallCompletedEvent = { - itemId: "", - outputIndex: 56929, - sequenceNumber: 0, - type: "response.image_generation_call.completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegencallgeneratingevent.mdx b/client-sdks/typescript/api-reference/models/imagegencallgeneratingevent.mdx deleted file mode 100644 index 00d53255..00000000 --- a/client-sdks/typescript/api-reference/models/imagegencallgeneratingevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ImageGenCallGeneratingEvent - TypeScript SDK -sidebarTitle: ImageGenCallGeneratingEvent -description: ImageGenCallGeneratingEvent type definition -seoTitle: ImageGenCallGeneratingEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegencallgeneratingevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallGeneratingEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenCallGeneratingEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallGeneratingEvent%20-%20TypeScript%20SDK&description=ImageGenCallGeneratingEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call is generating - -## Example Usage - -```typescript lines -import { ImageGenCallGeneratingEvent } from "@openrouter/sdk/models"; - -let value: ImageGenCallGeneratingEvent = { - itemId: "", - outputIndex: 672800, - sequenceNumber: 0, - type: "response.image_generation_call.generating", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.generating"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegencallinprogressevent.mdx b/client-sdks/typescript/api-reference/models/imagegencallinprogressevent.mdx deleted file mode 100644 index 9e9d17fc..00000000 --- a/client-sdks/typescript/api-reference/models/imagegencallinprogressevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ImageGenCallInProgressEvent - TypeScript SDK -sidebarTitle: ImageGenCallInProgressEvent -description: ImageGenCallInProgressEvent type definition -seoTitle: ImageGenCallInProgressEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegencallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallInProgressEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenCallInProgressEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallInProgressEvent%20-%20TypeScript%20SDK&description=ImageGenCallInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call in progress - -## Example Usage - -```typescript lines -import { ImageGenCallInProgressEvent } from "@openrouter/sdk/models"; - -let value: ImageGenCallInProgressEvent = { - itemId: "", - outputIndex: 654313, - sequenceNumber: 0, - type: "response.image_generation_call.in_progress", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegencallpartialimageevent.mdx b/client-sdks/typescript/api-reference/models/imagegencallpartialimageevent.mdx deleted file mode 100644 index f6726028..00000000 --- a/client-sdks/typescript/api-reference/models/imagegencallpartialimageevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ImageGenCallPartialImageEvent - TypeScript SDK -sidebarTitle: ImageGenCallPartialImageEvent -description: ImageGenCallPartialImageEvent type definition -seoTitle: ImageGenCallPartialImageEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegencallpartialimageevent -'og:site_name': OpenRouter Documentation -'og:title': ImageGenCallPartialImageEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenCallPartialImageEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenCallPartialImageEvent%20-%20TypeScript%20SDK&description=ImageGenCallPartialImageEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call with partial image - -## Example Usage - -```typescript lines -import { ImageGenCallPartialImageEvent } from "@openrouter/sdk/models"; - -let value: ImageGenCallPartialImageEvent = { - itemId: "", - outputIndex: 474497, - partialImageB64: "", - partialImageIndex: 124636, - sequenceNumber: 0, - type: "response.image_generation_call.partial_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `partialImageB64` | *string* | :heavy_check_mark: | N/A | -| `partialImageIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.partial_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationservertool.mdx b/client-sdks/typescript/api-reference/models/imagegenerationservertool.mdx deleted file mode 100644 index c11bbb94..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationservertool.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ImageGenerationServerTool - TypeScript SDK -sidebarTitle: ImageGenerationServerTool -description: ImageGenerationServerTool type definition -seoTitle: ImageGenerationServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationservertool -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerTool%20-%20TypeScript%20SDK&description=ImageGenerationServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation tool configuration - -## Example Usage - -```typescript lines -import { ImageGenerationServerTool } from "@openrouter/sdk/models"; - -let value: ImageGenerationServerTool = { - type: "image_generation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `background` | [models.Background](/client-sdks/typescript/api-reference/models/background) | :heavy_minus_sign: | N/A | -| `inputFidelity` | [models.InputFidelity](/client-sdks/typescript/api-reference/models/inputfidelity) | :heavy_minus_sign: | N/A | -| `inputImageMask` | [models.InputImageMask](/client-sdks/typescript/api-reference/models/inputimagemask) | :heavy_minus_sign: | N/A | -| `model` | [models.ModelEnum](/client-sdks/typescript/api-reference/models/modelenum) | :heavy_minus_sign: | N/A | -| `moderation` | [models.Moderation](/client-sdks/typescript/api-reference/models/moderation) | :heavy_minus_sign: | N/A | -| `outputCompression` | *number* | :heavy_minus_sign: | N/A | -| `outputFormat` | [models.OutputFormat](/client-sdks/typescript/api-reference/models/outputformat) | :heavy_minus_sign: | N/A | -| `partialImages` | *number* | :heavy_minus_sign: | N/A | -| `quality` | [models.Quality](/client-sdks/typescript/api-reference/models/quality) | :heavy_minus_sign: | N/A | -| `size` | [models.Size](/client-sdks/typescript/api-reference/models/size) | :heavy_minus_sign: | N/A | -| `type` | *"image_generation"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfig.mdx deleted file mode 100644 index e33127d8..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ImageGenerationServerToolConfig - TypeScript SDK -sidebarTitle: ImageGenerationServerToolConfig -description: ImageGenerationServerToolConfig type definition -seoTitle: ImageGenerationServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationServerToolConfig type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfig%20-%20TypeScript%20SDK&description=ImageGenerationServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { ImageGenerationServerToolConfig } from "@openrouter/sdk/models"; - -let value: ImageGenerationServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_minus_sign: | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | `{"aspect_ratio": "16:9","model": "openai/gpt-5-image","quality": "high"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfigunion.mdx b/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfigunion.mdx deleted file mode 100644 index 209bafa6..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationservertoolconfigunion.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ImageGenerationServerToolConfigUnion - TypeScript SDK -sidebarTitle: ImageGenerationServerToolConfigUnion -description: ImageGenerationServerToolConfigUnion type definition -seoTitle: ImageGenerationServerToolConfigUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationservertoolconfigunion -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolConfigUnion Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationServerToolConfigUnion type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolConfigUnion%20-%20TypeScript%20SDK&description=ImageGenerationServerToolConfigUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` - -### `any[]` - -```typescript lines -const value: any[] = [ - "", - "", - "", -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenrouter.mdx b/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenrouter.mdx deleted file mode 100644 index 18dd789d..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenrouter.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouter - TypeScript SDK -sidebarTitle: ImageGenerationServerToolOpenRouter -description: ImageGenerationServerToolOpenRouter type definition -seoTitle: ImageGenerationServerToolOpenRouter Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouter Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationServerToolOpenRouter type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouter%20-%20TypeScript%20SDK&description=ImageGenerationServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: generates images from text prompts using an image generation model - -## Example Usage - -```typescript lines -import { ImageGenerationServerToolOpenRouter } from "@openrouter/sdk/models"; - -let value: ImageGenerationServerToolOpenRouter = { - type: "openrouter:image_generation", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.ImageGenerationServerToolConfig](/client-sdks/typescript/api-reference/models/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` | [models.ImageGenerationServerToolOpenRouterType](/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenroutertype.mdx b/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenroutertype.mdx deleted file mode 100644 index a0b163fc..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationservertoolopenroutertype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ImageGenerationServerToolOpenRouterType - TypeScript SDK -sidebarTitle: ImageGenerationServerToolOpenRouterType -description: ImageGenerationServerToolOpenRouterType type definition -seoTitle: ImageGenerationServerToolOpenRouterType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationservertoolopenroutertype -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationServerToolOpenRouterType Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationServerToolOpenRouterType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationServerToolOpenRouterType%20-%20TypeScript%20SDK&description=ImageGenerationServerToolOpenRouterType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageGenerationServerToolOpenRouterType } from "@openrouter/sdk/models"; - -let value: ImageGenerationServerToolOpenRouterType = - "openrouter:image_generation"; -``` - -## Values - -```typescript lines -"openrouter:image_generation" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/imagegenerationstatus.mdx b/client-sdks/typescript/api-reference/models/imagegenerationstatus.mdx deleted file mode 100644 index 0a57c50d..00000000 --- a/client-sdks/typescript/api-reference/models/imagegenerationstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ImageGenerationStatus - TypeScript SDK -sidebarTitle: ImageGenerationStatus -description: ImageGenerationStatus type definition -seoTitle: ImageGenerationStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/imagegenerationstatus -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationStatus type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationStatus%20-%20TypeScript%20SDK&description=ImageGenerationStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageGenerationStatus } from "@openrouter/sdk/models"; - -let value: ImageGenerationStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "generating" | "failed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/incompletedetails.mdx b/client-sdks/typescript/api-reference/models/incompletedetails.mdx deleted file mode 100644 index e4b9fe08..00000000 --- a/client-sdks/typescript/api-reference/models/incompletedetails.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: IncompleteDetails - TypeScript SDK -sidebarTitle: IncompleteDetails -description: IncompleteDetails type definition -seoTitle: IncompleteDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/incompletedetails -'og:site_name': OpenRouter Documentation -'og:title': IncompleteDetails Type | OpenRouter TypeScript SDK -'og:description': >- - IncompleteDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=IncompleteDetails%20-%20TypeScript%20SDK&description=IncompleteDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { IncompleteDetails } from "@openrouter/sdk/models"; - -let value: IncompleteDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `reason` | [models.Reason](/client-sdks/typescript/api-reference/models/reason) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/input1.mdx b/client-sdks/typescript/api-reference/models/input1.mdx deleted file mode 100644 index ca5a5116..00000000 --- a/client-sdks/typescript/api-reference/models/input1.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Input1 - TypeScript SDK -sidebarTitle: Input1 -description: Input1 type definition -seoTitle: Input1 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/input1' -'og:site_name': OpenRouter Documentation -'og:title': Input1 Type | OpenRouter TypeScript SDK -'og:description': >- - Input1 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input1%20-%20TypeScript%20SDK&description=Input1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Input1 } from "@openrouter/sdk/models"; - -let value: Input1 = { - prompt: "What is the meaning of life?", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `prompt` | *string* | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/input2.mdx b/client-sdks/typescript/api-reference/models/input2.mdx deleted file mode 100644 index 9a07594e..00000000 --- a/client-sdks/typescript/api-reference/models/input2.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Input2 - TypeScript SDK -sidebarTitle: Input2 -description: Input2 type definition -seoTitle: Input2 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/input2' -'og:site_name': OpenRouter Documentation -'og:title': Input2 Type | OpenRouter TypeScript SDK -'og:description': >- - Input2 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input2%20-%20TypeScript%20SDK&description=Input2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Input2 } from "@openrouter/sdk/models"; - -let value: Input2 = { - messages: [ - { - "content": "What is the meaning of life?", - "role": "user", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `messages` | *any*[] | :heavy_check_mark: | N/A | [
`{"content": "What is the meaning of life?","role": "user"}`
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputaudio.mdx b/client-sdks/typescript/api-reference/models/inputaudio.mdx deleted file mode 100644 index e57bac75..00000000 --- a/client-sdks/typescript/api-reference/models/inputaudio.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: InputAudio - TypeScript SDK -sidebarTitle: InputAudio -description: InputAudio type definition -seoTitle: InputAudio Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputaudio' -'og:site_name': OpenRouter Documentation -'og:title': InputAudio Type | OpenRouter TypeScript SDK -'og:description': >- - InputAudio type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudio%20-%20TypeScript%20SDK&description=InputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Audio input content item - -## Example Usage - -```typescript lines -import { InputAudio } from "@openrouter/sdk/models"; - -let value: InputAudio = { - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, - type: "input_audio", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputAudio` | [models.InputAudioInputAudio](/client-sdks/typescript/api-reference/models/inputaudioinputaudio) | :heavy_check_mark: | N/A | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputaudioinputaudio.mdx b/client-sdks/typescript/api-reference/models/inputaudioinputaudio.mdx deleted file mode 100644 index 2369394e..00000000 --- a/client-sdks/typescript/api-reference/models/inputaudioinputaudio.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: InputAudioInputAudio - TypeScript SDK -sidebarTitle: InputAudioInputAudio -description: InputAudioInputAudio type definition -seoTitle: InputAudioInputAudio Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': InputAudioInputAudio Type | OpenRouter TypeScript SDK -'og:description': >- - InputAudioInputAudio type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputAudioInputAudio%20-%20TypeScript%20SDK&description=InputAudioInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputAudioInputAudio } from "@openrouter/sdk/models"; - -let value: InputAudioInputAudio = { - data: "", - format: "wav", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | [models.FormatEnum](/client-sdks/typescript/api-reference/models/formatenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputfidelity.mdx b/client-sdks/typescript/api-reference/models/inputfidelity.mdx deleted file mode 100644 index c00823de..00000000 --- a/client-sdks/typescript/api-reference/models/inputfidelity.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputFidelity - TypeScript SDK -sidebarTitle: InputFidelity -description: InputFidelity type definition -seoTitle: InputFidelity Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputfidelity' -'og:site_name': OpenRouter Documentation -'og:title': InputFidelity Type | OpenRouter TypeScript SDK -'og:description': >- - InputFidelity type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFidelity%20-%20TypeScript%20SDK&description=InputFidelity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputFidelity } from "@openrouter/sdk/models"; - -let value: InputFidelity = "high"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"high" | "low" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputfile.mdx b/client-sdks/typescript/api-reference/models/inputfile.mdx deleted file mode 100644 index 4234780a..00000000 --- a/client-sdks/typescript/api-reference/models/inputfile.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InputFile - TypeScript SDK -sidebarTitle: InputFile -description: InputFile type definition -seoTitle: InputFile Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputfile' -'og:site_name': OpenRouter Documentation -'og:title': InputFile Type | OpenRouter TypeScript SDK -'og:description': >- - InputFile type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputFile%20-%20TypeScript%20SDK&description=InputFile%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -File input content item - -## Example Usage - -```typescript lines -import { InputFile } from "@openrouter/sdk/models"; - -let value: InputFile = { - type: "input_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileData` | *string* | :heavy_minus_sign: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `fileUrl` | *string* | :heavy_minus_sign: | N/A | -| `filename` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_file"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputimage.mdx b/client-sdks/typescript/api-reference/models/inputimage.mdx deleted file mode 100644 index fbfc690c..00000000 --- a/client-sdks/typescript/api-reference/models/inputimage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputImage - TypeScript SDK -sidebarTitle: InputImage -description: InputImage type definition -seoTitle: InputImage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputimage' -'og:site_name': OpenRouter Documentation -'og:title': InputImage Type | OpenRouter TypeScript SDK -'og:description': >- - InputImage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImage%20-%20TypeScript%20SDK&description=InputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { InputImage } from "@openrouter/sdk/models"; - -let value: InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `detail` | [models.InputImageDetail](/client-sdks/typescript/api-reference/models/inputimagedetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.InputImageTypeEnum](/client-sdks/typescript/api-reference/models/inputimagetypeenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputimagedetail.mdx b/client-sdks/typescript/api-reference/models/inputimagedetail.mdx deleted file mode 100644 index eb28b702..00000000 --- a/client-sdks/typescript/api-reference/models/inputimagedetail.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputImageDetail - TypeScript SDK -sidebarTitle: InputImageDetail -description: InputImageDetail type definition -seoTitle: InputImageDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputimagedetail -'og:site_name': OpenRouter Documentation -'og:title': InputImageDetail Type | OpenRouter TypeScript SDK -'og:description': >- - InputImageDetail type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageDetail%20-%20TypeScript%20SDK&description=InputImageDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputImageDetail } from "@openrouter/sdk/models"; - -let value: InputImageDetail = "high"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "high" | "low" | "original" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputimagemask.mdx b/client-sdks/typescript/api-reference/models/inputimagemask.mdx deleted file mode 100644 index 5d0a1833..00000000 --- a/client-sdks/typescript/api-reference/models/inputimagemask.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputImageMask - TypeScript SDK -sidebarTitle: InputImageMask -description: InputImageMask type definition -seoTitle: InputImageMask Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputimagemask' -'og:site_name': OpenRouter Documentation -'og:title': InputImageMask Type | OpenRouter TypeScript SDK -'og:description': >- - InputImageMask type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageMask%20-%20TypeScript%20SDK&description=InputImageMask%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputImageMask } from "@openrouter/sdk/models"; - -let value: InputImageMask = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputimagetypeenum.mdx b/client-sdks/typescript/api-reference/models/inputimagetypeenum.mdx deleted file mode 100644 index b552620e..00000000 --- a/client-sdks/typescript/api-reference/models/inputimagetypeenum.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputImageTypeEnum - TypeScript SDK -sidebarTitle: InputImageTypeEnum -description: InputImageTypeEnum type definition -seoTitle: InputImageTypeEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputimagetypeenum -'og:site_name': OpenRouter Documentation -'og:title': InputImageTypeEnum Type | OpenRouter TypeScript SDK -'og:description': >- - InputImageTypeEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputImageTypeEnum%20-%20TypeScript%20SDK&description=InputImageTypeEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputImageTypeEnum } from "@openrouter/sdk/models"; - -let value: InputImageTypeEnum = "input_image"; -``` - -## Values - -```typescript lines -"input_image" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitem.mdx b/client-sdks/typescript/api-reference/models/inputmessageitem.mdx deleted file mode 100644 index 5bd8be31..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitem.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputMessageItem - TypeScript SDK -sidebarTitle: InputMessageItem -description: InputMessageItem type definition -seoTitle: InputMessageItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItem Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItem%20-%20TypeScript%20SDK&description=InputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItem } from "@openrouter/sdk/models"; - -let value: InputMessageItem = { - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `content` | *models.InputMessageItemContentUnion*[] | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `role` | *models.InputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.InputMessageItemTypeMessage](/client-sdks/typescript/api-reference/models/inputmessageitemtypemessage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemcontentinputimage.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemcontentinputimage.mdx deleted file mode 100644 index e0984a4a..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemcontentinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InputMessageItemContentInputImage - TypeScript SDK -sidebarTitle: InputMessageItemContentInputImage -description: InputMessageItemContentInputImage type definition -seoTitle: InputMessageItemContentInputImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemcontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentInputImage Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemContentInputImage type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentInputImage%20-%20TypeScript%20SDK&description=InputMessageItemContentInputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { InputMessageItemContentInputImage } from "@openrouter/sdk/models"; - -let value: InputMessageItemContentInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.InputMessageItemDetail](/client-sdks/typescript/api-reference/models/inputmessageitemdetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemcontentunion.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemcontentunion.mdx deleted file mode 100644 index c877ba77..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemcontentunion.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: InputMessageItemContentUnion - TypeScript SDK -sidebarTitle: InputMessageItemContentUnion -description: InputMessageItemContentUnion type definition -seoTitle: InputMessageItemContentUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemcontentunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemContentUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemContentUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemContentUnion%20-%20TypeScript%20SDK&description=InputMessageItemContentUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -### `models.InputMessageItemContentInputImage` - -```typescript lines -const value: models.InputMessageItemContentInputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputAudio` - -```typescript lines -const value: models.InputAudio = { - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, - type: "input_audio", -}; -``` - -### `models.InputVideo` - -```typescript lines -const value: models.InputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemdetail.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemdetail.mdx deleted file mode 100644 index bed44cab..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemdetail.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputMessageItemDetail - TypeScript SDK -sidebarTitle: InputMessageItemDetail -description: InputMessageItemDetail type definition -seoTitle: InputMessageItemDetail Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemdetail -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemDetail Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemDetail type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemDetail%20-%20TypeScript%20SDK&description=InputMessageItemDetail%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItemDetail } from "@openrouter/sdk/models"; - -let value: InputMessageItemDetail = "high"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "high" | "low" | "original" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemroledeveloper.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemroledeveloper.mdx deleted file mode 100644 index 49b06067..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputMessageItemRoleDeveloper - TypeScript SDK -sidebarTitle: InputMessageItemRoleDeveloper -description: InputMessageItemRoleDeveloper type definition -seoTitle: InputMessageItemRoleDeveloper Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleDeveloper Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemRoleDeveloper type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleDeveloper%20-%20TypeScript%20SDK&description=InputMessageItemRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItemRoleDeveloper } from "@openrouter/sdk/models"; - -let value: InputMessageItemRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemrolesystem.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemrolesystem.mdx deleted file mode 100644 index e92b3f29..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemrolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputMessageItemRoleSystem - TypeScript SDK -sidebarTitle: InputMessageItemRoleSystem -description: InputMessageItemRoleSystem type definition -seoTitle: InputMessageItemRoleSystem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleSystem Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemRoleSystem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleSystem%20-%20TypeScript%20SDK&description=InputMessageItemRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItemRoleSystem } from "@openrouter/sdk/models"; - -let value: InputMessageItemRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemroleunion.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemroleunion.mdx deleted file mode 100644 index a2b502b1..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemroleunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputMessageItemRoleUnion - TypeScript SDK -sidebarTitle: InputMessageItemRoleUnion -description: InputMessageItemRoleUnion type definition -seoTitle: InputMessageItemRoleUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemRoleUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUnion%20-%20TypeScript%20SDK&description=InputMessageItemRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputMessageItemRoleUser` - -```typescript lines -const value: models.InputMessageItemRoleUser = "user"; -``` - -### `models.InputMessageItemRoleSystem` - -```typescript lines -const value: models.InputMessageItemRoleSystem = "system"; -``` - -### `models.InputMessageItemRoleDeveloper` - -```typescript lines -const value: models.InputMessageItemRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemroleuser.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemroleuser.mdx deleted file mode 100644 index 17baf777..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemroleuser.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputMessageItemRoleUser - TypeScript SDK -sidebarTitle: InputMessageItemRoleUser -description: InputMessageItemRoleUser type definition -seoTitle: InputMessageItemRoleUser Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemRoleUser Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemRoleUser type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemRoleUser%20-%20TypeScript%20SDK&description=InputMessageItemRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItemRoleUser } from "@openrouter/sdk/models"; - -let value: InputMessageItemRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmessageitemtypemessage.mdx b/client-sdks/typescript/api-reference/models/inputmessageitemtypemessage.mdx deleted file mode 100644 index d3844490..00000000 --- a/client-sdks/typescript/api-reference/models/inputmessageitemtypemessage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputMessageItemTypeMessage - TypeScript SDK -sidebarTitle: InputMessageItemTypeMessage -description: InputMessageItemTypeMessage type definition -seoTitle: InputMessageItemTypeMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputmessageitemtypemessage -'og:site_name': OpenRouter Documentation -'og:title': InputMessageItemTypeMessage Type | OpenRouter TypeScript SDK -'og:description': >- - InputMessageItemTypeMessage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputMessageItemTypeMessage%20-%20TypeScript%20SDK&description=InputMessageItemTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputMessageItemTypeMessage } from "@openrouter/sdk/models"; - -let value: InputMessageItemTypeMessage = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputmodality.mdx b/client-sdks/typescript/api-reference/models/inputmodality.mdx deleted file mode 100644 index 9dbca819..00000000 --- a/client-sdks/typescript/api-reference/models/inputmodality.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InputModality - TypeScript SDK -sidebarTitle: InputModality -description: InputModality type definition -seoTitle: InputModality Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputmodality' -'og:site_name': OpenRouter Documentation -'og:title': InputModality Type | OpenRouter TypeScript SDK -'og:description': >- - InputModality type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputModality%20-%20TypeScript%20SDK&description=InputModality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputModality } from "@openrouter/sdk/models"; - -let value: InputModality = "text"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"text" | "image" | "file" | "audio" | "video" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputschema.mdx b/client-sdks/typescript/api-reference/models/inputschema.mdx deleted file mode 100644 index 6e924731..00000000 --- a/client-sdks/typescript/api-reference/models/inputschema.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputSchema - TypeScript SDK -sidebarTitle: InputSchema -description: InputSchema type definition -seoTitle: InputSchema Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputschema' -'og:site_name': OpenRouter Documentation -'og:title': InputSchema Type | OpenRouter TypeScript SDK -'og:description': >- - InputSchema type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputSchema%20-%20TypeScript%20SDK&description=InputSchema%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputSchema } from "@openrouter/sdk/models"; - -let value: InputSchema = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `properties` | *any* | :heavy_minus_sign: | N/A | -| `required` | *string*[] | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputscontent1.mdx b/client-sdks/typescript/api-reference/models/inputscontent1.mdx deleted file mode 100644 index 746433f9..00000000 --- a/client-sdks/typescript/api-reference/models/inputscontent1.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputsContent1 - TypeScript SDK -sidebarTitle: InputsContent1 -description: InputsContent1 type definition -seoTitle: InputsContent1 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputscontent1' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsContent1 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent1%20-%20TypeScript%20SDK&description=InputsContent1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputscontent2.mdx b/client-sdks/typescript/api-reference/models/inputscontent2.mdx deleted file mode 100644 index 708aac14..00000000 --- a/client-sdks/typescript/api-reference/models/inputscontent2.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputsContent2 - TypeScript SDK -sidebarTitle: InputsContent2 -description: InputsContent2 type definition -seoTitle: InputsContent2 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputscontent2' -'og:site_name': OpenRouter Documentation -'og:title': InputsContent2 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsContent2 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsContent2%20-%20TypeScript%20SDK&description=InputsContent2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputsContent1[]` - -```typescript lines -const value: models.InputsContent1[] = []; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsmessage.mdx b/client-sdks/typescript/api-reference/models/inputsmessage.mdx deleted file mode 100644 index 0f1b839e..00000000 --- a/client-sdks/typescript/api-reference/models/inputsmessage.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: InputsMessage - TypeScript SDK -sidebarTitle: InputsMessage -description: InputsMessage type definition -seoTitle: InputsMessage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputsmessage' -'og:site_name': OpenRouter Documentation -'og:title': InputsMessage Type | OpenRouter TypeScript SDK -'og:description': >- - InputsMessage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsMessage%20-%20TypeScript%20SDK&description=InputsMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output message item - -## Example Usage - -```typescript lines -import { InputsMessage } from "@openrouter/sdk/models"; - -let value: InputsMessage = { - content: [ - { - text: "Hello! How can I help you?", - type: "output_text", - }, - ], - id: "msg-123", - role: "assistant", - type: "message", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InputsContent2* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.InputsPhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.InputsRole](/client-sdks/typescript/api-reference/models/inputsrole) | :heavy_check_mark: | N/A | -| `status` | *models.InputsStatusUnion1* | :heavy_minus_sign: | N/A | -| `type` | [models.InputsTypeMessage](/client-sdks/typescript/api-reference/models/inputstypemessage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsphasecommentary.mdx b/client-sdks/typescript/api-reference/models/inputsphasecommentary.mdx deleted file mode 100644 index dbdf2965..00000000 --- a/client-sdks/typescript/api-reference/models/inputsphasecommentary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsPhaseCommentary - TypeScript SDK -sidebarTitle: InputsPhaseCommentary -description: InputsPhaseCommentary type definition -seoTitle: InputsPhaseCommentary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseCommentary Type | OpenRouter TypeScript SDK -'og:description': >- - InputsPhaseCommentary type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseCommentary%20-%20TypeScript%20SDK&description=InputsPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsPhaseCommentary } from "@openrouter/sdk/models"; - -let value: InputsPhaseCommentary = "commentary"; -``` - -## Values - -```typescript lines -"commentary" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsphasefinalanswer.mdx b/client-sdks/typescript/api-reference/models/inputsphasefinalanswer.mdx deleted file mode 100644 index 194c997a..00000000 --- a/client-sdks/typescript/api-reference/models/inputsphasefinalanswer.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsPhaseFinalAnswer - TypeScript SDK -sidebarTitle: InputsPhaseFinalAnswer -description: InputsPhaseFinalAnswer type definition -seoTitle: InputsPhaseFinalAnswer Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseFinalAnswer Type | OpenRouter TypeScript SDK -'og:description': >- - InputsPhaseFinalAnswer type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseFinalAnswer%20-%20TypeScript%20SDK&description=InputsPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsPhaseFinalAnswer } from "@openrouter/sdk/models"; - -let value: InputsPhaseFinalAnswer = "final_answer"; -``` - -## Values - -```typescript lines -"final_answer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsphaseunion.mdx b/client-sdks/typescript/api-reference/models/inputsphaseunion.mdx deleted file mode 100644 index c77f68c6..00000000 --- a/client-sdks/typescript/api-reference/models/inputsphaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: InputsPhaseUnion - TypeScript SDK -sidebarTitle: InputsPhaseUnion -description: InputsPhaseUnion type definition -seoTitle: InputsPhaseUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsphaseunion -'og:site_name': OpenRouter Documentation -'og:title': InputsPhaseUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputsPhaseUnion type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsPhaseUnion%20-%20TypeScript%20SDK&description=InputsPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `models.InputsPhaseCommentary` - -```typescript lines -const value: models.InputsPhaseCommentary = "commentary"; -``` - -### `models.InputsPhaseFinalAnswer` - -```typescript lines -const value: models.InputsPhaseFinalAnswer = "final_answer"; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsreasoning.mdx b/client-sdks/typescript/api-reference/models/inputsreasoning.mdx deleted file mode 100644 index 36ac2b24..00000000 --- a/client-sdks/typescript/api-reference/models/inputsreasoning.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: InputsReasoning - TypeScript SDK -sidebarTitle: InputsReasoning -description: InputsReasoning type definition -seoTitle: InputsReasoning Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsreasoning -'og:site_name': OpenRouter Documentation -'og:title': InputsReasoning Type | OpenRouter TypeScript SDK -'og:description': >- - InputsReasoning type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsReasoning%20-%20TypeScript%20SDK&description=InputsReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Example Usage - -```typescript lines -import { InputsReasoning } from "@openrouter/sdk/models"; - -let value: InputsReasoning = { - id: "reasoning-123", - summary: [ - { - text: "Analyzed the problem and found the optimal solution.", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](/client-sdks/typescript/api-reference/models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.InputsStatusUnion2* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](/client-sdks/typescript/api-reference/models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | -| `type` | [models.InputsTypeReasoning](/client-sdks/typescript/api-reference/models/inputstypereasoning) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsrole.mdx b/client-sdks/typescript/api-reference/models/inputsrole.mdx deleted file mode 100644 index 74c25760..00000000 --- a/client-sdks/typescript/api-reference/models/inputsrole.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: InputsRole - TypeScript SDK -sidebarTitle: InputsRole -description: InputsRole type definition -seoTitle: InputsRole Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputsrole' -'og:site_name': OpenRouter Documentation -'og:title': InputsRole Type | OpenRouter TypeScript SDK -'og:description': >- - InputsRole type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsRole%20-%20TypeScript%20SDK&description=InputsRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsRole } from "@openrouter/sdk/models"; - -let value: InputsRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatuscompleted1.mdx b/client-sdks/typescript/api-reference/models/inputsstatuscompleted1.mdx deleted file mode 100644 index 505ba9cf..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatuscompleted1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusCompleted1 - TypeScript SDK -sidebarTitle: InputsStatusCompleted1 -description: InputsStatusCompleted1 type definition -seoTitle: InputsStatusCompleted1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatuscompleted1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusCompleted1 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted1%20-%20TypeScript%20SDK&description=InputsStatusCompleted1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusCompleted1 } from "@openrouter/sdk/models"; - -let value: InputsStatusCompleted1 = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatuscompleted2.mdx b/client-sdks/typescript/api-reference/models/inputsstatuscompleted2.mdx deleted file mode 100644 index 02f8ebf7..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatuscompleted2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusCompleted2 - TypeScript SDK -sidebarTitle: InputsStatusCompleted2 -description: InputsStatusCompleted2 type definition -seoTitle: InputsStatusCompleted2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatuscompleted2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusCompleted2 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusCompleted2 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusCompleted2%20-%20TypeScript%20SDK&description=InputsStatusCompleted2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusCompleted2 } from "@openrouter/sdk/models"; - -let value: InputsStatusCompleted2 = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusincomplete1.mdx b/client-sdks/typescript/api-reference/models/inputsstatusincomplete1.mdx deleted file mode 100644 index 3470ffcf..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusincomplete1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusIncomplete1 - TypeScript SDK -sidebarTitle: InputsStatusIncomplete1 -description: InputsStatusIncomplete1 type definition -seoTitle: InputsStatusIncomplete1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusincomplete1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusIncomplete1 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete1%20-%20TypeScript%20SDK&description=InputsStatusIncomplete1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusIncomplete1 } from "@openrouter/sdk/models"; - -let value: InputsStatusIncomplete1 = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusincomplete2.mdx b/client-sdks/typescript/api-reference/models/inputsstatusincomplete2.mdx deleted file mode 100644 index 2ebf5038..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusincomplete2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusIncomplete2 - TypeScript SDK -sidebarTitle: InputsStatusIncomplete2 -description: InputsStatusIncomplete2 type definition -seoTitle: InputsStatusIncomplete2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusincomplete2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusIncomplete2 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusIncomplete2 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusIncomplete2%20-%20TypeScript%20SDK&description=InputsStatusIncomplete2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusIncomplete2 } from "@openrouter/sdk/models"; - -let value: InputsStatusIncomplete2 = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusinprogress1.mdx b/client-sdks/typescript/api-reference/models/inputsstatusinprogress1.mdx deleted file mode 100644 index 387cb3d5..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusinprogress1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusInProgress1 - TypeScript SDK -sidebarTitle: InputsStatusInProgress1 -description: InputsStatusInProgress1 type definition -seoTitle: InputsStatusInProgress1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusinprogress1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusInProgress1 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress1%20-%20TypeScript%20SDK&description=InputsStatusInProgress1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusInProgress1 } from "@openrouter/sdk/models"; - -let value: InputsStatusInProgress1 = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusinprogress2.mdx b/client-sdks/typescript/api-reference/models/inputsstatusinprogress2.mdx deleted file mode 100644 index 8ba5a919..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusinprogress2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsStatusInProgress2 - TypeScript SDK -sidebarTitle: InputsStatusInProgress2 -description: InputsStatusInProgress2 type definition -seoTitle: InputsStatusInProgress2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusinprogress2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusInProgress2 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusInProgress2 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusInProgress2%20-%20TypeScript%20SDK&description=InputsStatusInProgress2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsStatusInProgress2 } from "@openrouter/sdk/models"; - -let value: InputsStatusInProgress2 = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusunion1.mdx b/client-sdks/typescript/api-reference/models/inputsstatusunion1.mdx deleted file mode 100644 index ebb63c97..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusunion1.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputsStatusUnion1 - TypeScript SDK -sidebarTitle: InputsStatusUnion1 -description: InputsStatusUnion1 type definition -seoTitle: InputsStatusUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusunion1 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusUnion1 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion1%20-%20TypeScript%20SDK&description=InputsStatusUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputsStatusCompleted1` - -```typescript lines -const value: models.InputsStatusCompleted1 = "completed"; -``` - -### `models.InputsStatusIncomplete1` - -```typescript lines -const value: models.InputsStatusIncomplete1 = "incomplete"; -``` - -### `models.InputsStatusInProgress1` - -```typescript lines -const value: models.InputsStatusInProgress1 = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsstatusunion2.mdx b/client-sdks/typescript/api-reference/models/inputsstatusunion2.mdx deleted file mode 100644 index ac3ff649..00000000 --- a/client-sdks/typescript/api-reference/models/inputsstatusunion2.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InputsStatusUnion2 - TypeScript SDK -sidebarTitle: InputsStatusUnion2 -description: InputsStatusUnion2 type definition -seoTitle: InputsStatusUnion2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputsstatusunion2 -'og:site_name': OpenRouter Documentation -'og:title': InputsStatusUnion2 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsStatusUnion2 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsStatusUnion2%20-%20TypeScript%20SDK&description=InputsStatusUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputsStatusCompleted2` - -```typescript lines -const value: models.InputsStatusCompleted2 = "completed"; -``` - -### `models.InputsStatusIncomplete2` - -```typescript lines -const value: models.InputsStatusIncomplete2 = "incomplete"; -``` - -### `models.InputsStatusInProgress2` - -```typescript lines -const value: models.InputsStatusInProgress2 = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputstypemessage.mdx b/client-sdks/typescript/api-reference/models/inputstypemessage.mdx deleted file mode 100644 index c2538f5c..00000000 --- a/client-sdks/typescript/api-reference/models/inputstypemessage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsTypeMessage - TypeScript SDK -sidebarTitle: InputsTypeMessage -description: InputsTypeMessage type definition -seoTitle: InputsTypeMessage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputstypemessage -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeMessage Type | OpenRouter TypeScript SDK -'og:description': >- - InputsTypeMessage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeMessage%20-%20TypeScript%20SDK&description=InputsTypeMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsTypeMessage } from "@openrouter/sdk/models"; - -let value: InputsTypeMessage = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputstypereasoning.mdx b/client-sdks/typescript/api-reference/models/inputstypereasoning.mdx deleted file mode 100644 index e058c993..00000000 --- a/client-sdks/typescript/api-reference/models/inputstypereasoning.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputsTypeReasoning - TypeScript SDK -sidebarTitle: InputsTypeReasoning -description: InputsTypeReasoning type definition -seoTitle: InputsTypeReasoning Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputstypereasoning -'og:site_name': OpenRouter Documentation -'og:title': InputsTypeReasoning Type | OpenRouter TypeScript SDK -'og:description': >- - InputsTypeReasoning type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsTypeReasoning%20-%20TypeScript%20SDK&description=InputsTypeReasoning%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputsTypeReasoning } from "@openrouter/sdk/models"; - -let value: InputsTypeReasoning = "reasoning"; -``` - -## Values - -```typescript lines -"reasoning" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsunion.mdx b/client-sdks/typescript/api-reference/models/inputsunion.mdx deleted file mode 100644 index dd97c41a..00000000 --- a/client-sdks/typescript/api-reference/models/inputsunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputsUnion - TypeScript SDK -sidebarTitle: InputsUnion -description: InputsUnion type definition -seoTitle: InputsUnion Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputsunion' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputsUnion type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion%20-%20TypeScript%20SDK&description=InputsUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Input for a response request - can be a string or array of items - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.InputsUnion1[]` - -```typescript lines -const value: models.InputsUnion1[] = [ - { - role: "user", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputsunion1.mdx b/client-sdks/typescript/api-reference/models/inputsunion1.mdx deleted file mode 100644 index 0c5a191d..00000000 --- a/client-sdks/typescript/api-reference/models/inputsunion1.mdx +++ /dev/null @@ -1,511 +0,0 @@ ---- -title: InputsUnion1 - TypeScript SDK -sidebarTitle: InputsUnion1 -description: InputsUnion1 type definition -seoTitle: InputsUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputsunion1' -'og:site_name': OpenRouter Documentation -'og:title': InputsUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - InputsUnion1 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputsUnion1%20-%20TypeScript%20SDK&description=InputsUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ReasoningItem` - -```typescript lines -const value: models.ReasoningItem = { - id: "reasoning-abc123", - summary: [ - { - text: "Step by step analysis", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -### `models.EasyInputMessage` - -```typescript lines -const value: models.EasyInputMessage = { - role: "user", -}; -``` - -### `models.InputMessageItem` - -```typescript lines -const value: models.InputMessageItem = { - role: "user", -}; -``` - -### `models.FunctionCallItem` - -```typescript lines -const value: models.FunctionCallItem = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - id: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -### `models.FunctionCallOutputItem` - -```typescript lines -const value: models.FunctionCallOutputItem = { - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", - type: "function_call_output", -}; -``` - -### `models.ApplyPatchCallItem` - -```typescript lines -const value: models.ApplyPatchCallItem = { - callId: "call_abc123", - operation: { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", - }, - status: "completed", - type: "apply_patch_call", -}; -``` - -### `models.ApplyPatchCallOutputItem` - -```typescript lines -const value: models.ApplyPatchCallOutputItem = { - callId: "call_abc123", - status: "completed", - type: "apply_patch_call_output", -}; -``` - -### `models.InputsMessage` - -```typescript lines -const value: models.InputsMessage = { - content: [ - { - text: "Hello! How can I help you?", - type: "output_text", - }, - ], - id: "msg-123", - role: "assistant", - type: "message", -}; -``` - -### `models.InputsReasoning` - -```typescript lines -const value: models.InputsReasoning = { - id: "reasoning-123", - summary: [ - { - text: "Analyzed the problem and found the optimal solution.", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -### `models.OutputFunctionCallItem` - -```typescript lines -const value: models.OutputFunctionCallItem = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -### `models.OutputCustomToolCallItem` - -```typescript lines -const value: models.OutputCustomToolCallItem = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -### `models.OutputWebSearchCallItem` - -```typescript lines -const value: models.OutputWebSearchCallItem = { - action: { - pattern: "", - type: "find_in_page", - url: "https://tragic-requirement.com/", - }, - id: "ws-abc123", - status: "completed", - type: "web_search_call", -}; -``` - -### `models.OutputFileSearchCallItem` - -```typescript lines -const value: models.OutputFileSearchCallItem = { - id: "fs-abc123", - queries: [ - "search term", - ], - status: "completed", - type: "file_search_call", -}; -``` - -### `models.OutputImageGenerationCallItem` - -```typescript lines -const value: models.OutputImageGenerationCallItem = { - id: "img-abc123", - status: "completed", - type: "image_generation_call", -}; -``` - -### `models.OutputCodeInterpreterCallItem` - -```typescript lines -const value: models.OutputCodeInterpreterCallItem = { - code: "print(\"hello\")", - containerId: "ctr-xyz789", - id: "ci-abc123", - outputs: [ - { - logs: "hello\n", - type: "logs", - }, - ], - status: "completed", - type: "code_interpreter_call", -}; -``` - -### `models.OutputComputerCallItem` - -```typescript lines -const value: models.OutputComputerCallItem = { - callId: "call-abc123", - pendingSafetyChecks: [], - status: "completed", - type: "computer_call", -}; -``` - -### `models.OutputDatetimeItem` - -```typescript lines -const value: models.OutputDatetimeItem = { - datetime: "2026-03-12T14:30:00.000Z", - status: "completed", - timezone: "UTC", - type: "openrouter:datetime", -}; -``` - -### `models.OutputWebSearchServerToolItem` - -```typescript lines -const value: models.OutputWebSearchServerToolItem = { - status: "completed", - type: "openrouter:web_search", -}; -``` - -### `models.OutputCodeInterpreterServerToolItem` - -```typescript lines -const value: models.OutputCodeInterpreterServerToolItem = { - status: "completed", - type: "openrouter:code_interpreter", -}; -``` - -### `models.OutputFileSearchServerToolItem` - -```typescript lines -const value: models.OutputFileSearchServerToolItem = { - status: "completed", - type: "openrouter:file_search", -}; -``` - -### `models.OutputImageGenerationServerToolItem` - -```typescript lines -const value: models.OutputImageGenerationServerToolItem = { - status: "completed", - type: "openrouter:image_generation", -}; -``` - -### `models.OutputBrowserUseServerToolItem` - -```typescript lines -const value: models.OutputBrowserUseServerToolItem = { - status: "completed", - type: "openrouter:browser_use", -}; -``` - -### `models.OutputBashServerToolItem` - -```typescript lines -const value: models.OutputBashServerToolItem = { - status: "completed", - type: "openrouter:bash", -}; -``` - -### `models.OutputTextEditorServerToolItem` - -```typescript lines -const value: models.OutputTextEditorServerToolItem = { - status: "completed", - type: "openrouter:text_editor", -}; -``` - -### `models.OutputApplyPatchServerToolItem` - -```typescript lines -const value: models.OutputApplyPatchServerToolItem = { - status: "completed", - type: "openrouter:apply_patch", -}; -``` - -### `models.OutputWebFetchServerToolItem` - -```typescript lines -const value: models.OutputWebFetchServerToolItem = { - status: "completed", - type: "openrouter:web_fetch", -}; -``` - -### `models.OutputToolSearchServerToolItem` - -```typescript lines -const value: models.OutputToolSearchServerToolItem = { - status: "completed", - type: "openrouter:tool_search", -}; -``` - -### `models.OutputMemoryServerToolItem` - -```typescript lines -const value: models.OutputMemoryServerToolItem = { - status: "completed", - type: "openrouter:memory", -}; -``` - -### `models.OutputMcpServerToolItem` - -```typescript lines -const value: models.OutputMcpServerToolItem = { - status: "completed", - type: "openrouter:mcp", -}; -``` - -### `models.OutputSearchModelsServerToolItem` - -```typescript lines -const value: models.OutputSearchModelsServerToolItem = { - status: "completed", - type: "openrouter:experimental__search_models", -}; -``` - -### `models.LocalShellCallItem` - -```typescript lines -const value: models.LocalShellCallItem = { - action: { - command: [ - "ls", - "-la", - ], - env: { - "PATH": "/usr/bin", - }, - type: "exec", - }, - callId: "call-abc123", - id: "shell-abc123", - status: "completed", - type: "local_shell_call", -}; -``` - -### `models.LocalShellCallOutputItem` - -```typescript lines -const value: models.LocalShellCallOutputItem = { - id: "output-abc123", - output: "total 24\ndrwxr-xr-x 5 user staff 160 Jan 1 12:00 .", - type: "local_shell_call_output", -}; -``` - -### `models.ShellCallItem` - -```typescript lines -const value: models.ShellCallItem = { - action: { - commands: [ - "ls", - "-la", - ], - }, - callId: "call-abc123", - type: "shell_call", -}; -``` - -### `models.ShellCallOutputItem` - -```typescript lines -const value: models.ShellCallOutputItem = { - callId: "call-abc123", - output: [ - { - type: "stdout", - }, - ], - type: "shell_call_output", -}; -``` - -### `models.McpListToolsItem` - -```typescript lines -const value: models.McpListToolsItem = { - id: "mcp-list-abc123", - serverLabel: "database-server", - tools: [ - { - inputSchema: { - "properties": { - "query": { - "type": "string", - }, - }, - "type": "object", - }, - name: "query_database", - }, - ], - type: "mcp_list_tools", -}; -``` - -### `models.McpApprovalRequestItem` - -```typescript lines -const value: models.McpApprovalRequestItem = { - arguments: "{\"id\":\"123\"}", - id: "approval-abc123", - name: "delete_record", - serverLabel: "database-server", - type: "mcp_approval_request", -}; -``` - -### `models.McpApprovalResponseItem` - -```typescript lines -const value: models.McpApprovalResponseItem = { - approvalRequestId: "approval-abc123", - approve: true, - type: "mcp_approval_response", -}; -``` - -### `models.McpCallItem` - -```typescript lines -const value: models.McpCallItem = { - arguments: "{\"query\":\"SELECT * FROM users\"}", - id: "mcp-call-abc123", - name: "query_database", - serverLabel: "database-server", - type: "mcp_call", -}; -``` - -### `models.CustomToolCallItem` - -```typescript lines -const value: models.CustomToolCallItem = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -### `models.CustomToolCallOutputItem` - -```typescript lines -const value: models.CustomToolCallOutputItem = { - callId: "call-abc123", - output: "patch applied successfully", - type: "custom_tool_call_output", -}; -``` - -### `models.CompactionItem` - -```typescript lines -const value: models.CompactionItem = { - encryptedContent: "enc_abc123...", - type: "compaction", -}; -``` - -### `models.ItemReferenceItem` - -```typescript lines -const value: models.ItemReferenceItem = { - id: "msg-abc123", - type: "item_reference", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputtext.mdx b/client-sdks/typescript/api-reference/models/inputtext.mdx deleted file mode 100644 index e0ccbe71..00000000 --- a/client-sdks/typescript/api-reference/models/inputtext.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputText - TypeScript SDK -sidebarTitle: InputText -description: InputText type definition -seoTitle: InputText Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputtext' -'og:site_name': OpenRouter Documentation -'og:title': InputText Type | OpenRouter TypeScript SDK -'og:description': >- - InputText type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputText%20-%20TypeScript%20SDK&description=InputText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text input content item - -## Example Usage - -```typescript lines -import { InputText } from "@openrouter/sdk/models"; - -let value: InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"input_text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputtokensdetails.mdx b/client-sdks/typescript/api-reference/models/inputtokensdetails.mdx deleted file mode 100644 index acb21f55..00000000 --- a/client-sdks/typescript/api-reference/models/inputtokensdetails.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InputTokensDetails - TypeScript SDK -sidebarTitle: InputTokensDetails -description: InputTokensDetails type definition -seoTitle: InputTokensDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/inputtokensdetails -'og:site_name': OpenRouter Documentation -'og:title': InputTokensDetails Type | OpenRouter TypeScript SDK -'og:description': >- - InputTokensDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTokensDetails%20-%20TypeScript%20SDK&description=InputTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputTokensDetails } from "@openrouter/sdk/models"; - -let value: InputTokensDetails = { - cachedTokens: 22909, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `cachedTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputunion.mdx b/client-sdks/typescript/api-reference/models/inputunion.mdx deleted file mode 100644 index 8cb5767d..00000000 --- a/client-sdks/typescript/api-reference/models/inputunion.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: InputUnion - TypeScript SDK -sidebarTitle: InputUnion -description: InputUnion type definition -seoTitle: InputUnion Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputUnion type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20TypeScript%20SDK&description=InputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The input to the generation — either a prompt string or an array of messages - -## Supported Types - -### `models.Input1` - -```typescript lines -const value: models.Input1 = { - prompt: "What is the meaning of life?", -}; -``` - -### `models.Input2` - -```typescript lines -const value: models.Input2 = { - messages: [ - { - "content": "What is the meaning of life?", - "role": "user", - }, - ], -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/inputvideo.mdx b/client-sdks/typescript/api-reference/models/inputvideo.mdx deleted file mode 100644 index fbfae9a6..00000000 --- a/client-sdks/typescript/api-reference/models/inputvideo.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: InputVideo - TypeScript SDK -sidebarTitle: InputVideo -description: InputVideo type definition -seoTitle: InputVideo Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/inputvideo' -'og:site_name': OpenRouter Documentation -'og:title': InputVideo Type | OpenRouter TypeScript SDK -'og:description': >- - InputVideo type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputVideo%20-%20TypeScript%20SDK&description=InputVideo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Video input content item - -## Example Usage - -```typescript lines -import { InputVideo } from "@openrouter/sdk/models"; - -let value: InputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | -| `videoUrl` | *string* | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/instructtype.mdx b/client-sdks/typescript/api-reference/models/instructtype.mdx deleted file mode 100644 index 55c47a3f..00000000 --- a/client-sdks/typescript/api-reference/models/instructtype.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: InstructType - TypeScript SDK -sidebarTitle: InstructType -description: InstructType type definition -seoTitle: InstructType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/instructtype' -'og:site_name': OpenRouter Documentation -'og:title': InstructType Type | OpenRouter TypeScript SDK -'og:description': >- - InstructType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InstructType%20-%20TypeScript%20SDK&description=InstructType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```typescript lines -import { InstructType } from "@openrouter/sdk/models"; - -let value: InstructType = "chatml"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"none" | "airoboros" | "alpaca" | "alpaca-modif" | "chatml" | "claude" | "code-llama" | "gemma" | "llama2" | "llama3" | "mistral" | "nemotron" | "neural" | "openchat" | "phi3" | "rwkv" | "vicuna" | "zephyr" | "deepseek-r1" | "deepseek-v3.1" | "qwq" | "qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/internalserverresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/internalserverresponseerrordata.mdx deleted file mode 100644 index fb2fb931..00000000 --- a/client-sdks/typescript/api-reference/models/internalserverresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InternalServerResponseErrorData - TypeScript SDK -sidebarTitle: InternalServerResponseErrorData -description: InternalServerResponseErrorData type definition -seoTitle: InternalServerResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/internalserverresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - InternalServerResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseErrorData%20-%20TypeScript%20SDK&description=InternalServerResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for InternalServerResponse - -## Example Usage - -```typescript lines -import { InternalServerResponseErrorData } from "@openrouter/sdk/models"; - -let value: InternalServerResponseErrorData = { - code: 500, - message: "Internal Server Error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/itemreferenceitem.mdx b/client-sdks/typescript/api-reference/models/itemreferenceitem.mdx deleted file mode 100644 index b96f1cfe..00000000 --- a/client-sdks/typescript/api-reference/models/itemreferenceitem.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ItemReferenceItem - TypeScript SDK -sidebarTitle: ItemReferenceItem -description: ItemReferenceItem type definition -seoTitle: ItemReferenceItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/itemreferenceitem -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItem Type | OpenRouter TypeScript SDK -'og:description': >- - ItemReferenceItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItem%20-%20TypeScript%20SDK&description=ItemReferenceItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A reference to a previous response item by ID - -## Example Usage - -```typescript lines -import { ItemReferenceItem } from "@openrouter/sdk/models"; - -let value: ItemReferenceItem = { - id: "msg-abc123", - type: "item_reference", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ItemReferenceItemType](/client-sdks/typescript/api-reference/models/itemreferenceitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/itemreferenceitemtype.mdx b/client-sdks/typescript/api-reference/models/itemreferenceitemtype.mdx deleted file mode 100644 index 68ab3f30..00000000 --- a/client-sdks/typescript/api-reference/models/itemreferenceitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ItemReferenceItemType - TypeScript SDK -sidebarTitle: ItemReferenceItemType -description: ItemReferenceItemType type definition -seoTitle: ItemReferenceItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/itemreferenceitemtype -'og:site_name': OpenRouter Documentation -'og:title': ItemReferenceItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ItemReferenceItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ItemReferenceItemType%20-%20TypeScript%20SDK&description=ItemReferenceItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ItemReferenceItemType } from "@openrouter/sdk/models"; - -let value: ItemReferenceItemType = "item_reference"; -``` - -## Values - -```typescript lines -"item_reference" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/keep.mdx b/client-sdks/typescript/api-reference/models/keep.mdx deleted file mode 100644 index 7f2ad6c6..00000000 --- a/client-sdks/typescript/api-reference/models/keep.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Keep - TypeScript SDK -sidebarTitle: Keep -description: Keep type definition -seoTitle: Keep Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/keep' -'og:site_name': OpenRouter Documentation -'og:title': Keep Type | OpenRouter TypeScript SDK -'og:description': >- - Keep type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Keep%20-%20TypeScript%20SDK&description=Keep%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicThinkingTurns` - -```typescript lines -const value: models.AnthropicThinkingTurns = { - type: "thinking_turns", - value: 3, -}; -``` - -### `models.KeepAll` - -```typescript lines -const value: models.KeepAll = { - type: "all", -}; -``` - -### `models.KeepEnum` - -```typescript lines -const value: models.KeepEnum = "all"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/keepall.mdx b/client-sdks/typescript/api-reference/models/keepall.mdx deleted file mode 100644 index fa7ee6d1..00000000 --- a/client-sdks/typescript/api-reference/models/keepall.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: KeepAll - TypeScript SDK -sidebarTitle: KeepAll -description: KeepAll type definition -seoTitle: KeepAll Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/keepall' -'og:site_name': OpenRouter Documentation -'og:title': KeepAll Type | OpenRouter TypeScript SDK -'og:description': >- - KeepAll type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepAll%20-%20TypeScript%20SDK&description=KeepAll%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { KeepAll } from "@openrouter/sdk/models"; - -let value: KeepAll = { - type: "all", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [models.KeepType](/client-sdks/typescript/api-reference/models/keeptype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/keepenum.mdx b/client-sdks/typescript/api-reference/models/keepenum.mdx deleted file mode 100644 index 3b11265e..00000000 --- a/client-sdks/typescript/api-reference/models/keepenum.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: KeepEnum - TypeScript SDK -sidebarTitle: KeepEnum -description: KeepEnum type definition -seoTitle: KeepEnum Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/keepenum' -'og:site_name': OpenRouter Documentation -'og:title': KeepEnum Type | OpenRouter TypeScript SDK -'og:description': >- - KeepEnum type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepEnum%20-%20TypeScript%20SDK&description=KeepEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { KeepEnum } from "@openrouter/sdk/models"; - -let value: KeepEnum = "all"; -``` - -## Values - -```typescript lines -"all" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/keeptype.mdx b/client-sdks/typescript/api-reference/models/keeptype.mdx deleted file mode 100644 index 7df57c9c..00000000 --- a/client-sdks/typescript/api-reference/models/keeptype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: KeepType - TypeScript SDK -sidebarTitle: KeepType -description: KeepType type definition -seoTitle: KeepType Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/keeptype' -'og:site_name': OpenRouter Documentation -'og:title': KeepType Type | OpenRouter TypeScript SDK -'og:description': >- - KeepType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeepType%20-%20TypeScript%20SDK&description=KeepType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { KeepType } from "@openrouter/sdk/models"; - -let value: KeepType = "all"; -``` - -## Values - -```typescript lines -"all" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/keyassignment.mdx b/client-sdks/typescript/api-reference/models/keyassignment.mdx deleted file mode 100644 index c46fd8f9..00000000 --- a/client-sdks/typescript/api-reference/models/keyassignment.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: KeyAssignment - TypeScript SDK -sidebarTitle: KeyAssignment -description: KeyAssignment type definition -seoTitle: KeyAssignment Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/keyassignment' -'og:site_name': OpenRouter Documentation -'og:title': KeyAssignment Type | OpenRouter TypeScript SDK -'og:description': >- - KeyAssignment type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=KeyAssignment%20-%20TypeScript%20SDK&description=KeyAssignment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { KeyAssignment } from "@openrouter/sdk/models"; - -let value: KeyAssignment = { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - keyLabel: "prod-key", - keyName: "Production Key", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `keyHash` | *string* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `keyLabel` | *string* | :heavy_check_mark: | Label of the API key | prod-key | -| `keyName` | *string* | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/legacychatcontentvideo.mdx b/client-sdks/typescript/api-reference/models/legacychatcontentvideo.mdx deleted file mode 100644 index 550ff2e3..00000000 --- a/client-sdks/typescript/api-reference/models/legacychatcontentvideo.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ~~LegacyChatContentVideo~~ - TypeScript SDK -sidebarTitle: ~~LegacyChatContentVideo~~ -description: ~~LegacyChatContentVideo~~ type definition -seoTitle: ~~LegacyChatContentVideo~~ Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/legacychatcontentvideo -'og:site_name': OpenRouter Documentation -'og:title': ~~LegacyChatContentVideo~~ Type | OpenRouter TypeScript SDK -'og:description': >- - ~~LegacyChatContentVideo~~ type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~LegacyChatContentVideo~~%20-%20TypeScript%20SDK&description=~~LegacyChatContentVideo~~%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Video input content part (legacy format - deprecated) - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Example Usage - -```typescript lines -import { LegacyChatContentVideo } from "@openrouter/sdk/models"; - -let value: LegacyChatContentVideo = { - type: "input_video", - videoUrl: { - url: "https://example.com/video.mp4", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.ChatContentVideoInput](/client-sdks/typescript/api-reference/models/chatcontentvideoinput) | :heavy_check_mark: | Video input object | `{"url": "https://example.com/video.mp4"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/legacywebsearchservertool.mdx b/client-sdks/typescript/api-reference/models/legacywebsearchservertool.mdx deleted file mode 100644 index 006360b9..00000000 --- a/client-sdks/typescript/api-reference/models/legacywebsearchservertool.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: LegacyWebSearchServerTool - TypeScript SDK -sidebarTitle: LegacyWebSearchServerTool -description: LegacyWebSearchServerTool type definition -seoTitle: LegacyWebSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/legacywebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': LegacyWebSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - LegacyWebSearchServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LegacyWebSearchServerTool%20-%20TypeScript%20SDK&description=LegacyWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search tool configuration - -## Example Usage - -```typescript lines -import { LegacyWebSearchServerTool } from "@openrouter/sdk/models"; - -let value: LegacyWebSearchServerTool = { - type: "web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `filters` | [models.WebSearchDomainFilter](/client-sdks/typescript/api-reference/models/websearchdomainfilter) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `searchContextSize` | [models.SearchContextSizeEnum](/client-sdks/typescript/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | *"web_search"* | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/listbyokkeysresponse.mdx b/client-sdks/typescript/api-reference/models/listbyokkeysresponse.mdx deleted file mode 100644 index 51890b21..00000000 --- a/client-sdks/typescript/api-reference/models/listbyokkeysresponse.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: ListBYOKKeysResponse - TypeScript SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse type definition -seoTitle: ListBYOKKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listbyokkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListBYOKKeysResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20TypeScript%20SDK&description=ListBYOKKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListBYOKKeysResponse } from "@openrouter/sdk/models"; - -let value: ListBYOKKeysResponse = { - data: [ - { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [models.BYOKKey](/client-sdks/typescript/api-reference/models/byokkey)[] | :heavy_check_mark: | List of BYOK credentials. | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/listendpointsresponse.mdx b/client-sdks/typescript/api-reference/models/listendpointsresponse.mdx deleted file mode 100644 index 5faf61c9..00000000 --- a/client-sdks/typescript/api-reference/models/listendpointsresponse.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: ListEndpointsResponse - TypeScript SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse type definition -seoTitle: ListEndpointsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listendpointsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20TypeScript%20SDK&description=ListEndpointsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of available endpoints for a model - -## Example Usage - -```typescript expandable lines -import { ListEndpointsResponse } from "@openrouter/sdk/models"; - -let value: ListEndpointsResponse = { - architecture: { - inputModalities: [ - "text", - ], - instructType: "chatml", - modality: "text->text", - outputModalities: [ - "text", - ], - tokenizer: "GPT", - }, - created: 1692901234, - description: - "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", - endpoints: [ - { - contextLength: 8192, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - modelId: "openai/gpt-4", - modelName: "GPT-4", - name: "OpenAI: GPT-4", - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - providerName: "OpenAI", - quantization: "fp16", - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - "frequency_penalty", - "presence_penalty", - ], - supportsImplicitCaching: true, - tag: "openai", - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - uptimeLast1d: 99.8, - uptimeLast30m: 99.5, - uptimeLast5m: 100, - }, - ], - id: "openai/gpt-4", - name: "GPT-4", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `architecture` | [models.Architecture](/client-sdks/typescript/api-reference/models/architecture) | :heavy_check_mark: | N/A | `{"instruct_type": "chatml","modality": "text","tokenizer": "GPT"}` | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *string* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | [models.PublicEndpoint](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/listguardrailsresponse.mdx b/client-sdks/typescript/api-reference/models/listguardrailsresponse.mdx deleted file mode 100644 index 47bb17b0..00000000 --- a/client-sdks/typescript/api-reference/models/listguardrailsresponse.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListGuardrailsResponse - TypeScript SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse type definition -seoTitle: ListGuardrailsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listguardrailsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20TypeScript%20SDK&description=ListGuardrailsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsResponse } from "@openrouter/sdk/models"; - -let value: ListGuardrailsResponse = { - data: [ - { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Guardrail](/client-sdks/typescript/api-reference/models/guardrail)[] | :heavy_check_mark: | List of guardrails | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/listkeyassignmentsresponse.mdx b/client-sdks/typescript/api-reference/models/listkeyassignmentsresponse.mdx deleted file mode 100644 index 0cf1e9dc..00000000 --- a/client-sdks/typescript/api-reference/models/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - TypeScript SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse type definition -seoTitle: ListKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20TypeScript%20SDK&description=ListKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsResponse } from "@openrouter/sdk/models"; - -let value: ListKeyAssignmentsResponse = { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - keyLabel: "prod-key", - keyName: "Production Key", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | [models.KeyAssignment](/client-sdks/typescript/api-reference/models/keyassignment)[] | :heavy_check_mark: | List of key assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/listmemberassignmentsresponse.mdx b/client-sdks/typescript/api-reference/models/listmemberassignmentsresponse.mdx deleted file mode 100644 index 441da764..00000000 --- a/client-sdks/typescript/api-reference/models/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - TypeScript SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse type definition -seoTitle: ListMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20TypeScript%20SDK&description=ListMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsResponse } from "@openrouter/sdk/models"; - -let value: ListMemberAssignmentsResponse = { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - organizationId: "org_xyz789", - userId: "user_abc123", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | [models.MemberAssignment](/client-sdks/typescript/api-reference/models/memberassignment)[] | :heavy_check_mark: | List of member assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/listobservabilitydestinationsresponse.mdx b/client-sdks/typescript/api-reference/models/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index 8f7c34f0..00000000 --- a/client-sdks/typescript/api-reference/models/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - TypeScript SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse type definition -seoTitle: ListObservabilityDestinationsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListObservabilityDestinationsResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20TypeScript%20SDK&description=ListObservabilityDestinationsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListObservabilityDestinationsResponse } from "@openrouter/sdk/models"; - -let value: ListObservabilityDestinationsResponse = { - data: [ - { - apiKeyHashes: null, - config: { - baseUrl: "https://us.cloud.langfuse.com", - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | *models.ObservabilityDestination*[] | :heavy_check_mark: | List of observability destinations. | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/listworkspacesresponse.mdx b/client-sdks/typescript/api-reference/models/listworkspacesresponse.mdx deleted file mode 100644 index d41b474c..00000000 --- a/client-sdks/typescript/api-reference/models/listworkspacesresponse.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: ListWorkspacesResponse - TypeScript SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse type definition -seoTitle: ListWorkspacesResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/listworkspacesresponse -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListWorkspacesResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20TypeScript%20SDK&description=ListWorkspacesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListWorkspacesResponse } from "@openrouter/sdk/models"; - -let value: ListWorkspacesResponse = { - data: [ - { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Production", - slug: "production", - updatedAt: "2025-08-24T15:45:00Z", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Workspace](/client-sdks/typescript/api-reference/models/workspace)[] | :heavy_check_mark: | List of workspaces | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/localshellcallitem.mdx b/client-sdks/typescript/api-reference/models/localshellcallitem.mdx deleted file mode 100644 index c04cbd66..00000000 --- a/client-sdks/typescript/api-reference/models/localshellcallitem.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: LocalShellCallItem - TypeScript SDK -sidebarTitle: LocalShellCallItem -description: LocalShellCallItem type definition -seoTitle: LocalShellCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/localshellcallitem -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - LocalShellCallItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItem%20-%20TypeScript%20SDK&description=LocalShellCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A local shell command execution call - -## Example Usage - -```typescript lines -import { LocalShellCallItem } from "@openrouter/sdk/models"; - -let value: LocalShellCallItem = { - action: { - command: [ - "ls", - "-la", - ], - env: { - "PATH": "/usr/bin", - }, - type: "exec", - }, - callId: "call-abc123", - id: "shell-abc123", - status: "completed", - type: "local_shell_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `action` | [models.LocalShellCallItemAction](/client-sdks/typescript/api-reference/models/localshellcallitemaction) | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeLocalShellCall](/client-sdks/typescript/api-reference/models/typelocalshellcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/localshellcallitemaction.mdx b/client-sdks/typescript/api-reference/models/localshellcallitemaction.mdx deleted file mode 100644 index 63c164ef..00000000 --- a/client-sdks/typescript/api-reference/models/localshellcallitemaction.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: LocalShellCallItemAction - TypeScript SDK -sidebarTitle: LocalShellCallItemAction -description: LocalShellCallItemAction type definition -seoTitle: LocalShellCallItemAction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/localshellcallitemaction -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallItemAction Type | OpenRouter TypeScript SDK -'og:description': >- - LocalShellCallItemAction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallItemAction%20-%20TypeScript%20SDK&description=LocalShellCallItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { LocalShellCallItemAction } from "@openrouter/sdk/models"; - -let value: LocalShellCallItemAction = { - command: [ - "", - ], - env: {}, - type: "exec", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `command` | *string*[] | :heavy_check_mark: | N/A | -| `env` | `Record` | :heavy_check_mark: | N/A | -| `timeoutMs` | *number* | :heavy_minus_sign: | N/A | -| `type` | [models.TypeExec](/client-sdks/typescript/api-reference/models/typeexec) | :heavy_check_mark: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `workingDirectory` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/localshellcalloutputitem.mdx b/client-sdks/typescript/api-reference/models/localshellcalloutputitem.mdx deleted file mode 100644 index a67ce3e0..00000000 --- a/client-sdks/typescript/api-reference/models/localshellcalloutputitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: LocalShellCallOutputItem - TypeScript SDK -sidebarTitle: LocalShellCallOutputItem -description: LocalShellCallOutputItem type definition -seoTitle: LocalShellCallOutputItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/localshellcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItem Type | OpenRouter TypeScript SDK -'og:description': >- - LocalShellCallOutputItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItem%20-%20TypeScript%20SDK&description=LocalShellCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Output from a local shell command execution - -## Example Usage - -```typescript lines -import { LocalShellCallOutputItem } from "@openrouter/sdk/models"; - -let value: LocalShellCallOutputItem = { - id: "output-abc123", - output: "total 24\ndrwxr-xr-x 5 user staff 160 Jan 1 12:00 .", - type: "local_shell_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `output` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.LocalShellCallOutputItemStatus](/client-sdks/typescript/api-reference/models/localshellcalloutputitemstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.LocalShellCallOutputItemType](/client-sdks/typescript/api-reference/models/localshellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/localshellcalloutputitemstatus.mdx b/client-sdks/typescript/api-reference/models/localshellcalloutputitemstatus.mdx deleted file mode 100644 index 2476e1ea..00000000 --- a/client-sdks/typescript/api-reference/models/localshellcalloutputitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: LocalShellCallOutputItemStatus - TypeScript SDK -sidebarTitle: LocalShellCallOutputItemStatus -description: LocalShellCallOutputItemStatus type definition -seoTitle: LocalShellCallOutputItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/localshellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - LocalShellCallOutputItemStatus type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemStatus%20-%20TypeScript%20SDK&description=LocalShellCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { LocalShellCallOutputItemStatus } from "@openrouter/sdk/models"; - -let value: LocalShellCallOutputItemStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/localshellcalloutputitemtype.mdx b/client-sdks/typescript/api-reference/models/localshellcalloutputitemtype.mdx deleted file mode 100644 index 396036ec..00000000 --- a/client-sdks/typescript/api-reference/models/localshellcalloutputitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: LocalShellCallOutputItemType - TypeScript SDK -sidebarTitle: LocalShellCallOutputItemType -description: LocalShellCallOutputItemType type definition -seoTitle: LocalShellCallOutputItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/localshellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': LocalShellCallOutputItemType Type | OpenRouter TypeScript SDK -'og:description': >- - LocalShellCallOutputItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=LocalShellCallOutputItemType%20-%20TypeScript%20SDK&description=LocalShellCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { LocalShellCallOutputItemType } from "@openrouter/sdk/models"; - -let value: LocalShellCallOutputItemType = "local_shell_call_output"; -``` - -## Values - -```typescript lines -"local_shell_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/logic.mdx b/client-sdks/typescript/api-reference/models/logic.mdx deleted file mode 100644 index 645f731f..00000000 --- a/client-sdks/typescript/api-reference/models/logic.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Logic - TypeScript SDK -sidebarTitle: Logic -description: Logic type definition -seoTitle: Logic Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/logic' -'og:site_name': OpenRouter Documentation -'og:title': Logic Type | OpenRouter TypeScript SDK -'og:description': >- - Logic type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logic%20-%20TypeScript%20SDK&description=Logic%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Logic } from "@openrouter/sdk/models"; - -let value: Logic = "or"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"and" | "or" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/logprob.mdx b/client-sdks/typescript/api-reference/models/logprob.mdx deleted file mode 100644 index a2848bab..00000000 --- a/client-sdks/typescript/api-reference/models/logprob.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Logprob - TypeScript SDK -sidebarTitle: Logprob -description: Logprob type definition -seoTitle: Logprob Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/logprob' -'og:site_name': OpenRouter Documentation -'og:title': Logprob Type | OpenRouter TypeScript SDK -'og:description': >- - Logprob type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logprob%20-%20TypeScript%20SDK&description=Logprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Logprob } from "@openrouter/sdk/models"; - -let value: Logprob = { - bytes: [ - 322637, - ], - logprob: 2246.86, - token: "", - topLogprobs: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ResponseOutputTextTopLogprob](/client-sdks/typescript/api-reference/models/responseoutputtexttoplogprob)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/maxprice.mdx b/client-sdks/typescript/api-reference/models/maxprice.mdx deleted file mode 100644 index 585b5b28..00000000 --- a/client-sdks/typescript/api-reference/models/maxprice.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: MaxPrice - TypeScript SDK -sidebarTitle: MaxPrice -description: MaxPrice type definition -seoTitle: MaxPrice Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/maxprice' -'og:site_name': OpenRouter Documentation -'og:title': MaxPrice Type | OpenRouter TypeScript SDK -'og:description': >- - MaxPrice type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MaxPrice%20-%20TypeScript%20SDK&description=MaxPrice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Example Usage - -```typescript lines -import { MaxPrice } from "@openrouter/sdk/models"; - -let value: MaxPrice = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `audio` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `image` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *string* | :heavy_minus_sign: | Price per million prompt tokens | 1000 | -| `request` | *string* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpapprovalrequestitem.mdx b/client-sdks/typescript/api-reference/models/mcpapprovalrequestitem.mdx deleted file mode 100644 index 53138da5..00000000 --- a/client-sdks/typescript/api-reference/models/mcpapprovalrequestitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: McpApprovalRequestItem - TypeScript SDK -sidebarTitle: McpApprovalRequestItem -description: McpApprovalRequestItem type definition -seoTitle: McpApprovalRequestItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcpapprovalrequestitem -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItem Type | OpenRouter TypeScript SDK -'og:description': >- - McpApprovalRequestItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItem%20-%20TypeScript%20SDK&description=McpApprovalRequestItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request for approval to execute an MCP tool - -## Example Usage - -```typescript lines -import { McpApprovalRequestItem } from "@openrouter/sdk/models"; - -let value: McpApprovalRequestItem = { - arguments: "{\"id\":\"123\"}", - id: "approval-abc123", - name: "delete_record", - serverLabel: "database-server", - type: "mcp_approval_request", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpApprovalRequestItemType](/client-sdks/typescript/api-reference/models/mcpapprovalrequestitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpapprovalrequestitemtype.mdx b/client-sdks/typescript/api-reference/models/mcpapprovalrequestitemtype.mdx deleted file mode 100644 index f600c087..00000000 --- a/client-sdks/typescript/api-reference/models/mcpapprovalrequestitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: McpApprovalRequestItemType - TypeScript SDK -sidebarTitle: McpApprovalRequestItemType -description: McpApprovalRequestItemType type definition -seoTitle: McpApprovalRequestItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcpapprovalrequestitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalRequestItemType Type | OpenRouter TypeScript SDK -'og:description': >- - McpApprovalRequestItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalRequestItemType%20-%20TypeScript%20SDK&description=McpApprovalRequestItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { McpApprovalRequestItemType } from "@openrouter/sdk/models"; - -let value: McpApprovalRequestItemType = "mcp_approval_request"; -``` - -## Values - -```typescript lines -"mcp_approval_request" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpapprovalresponseitem.mdx b/client-sdks/typescript/api-reference/models/mcpapprovalresponseitem.mdx deleted file mode 100644 index a3638ec5..00000000 --- a/client-sdks/typescript/api-reference/models/mcpapprovalresponseitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: McpApprovalResponseItem - TypeScript SDK -sidebarTitle: McpApprovalResponseItem -description: McpApprovalResponseItem type definition -seoTitle: McpApprovalResponseItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcpapprovalresponseitem -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItem Type | OpenRouter TypeScript SDK -'og:description': >- - McpApprovalResponseItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItem%20-%20TypeScript%20SDK&description=McpApprovalResponseItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -User response to an MCP tool approval request - -## Example Usage - -```typescript lines -import { McpApprovalResponseItem } from "@openrouter/sdk/models"; - -let value: McpApprovalResponseItem = { - approvalRequestId: "approval-abc123", - approve: true, - type: "mcp_approval_response", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `approvalRequestId` | *string* | :heavy_check_mark: | N/A | -| `approve` | *boolean* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `reason` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.McpApprovalResponseItemType](/client-sdks/typescript/api-reference/models/mcpapprovalresponseitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpapprovalresponseitemtype.mdx b/client-sdks/typescript/api-reference/models/mcpapprovalresponseitemtype.mdx deleted file mode 100644 index 69e411a6..00000000 --- a/client-sdks/typescript/api-reference/models/mcpapprovalresponseitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: McpApprovalResponseItemType - TypeScript SDK -sidebarTitle: McpApprovalResponseItemType -description: McpApprovalResponseItemType type definition -seoTitle: McpApprovalResponseItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcpapprovalresponseitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpApprovalResponseItemType Type | OpenRouter TypeScript SDK -'og:description': >- - McpApprovalResponseItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpApprovalResponseItemType%20-%20TypeScript%20SDK&description=McpApprovalResponseItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { McpApprovalResponseItemType } from "@openrouter/sdk/models"; - -let value: McpApprovalResponseItemType = "mcp_approval_response"; -``` - -## Values - -```typescript lines -"mcp_approval_response" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpcallitem.mdx b/client-sdks/typescript/api-reference/models/mcpcallitem.mdx deleted file mode 100644 index 636b3997..00000000 --- a/client-sdks/typescript/api-reference/models/mcpcallitem.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: McpCallItem - TypeScript SDK -sidebarTitle: McpCallItem -description: McpCallItem type definition -seoTitle: McpCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/mcpcallitem' -'og:site_name': OpenRouter Documentation -'og:title': McpCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - McpCallItem type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItem%20-%20TypeScript%20SDK&description=McpCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An MCP tool call with its output or error - -## Example Usage - -```typescript lines -import { McpCallItem } from "@openrouter/sdk/models"; - -let value: McpCallItem = { - arguments: "{\"query\":\"SELECT * FROM users\"}", - id: "mcp-call-abc123", - name: "query_database", - serverLabel: "database-server", - type: "mcp_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `error` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `output` | *string* | :heavy_minus_sign: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpCallItemType](/client-sdks/typescript/api-reference/models/mcpcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpcallitemtype.mdx b/client-sdks/typescript/api-reference/models/mcpcallitemtype.mdx deleted file mode 100644 index 476fd30c..00000000 --- a/client-sdks/typescript/api-reference/models/mcpcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: McpCallItemType - TypeScript SDK -sidebarTitle: McpCallItemType -description: McpCallItemType type definition -seoTitle: McpCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcpcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - McpCallItemType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpCallItemType%20-%20TypeScript%20SDK&description=McpCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { McpCallItemType } from "@openrouter/sdk/models"; - -let value: McpCallItemType = "mcp_call"; -``` - -## Values - -```typescript lines -"mcp_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcplisttoolsitem.mdx b/client-sdks/typescript/api-reference/models/mcplisttoolsitem.mdx deleted file mode 100644 index 9c682602..00000000 --- a/client-sdks/typescript/api-reference/models/mcplisttoolsitem.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: McpListToolsItem - TypeScript SDK -sidebarTitle: McpListToolsItem -description: McpListToolsItem type definition -seoTitle: McpListToolsItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcplisttoolsitem -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItem Type | OpenRouter TypeScript SDK -'og:description': >- - McpListToolsItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItem%20-%20TypeScript%20SDK&description=McpListToolsItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of available MCP tools from a server - -## Example Usage - -```typescript lines -import { McpListToolsItem } from "@openrouter/sdk/models"; - -let value: McpListToolsItem = { - id: "mcp-list-abc123", - serverLabel: "database-server", - tools: [ - { - inputSchema: { - "properties": { - "query": { - "type": "string", - }, - }, - "type": "object", - }, - name: "query_database", - }, - ], - type: "mcp_list_tools", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `error` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `tools` | [models.McpListToolsItemTool](/client-sdks/typescript/api-reference/models/mcplisttoolsitemtool)[] | :heavy_check_mark: | N/A | -| `type` | [models.McpListToolsItemType](/client-sdks/typescript/api-reference/models/mcplisttoolsitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcplisttoolsitemtool.mdx b/client-sdks/typescript/api-reference/models/mcplisttoolsitemtool.mdx deleted file mode 100644 index 162f3814..00000000 --- a/client-sdks/typescript/api-reference/models/mcplisttoolsitemtool.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: McpListToolsItemTool - TypeScript SDK -sidebarTitle: McpListToolsItemTool -description: McpListToolsItemTool type definition -seoTitle: McpListToolsItemTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcplisttoolsitemtool -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemTool Type | OpenRouter TypeScript SDK -'og:description': >- - McpListToolsItemTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemTool%20-%20TypeScript%20SDK&description=McpListToolsItemTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { McpListToolsItemTool } from "@openrouter/sdk/models"; - -let value: McpListToolsItemTool = { - inputSchema: {}, - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `annotations` | *any* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `inputSchema` | `Record` | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcplisttoolsitemtype.mdx b/client-sdks/typescript/api-reference/models/mcplisttoolsitemtype.mdx deleted file mode 100644 index ba0e285b..00000000 --- a/client-sdks/typescript/api-reference/models/mcplisttoolsitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: McpListToolsItemType - TypeScript SDK -sidebarTitle: McpListToolsItemType -description: McpListToolsItemType type definition -seoTitle: McpListToolsItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/mcplisttoolsitemtype -'og:site_name': OpenRouter Documentation -'og:title': McpListToolsItemType Type | OpenRouter TypeScript SDK -'og:description': >- - McpListToolsItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpListToolsItemType%20-%20TypeScript%20SDK&description=McpListToolsItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { McpListToolsItemType } from "@openrouter/sdk/models"; - -let value: McpListToolsItemType = "mcp_list_tools"; -``` - -## Values - -```typescript lines -"mcp_list_tools" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mcpservertool.mdx b/client-sdks/typescript/api-reference/models/mcpservertool.mdx deleted file mode 100644 index f2d7eb81..00000000 --- a/client-sdks/typescript/api-reference/models/mcpservertool.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: McpServerTool - TypeScript SDK -sidebarTitle: McpServerTool -description: McpServerTool type definition -seoTitle: McpServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/mcpservertool' -'og:site_name': OpenRouter Documentation -'og:title': McpServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - McpServerTool type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=McpServerTool%20-%20TypeScript%20SDK&description=McpServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -MCP (Model Context Protocol) tool configuration - -## Example Usage - -```typescript lines -import { McpServerTool } from "@openrouter/sdk/models"; - -let value: McpServerTool = { - serverLabel: "my-server", - type: "mcp", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `allowedTools` | *models.AllowedToolsUnion* | :heavy_minus_sign: | N/A | -| `authorization` | *string* | :heavy_minus_sign: | N/A | -| `connectorId` | [models.ConnectorId](/client-sdks/typescript/api-reference/models/connectorid) | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | N/A | -| `requireApproval` | *models.RequireApprovalUnion* | :heavy_minus_sign: | N/A | -| `serverDescription` | *string* | :heavy_minus_sign: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `serverUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"mcp"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/memberassignment.mdx b/client-sdks/typescript/api-reference/models/memberassignment.mdx deleted file mode 100644 index 8ddaa4e0..00000000 --- a/client-sdks/typescript/api-reference/models/memberassignment.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: MemberAssignment - TypeScript SDK -sidebarTitle: MemberAssignment -description: MemberAssignment type definition -seoTitle: MemberAssignment Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/memberassignment -'og:site_name': OpenRouter Documentation -'og:title': MemberAssignment Type | OpenRouter TypeScript SDK -'og:description': >- - MemberAssignment type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemberAssignment%20-%20TypeScript%20SDK&description=MemberAssignment%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MemberAssignment } from "@openrouter/sdk/models"; - -let value: MemberAssignment = { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - organizationId: "org_xyz789", - userId: "user_abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `organizationId` | *string* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `userId` | *string* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/memorylimit.mdx b/client-sdks/typescript/api-reference/models/memorylimit.mdx deleted file mode 100644 index 7e9570c2..00000000 --- a/client-sdks/typescript/api-reference/models/memorylimit.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MemoryLimit - TypeScript SDK -sidebarTitle: MemoryLimit -description: MemoryLimit type definition -seoTitle: MemoryLimit Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/memorylimit' -'og:site_name': OpenRouter Documentation -'og:title': MemoryLimit Type | OpenRouter TypeScript SDK -'og:description': >- - MemoryLimit type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MemoryLimit%20-%20TypeScript%20SDK&description=MemoryLimit%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MemoryLimit } from "@openrouter/sdk/models"; - -let value: MemoryLimit = "16g"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"1g" | "4g" | "16g" | "64g" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesadvisortoolresultblock.mdx b/client-sdks/typescript/api-reference/models/messagesadvisortoolresultblock.mdx deleted file mode 100644 index daca58cf..00000000 --- a/client-sdks/typescript/api-reference/models/messagesadvisortoolresultblock.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: MessagesAdvisorToolResultBlock - TypeScript SDK -sidebarTitle: MessagesAdvisorToolResultBlock -description: MessagesAdvisorToolResultBlock type definition -seoTitle: MessagesAdvisorToolResultBlock Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesadvisortoolresultblock -'og:site_name': OpenRouter Documentation -'og:title': MessagesAdvisorToolResultBlock Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesAdvisorToolResultBlock type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesAdvisorToolResultBlock%20-%20TypeScript%20SDK&description=MessagesAdvisorToolResultBlock%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Advisor tool result from a prior assistant turn, replayed back to the model on the next turn. Mirrors the block Anthropic returns in assistant content when the `advisor_20260301` tool runs. - -## Example Usage - -```typescript lines -import { MessagesAdvisorToolResultBlock } from "@openrouter/sdk/models"; - -let value: MessagesAdvisorToolResultBlock = { - content: { - "text": "Advisor response text", - "type": "advisor_result", - }, - toolUseId: "srvtoolu_01abc", - type: "advisor_tool_result", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `content` | `Record` | :heavy_check_mark: | N/A | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"advisor_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparam.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparam.mdx deleted file mode 100644 index 6f3af58b..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparam.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: MessagesMessageParam - TypeScript SDK -sidebarTitle: MessagesMessageParam -description: MessagesMessageParam type definition -seoTitle: MessagesMessageParam Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparam -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParam Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParam type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParam%20-%20TypeScript%20SDK&description=MessagesMessageParam%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Anthropic message with OpenRouter extensions - -## Example Usage - -```typescript lines -import { MessagesMessageParam } from "@openrouter/sdk/models"; - -let value: MessagesMessageParam = { - content: "Hello, how are you?", - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | *models.MessagesMessageParamContentUnion5* | :heavy_check_mark: | N/A | -| `role` | [models.MessagesMessageParamRole](/client-sdks/typescript/api-reference/models/messagesmessageparamrole) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion1.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion1.mdx deleted file mode 100644 index 6cb71a20..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion1.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: MessagesMessageParamContentUnion1 - TypeScript SDK -sidebarTitle: MessagesMessageParamContentUnion1 -description: MessagesMessageParamContentUnion1 type definition -seoTitle: MessagesMessageParamContentUnion1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamcontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion1 Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamContentUnion1 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion1%20-%20TypeScript%20SDK&description=MessagesMessageParamContentUnion1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicTextBlockParam` - -```typescript lines -const value: models.AnthropicTextBlockParam = { - text: "Hello, world!", - type: "text", -}; -``` - -### `models.AnthropicImageBlockParam` - -```typescript lines -const value: models.AnthropicImageBlockParam = { - source: { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", - }, - type: "image", -}; -``` - -### `models.ContentToolReference` - -```typescript lines -const value: models.ContentToolReference = { - toolName: "", - type: "tool_reference", -}; -``` - -### `models.AnthropicSearchResultBlockParam` - -```typescript lines -const value: models.AnthropicSearchResultBlockParam = { - content: [ - { - text: "Result content", - type: "text", - }, - ], - source: "example_source", - title: "Example Result", - type: "search_result", -}; -``` - -### `models.AnthropicDocumentBlockParam` - -```typescript lines -const value: models.AnthropicDocumentBlockParam = { - source: { - data: "Hello, world!", - mediaType: "text/plain", - type: "text", - }, - type: "document", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion2.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion2.mdx deleted file mode 100644 index 60e3f46f..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion2.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: MessagesMessageParamContentUnion2 - TypeScript SDK -sidebarTitle: MessagesMessageParamContentUnion2 -description: MessagesMessageParamContentUnion2 type definition -seoTitle: MessagesMessageParamContentUnion2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamcontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion2 Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamContentUnion2 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion2%20-%20TypeScript%20SDK&description=MessagesMessageParamContentUnion2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.MessagesMessageParamContentUnion1[]` - -```typescript lines -const value: models.MessagesMessageParamContentUnion1[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion3.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion3.mdx deleted file mode 100644 index f70c02a3..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion3.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: MessagesMessageParamContentUnion3 - TypeScript SDK -sidebarTitle: MessagesMessageParamContentUnion3 -description: MessagesMessageParamContentUnion3 type definition -seoTitle: MessagesMessageParamContentUnion3 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamcontentunion3 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion3 Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamContentUnion3 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion3%20-%20TypeScript%20SDK&description=MessagesMessageParamContentUnion3%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicWebSearchResultBlockParam[]` - -```typescript lines -const value: models.AnthropicWebSearchResultBlockParam[] = [ - { - encryptedContent: "enc_content_0", - title: "Example Page", - type: "web_search_result", - url: "https://example.com", - }, -]; -``` - -### `models.ContentWebSearchToolResultError` - -```typescript lines -const value: models.ContentWebSearchToolResultError = { - errorCode: "unavailable", - type: "web_search_tool_result_error", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion4.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion4.mdx deleted file mode 100644 index 72ded3a1..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion4.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: MessagesMessageParamContentUnion4 - TypeScript SDK -sidebarTitle: MessagesMessageParamContentUnion4 -description: MessagesMessageParamContentUnion4 type definition -seoTitle: MessagesMessageParamContentUnion4 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamcontentunion4 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion4 Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamContentUnion4 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion4%20-%20TypeScript%20SDK&description=MessagesMessageParamContentUnion4%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicTextBlockParam` - -```typescript lines -const value: models.AnthropicTextBlockParam = { - text: "Hello, world!", - type: "text", -}; -``` - -### `models.AnthropicImageBlockParam` - -```typescript lines -const value: models.AnthropicImageBlockParam = { - source: { - data: "/9j/4AAQ...", - mediaType: "image/jpeg", - type: "base64", - }, - type: "image", -}; -``` - -### `models.AnthropicDocumentBlockParam` - -```typescript lines -const value: models.AnthropicDocumentBlockParam = { - source: { - data: "Hello, world!", - mediaType: "text/plain", - type: "text", - }, - type: "document", -}; -``` - -### `models.ContentToolUse` - -```typescript lines -const value: models.ContentToolUse = { - id: "", - name: "", - type: "tool_use", -}; -``` - -### `models.ContentToolResult` - -```typescript lines -const value: models.ContentToolResult = { - toolUseId: "", - type: "tool_result", -}; -``` - -### `models.ContentThinking` - -```typescript lines -const value: models.ContentThinking = { - signature: "", - thinking: "", - type: "thinking", -}; -``` - -### `models.ContentRedactedThinking` - -```typescript lines -const value: models.ContentRedactedThinking = { - data: "", - type: "redacted_thinking", -}; -``` - -### `models.ContentServerToolUse` - -```typescript lines -const value: models.ContentServerToolUse = { - id: "", - name: "", - type: "server_tool_use", -}; -``` - -### `models.ContentWebSearchToolResult` - -```typescript lines -const value: models.ContentWebSearchToolResult = { - content: [ - { - encryptedContent: "enc_content_0", - title: "Example Page", - type: "web_search_result", - url: "https://example.com", - }, - ], - toolUseId: "", - type: "web_search_tool_result", -}; -``` - -### `models.AnthropicSearchResultBlockParam` - -```typescript lines -const value: models.AnthropicSearchResultBlockParam = { - content: [ - { - text: "Result content", - type: "text", - }, - ], - source: "example_source", - title: "Example Result", - type: "search_result", -}; -``` - -### `models.ContentCompaction` - -```typescript lines -const value: models.ContentCompaction = { - content: null, - type: "compaction", -}; -``` - -### `models.MessagesAdvisorToolResultBlock` - -```typescript lines -const value: models.MessagesAdvisorToolResultBlock = { - content: { - "text": "Advisor response text", - "type": "advisor_result", - }, - toolUseId: "srvtoolu_01abc", - type: "advisor_tool_result", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion5.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion5.mdx deleted file mode 100644 index d04e3bea..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamcontentunion5.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: MessagesMessageParamContentUnion5 - TypeScript SDK -sidebarTitle: MessagesMessageParamContentUnion5 -description: MessagesMessageParamContentUnion5 type definition -seoTitle: MessagesMessageParamContentUnion5 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamcontentunion5 -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamContentUnion5 Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamContentUnion5 type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamContentUnion5%20-%20TypeScript%20SDK&description=MessagesMessageParamContentUnion5%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.MessagesMessageParamContentUnion4[]` - -```typescript lines -const value: models.MessagesMessageParamContentUnion4[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesmessageparamrole.mdx b/client-sdks/typescript/api-reference/models/messagesmessageparamrole.mdx deleted file mode 100644 index 5a9d9104..00000000 --- a/client-sdks/typescript/api-reference/models/messagesmessageparamrole.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: MessagesMessageParamRole - TypeScript SDK -sidebarTitle: MessagesMessageParamRole -description: MessagesMessageParamRole type definition -seoTitle: MessagesMessageParamRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesmessageparamrole -'og:site_name': OpenRouter Documentation -'og:title': MessagesMessageParamRole Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesMessageParamRole type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesMessageParamRole%20-%20TypeScript%20SDK&description=MessagesMessageParamRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MessagesMessageParamRole } from "@openrouter/sdk/models"; - -let value: MessagesMessageParamRole = "assistant"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"user" | "assistant" | "system" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesoutputconfig.mdx b/client-sdks/typescript/api-reference/models/messagesoutputconfig.mdx deleted file mode 100644 index 6754687f..00000000 --- a/client-sdks/typescript/api-reference/models/messagesoutputconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: MessagesOutputConfig - TypeScript SDK -sidebarTitle: MessagesOutputConfig -description: MessagesOutputConfig type definition -seoTitle: MessagesOutputConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesoutputconfig -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfig Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesOutputConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfig%20-%20TypeScript%20SDK&description=MessagesOutputConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for controlling output behavior. Supports the effort parameter and structured output format. - -## Example Usage - -```typescript lines -import { MessagesOutputConfig } from "@openrouter/sdk/models"; - -let value: MessagesOutputConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [models.MessagesOutputConfigEffort](/client-sdks/typescript/api-reference/models/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` | [models.MessagesOutputConfigFormat](/client-sdks/typescript/api-reference/models/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` | [models.TaskBudget](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/messagesoutputconfigeffort.mdx b/client-sdks/typescript/api-reference/models/messagesoutputconfigeffort.mdx deleted file mode 100644 index 81fb10ef..00000000 --- a/client-sdks/typescript/api-reference/models/messagesoutputconfigeffort.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: MessagesOutputConfigEffort - TypeScript SDK -sidebarTitle: MessagesOutputConfigEffort -description: MessagesOutputConfigEffort type definition -seoTitle: MessagesOutputConfigEffort Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesoutputconfigeffort -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigEffort Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesOutputConfigEffort type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigEffort%20-%20TypeScript%20SDK&description=MessagesOutputConfigEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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`. - -## Example Usage - -```typescript lines -import { MessagesOutputConfigEffort } from "@openrouter/sdk/models"; - -let value: MessagesOutputConfigEffort = "medium"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"low" | "medium" | "high" | "xhigh" | "max" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesoutputconfigformat.mdx b/client-sdks/typescript/api-reference/models/messagesoutputconfigformat.mdx deleted file mode 100644 index 8d58c9ff..00000000 --- a/client-sdks/typescript/api-reference/models/messagesoutputconfigformat.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: MessagesOutputConfigFormat - TypeScript SDK -sidebarTitle: MessagesOutputConfigFormat -description: MessagesOutputConfigFormat type definition -seoTitle: MessagesOutputConfigFormat Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesoutputconfigformat -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigFormat Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesOutputConfigFormat type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigFormat%20-%20TypeScript%20SDK&description=MessagesOutputConfigFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). - -## Example Usage - -```typescript lines -import { MessagesOutputConfigFormat } from "@openrouter/sdk/models"; - -let value: MessagesOutputConfigFormat = { - schema: {}, - type: "json_schema", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `schema` | `Record` | :heavy_check_mark: | N/A | -| `type` | [models.MessagesOutputConfigTypeJSONSchema](/client-sdks/typescript/api-reference/models/messagesoutputconfigtypejsonschema) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesoutputconfigtypejsonschema.mdx b/client-sdks/typescript/api-reference/models/messagesoutputconfigtypejsonschema.mdx deleted file mode 100644 index fd7fa383..00000000 --- a/client-sdks/typescript/api-reference/models/messagesoutputconfigtypejsonschema.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: MessagesOutputConfigTypeJSONSchema - TypeScript SDK -sidebarTitle: MessagesOutputConfigTypeJSONSchema -description: MessagesOutputConfigTypeJSONSchema type definition -seoTitle: MessagesOutputConfigTypeJSONSchema Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesoutputconfigtypejsonschema -'og:site_name': OpenRouter Documentation -'og:title': MessagesOutputConfigTypeJSONSchema Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesOutputConfigTypeJSONSchema type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesOutputConfigTypeJSONSchema%20-%20TypeScript%20SDK&description=MessagesOutputConfigTypeJSONSchema%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MessagesOutputConfigTypeJSONSchema } from "@openrouter/sdk/models"; - -let value: MessagesOutputConfigTypeJSONSchema = "json_schema"; -``` - -## Values - -```typescript lines -"json_schema" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesrequest.mdx b/client-sdks/typescript/api-reference/models/messagesrequest.mdx deleted file mode 100644 index fd5aa7a2..00000000 --- a/client-sdks/typescript/api-reference/models/messagesrequest.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: MessagesRequest - TypeScript SDK -sidebarTitle: MessagesRequest -description: MessagesRequest type definition -seoTitle: MessagesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesrequest -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequest%20-%20TypeScript%20SDK&description=MessagesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request schema for Anthropic Messages API endpoint - -## Example Usage - -```typescript lines -import { MessagesRequest } from "@openrouter/sdk/models"; - -let value: MessagesRequest = { - messages: [ - { - content: "Hello, how are you?", - role: "user", - }, - ], - model: "anthropic/claude-4.5-sonnet-20250929", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `contextManagement` | [models.ContextManagement](/client-sdks/typescript/api-reference/models/contextmanagement) | :heavy_minus_sign: | N/A | | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | | -| `messages` | [models.MessagesMessageParam](/client-sdks/typescript/api-reference/models/messagesmessageparam)[] | :heavy_check_mark: | N/A | | -| `metadata` | [models.Metadata](/client-sdks/typescript/api-reference/models/metadata) | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `models` | *string*[] | :heavy_minus_sign: | N/A | | -| `outputConfig` | [models.MessagesOutputConfig](/client-sdks/typescript/api-reference/models/messagesoutputconfig) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | `{"effort": "medium"}` | -| `plugins` | *models.MessagesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/api-reference/models/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` | [models.Speed](/client-sdks/typescript/api-reference/models/speed) | :heavy_minus_sign: | N/A | fast | -| `stopSequences` | *string*[] | :heavy_minus_sign: | N/A | | -| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `system` | *models.System* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `thinking` | *models.Thinking* | :heavy_minus_sign: | N/A | | -| `toolChoice` | *models.ToolChoice* | :heavy_minus_sign: | N/A | | -| `tools` | *models.MessagesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | -| `topK` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/messagesrequestplugin.mdx b/client-sdks/typescript/api-reference/models/messagesrequestplugin.mdx deleted file mode 100644 index bd7b5772..00000000 --- a/client-sdks/typescript/api-reference/models/messagesrequestplugin.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: MessagesRequestPlugin - TypeScript SDK -sidebarTitle: MessagesRequestPlugin -description: MessagesRequestPlugin type definition -seoTitle: MessagesRequestPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesRequestPlugin type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestPlugin%20-%20TypeScript%20SDK&description=MessagesRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AutoRouterPlugin` - -```typescript lines -const value: models.AutoRouterPlugin = { - id: "auto-router", -}; -``` - -### `models.ContextCompressionPlugin` - -```typescript lines -const value: models.ContextCompressionPlugin = { - id: "context-compression", -}; -``` - -### `models.FileParserPlugin` - -```typescript lines -const value: models.FileParserPlugin = { - id: "file-parser", -}; -``` - -### `models.FusionPlugin` - -```typescript lines -const value: models.FusionPlugin = { - id: "fusion", -}; -``` - -### `models.ModerationPlugin` - -```typescript lines -const value: models.ModerationPlugin = { - id: "moderation", -}; -``` - -### `models.ParetoRouterPlugin` - -```typescript lines -const value: models.ParetoRouterPlugin = { - id: "pareto-router", -}; -``` - -### `models.ResponseHealingPlugin` - -```typescript lines -const value: models.ResponseHealingPlugin = { - id: "response-healing", -}; -``` - -### `models.WebSearchPlugin` - -```typescript lines -const value: models.WebSearchPlugin = { - id: "web", -}; -``` - -### `models.WebFetchPlugin` - -```typescript lines -const value: models.WebFetchPlugin = { - id: "web-fetch", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesrequesttool.mdx b/client-sdks/typescript/api-reference/models/messagesrequesttool.mdx deleted file mode 100644 index 3cc44aac..00000000 --- a/client-sdks/typescript/api-reference/models/messagesrequesttool.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MessagesRequestTool - TypeScript SDK -sidebarTitle: MessagesRequestTool -description: MessagesRequestTool type definition -seoTitle: MessagesRequestTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesrequesttool -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestTool Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesRequestTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestTool%20-%20TypeScript%20SDK&description=MessagesRequestTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MessagesRequestTool } from "@openrouter/sdk/models"; - -let value: MessagesRequestTool = { - type: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/messagesrequesttoolunion.mdx b/client-sdks/typescript/api-reference/models/messagesrequesttoolunion.mdx deleted file mode 100644 index bcbee569..00000000 --- a/client-sdks/typescript/api-reference/models/messagesrequesttoolunion.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: MessagesRequestToolUnion - TypeScript SDK -sidebarTitle: MessagesRequestToolUnion -description: MessagesRequestToolUnion type definition -seoTitle: MessagesRequestToolUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/messagesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': MessagesRequestToolUnion Type | OpenRouter TypeScript SDK -'og:description': >- - MessagesRequestToolUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessagesRequestToolUnion%20-%20TypeScript%20SDK&description=MessagesRequestToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ToolCustom` - -```typescript lines -const value: models.ToolCustom = { - inputSchema: {}, - name: "", -}; -``` - -### `models.ToolBash20250124` - -```typescript lines -const value: models.ToolBash20250124 = { - name: "bash", - type: "bash_20250124", -}; -``` - -### `models.ToolTextEditor20250124` - -```typescript lines -const value: models.ToolTextEditor20250124 = { - name: "str_replace_editor", - type: "text_editor_20250124", -}; -``` - -### `models.ToolWebSearch20250305` - -```typescript lines -const value: models.ToolWebSearch20250305 = { - name: "web_search", - type: "web_search_20250305", -}; -``` - -### `models.ToolWebSearch20260209` - -```typescript lines -const value: models.ToolWebSearch20260209 = { - name: "web_search", - type: "web_search_20260209", -}; -``` - -### `models.ToolAdvisor20260301` - -```typescript lines -const value: models.ToolAdvisor20260301 = { - model: "Fortwo", - name: "advisor", - type: "advisor_20260301", -}; -``` - -### `models.DatetimeServerTool` - -```typescript lines -const value: models.DatetimeServerTool = { - type: "openrouter:datetime", -}; -``` - -### `models.ImageGenerationServerToolOpenRouter` - -```typescript lines -const value: models.ImageGenerationServerToolOpenRouter = { - type: "openrouter:image_generation", -}; -``` - -### `models.ChatSearchModelsServerTool` - -```typescript lines -const value: models.ChatSearchModelsServerTool = { - type: "openrouter:experimental__search_models", -}; -``` - -### `models.WebFetchServerTool` - -```typescript lines -const value: models.WebFetchServerTool = { - type: "openrouter:web_fetch", -}; -``` - -### `models.OpenRouterWebSearchServerTool` - -```typescript lines -const value: models.OpenRouterWebSearchServerTool = { - type: "openrouter:web_search", -}; -``` - -### `models.MessagesRequestTool` - -```typescript lines -const value: models.MessagesRequestTool = { - type: "", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/metadata.mdx b/client-sdks/typescript/api-reference/models/metadata.mdx deleted file mode 100644 index 79ab9913..00000000 --- a/client-sdks/typescript/api-reference/models/metadata.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Metadata - TypeScript SDK -sidebarTitle: Metadata -description: Metadata type definition -seoTitle: Metadata Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/metadata' -'og:site_name': OpenRouter Documentation -'og:title': Metadata Type | OpenRouter TypeScript SDK -'og:description': >- - Metadata type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Metadata%20-%20TypeScript%20SDK&description=Metadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Metadata } from "@openrouter/sdk/models"; - -let value: Metadata = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `userId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/metadatalevel.mdx b/client-sdks/typescript/api-reference/models/metadatalevel.mdx deleted file mode 100644 index d29d35b1..00000000 --- a/client-sdks/typescript/api-reference/models/metadatalevel.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MetadataLevel - TypeScript SDK -sidebarTitle: MetadataLevel -description: MetadataLevel type definition -seoTitle: MetadataLevel Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/metadatalevel' -'og:site_name': OpenRouter Documentation -'og:title': MetadataLevel Type | OpenRouter TypeScript SDK -'og:description': >- - MetadataLevel type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MetadataLevel%20-%20TypeScript%20SDK&description=MetadataLevel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Opt-in level for surfacing routing metadata on the response under `openrouter_metadata`. - -## Example Usage - -```typescript lines -import { MetadataLevel } from "@openrouter/sdk/models"; - -let value: MetadataLevel = "enabled"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"disabled" | "enabled" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/method.mdx b/client-sdks/typescript/api-reference/models/method.mdx deleted file mode 100644 index 3ff610f8..00000000 --- a/client-sdks/typescript/api-reference/models/method.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Method - TypeScript SDK -sidebarTitle: Method -description: Method type definition -seoTitle: Method Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/method' -'og:site_name': OpenRouter Documentation -'og:title': Method Type | OpenRouter TypeScript SDK -'og:description': >- - Method type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Method%20-%20TypeScript%20SDK&description=Method%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Method } from "@openrouter/sdk/models"; - -let value: Method = "POST"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"POST" | "PUT" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modality.mdx b/client-sdks/typescript/api-reference/models/modality.mdx deleted file mode 100644 index 224e811e..00000000 --- a/client-sdks/typescript/api-reference/models/modality.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Modality - TypeScript SDK -sidebarTitle: Modality -description: Modality type definition -seoTitle: Modality Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modality' -'og:site_name': OpenRouter Documentation -'og:title': Modality Type | OpenRouter TypeScript SDK -'og:description': >- - Modality type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Modality%20-%20TypeScript%20SDK&description=Modality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Modality } from "@openrouter/sdk/models"; - -let value: Modality = "audio"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"text" | "image" | "audio" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/mode.mdx b/client-sdks/typescript/api-reference/models/mode.mdx deleted file mode 100644 index 1c5c218c..00000000 --- a/client-sdks/typescript/api-reference/models/mode.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Mode - TypeScript SDK -sidebarTitle: Mode -description: Mode type definition -seoTitle: Mode Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/mode' -'og:site_name': OpenRouter Documentation -'og:title': Mode Type | OpenRouter TypeScript SDK -'og:description': >- - Mode type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Mode%20-%20TypeScript%20SDK&description=Mode%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ModeAuto` - -```typescript lines -const value: models.ModeAuto = "auto"; -``` - -### `models.ModeRequired` - -```typescript lines -const value: models.ModeRequired = "required"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modeauto.mdx b/client-sdks/typescript/api-reference/models/modeauto.mdx deleted file mode 100644 index 7d6153b6..00000000 --- a/client-sdks/typescript/api-reference/models/modeauto.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ModeAuto - TypeScript SDK -sidebarTitle: ModeAuto -description: ModeAuto type definition -seoTitle: ModeAuto Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modeauto' -'og:site_name': OpenRouter Documentation -'og:title': ModeAuto Type | OpenRouter TypeScript SDK -'og:description': >- - ModeAuto type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeAuto%20-%20TypeScript%20SDK&description=ModeAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ModeAuto } from "@openrouter/sdk/models"; - -let value: ModeAuto = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/model.mdx b/client-sdks/typescript/api-reference/models/model.mdx deleted file mode 100644 index 5ec7c27c..00000000 --- a/client-sdks/typescript/api-reference/models/model.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Model - TypeScript SDK -sidebarTitle: Model -description: Model type definition -seoTitle: Model Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/model' -'og:site_name': OpenRouter Documentation -'og:title': Model Type | OpenRouter TypeScript SDK -'og:description': >- - Model type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Model%20-%20TypeScript%20SDK&description=Model%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about an AI model available on OpenRouter - -## Example Usage - -```typescript expandable lines -import { Model } from "@openrouter/sdk/models"; - -let value: Model = { - architecture: { - inputModalities: [ - "text", - ], - modality: "text->text", - outputModalities: [ - "text", - ], - }, - canonicalSlug: "openai/gpt-4", - contextLength: 8192, - created: 1692901234, - defaultParameters: null, - id: "openai/gpt-4", - links: { - details: "/api/v1/models/openai/gpt-5.4/endpoints", - }, - name: "GPT-4", - perRequestLimits: null, - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - supportedVoices: null, - topProvider: { - isModerated: true, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.ModelArchitecture](/client-sdks/typescript/api-reference/models/modelarchitecture) | :heavy_check_mark: | Model architecture information | `{"input_modalities": ["text"],"instruct_type": "chatml","modality": "text-\u003etext","output_modalities": ["text"],"tokenizer": "GPT"}` | -| `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `contextLength` | *number* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `defaultParameters` | [models.DefaultParameters](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | -| `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `knowledgeCutoff` | *string* | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | -| `links` | [models.ModelLinks](/client-sdks/typescript/api-reference/models/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` | [models.PerRequestLimits](/client-sdks/typescript/api-reference/models/perrequestlimits) | :heavy_check_mark: | Per-request token limits | `{"completion_tokens": 1000,"prompt_tokens": 1000}` | -| `pricing` | [models.PublicPricing](/client-sdks/typescript/api-reference/models/publicpricing) | :heavy_check_mark: | Pricing information for the model | `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}` | -| `supportedParameters` | [models.Parameter](/client-sdks/typescript/api-reference/models/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. | `` | -| `topProvider` | [models.TopProviderInfo](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/modelarchitecture.mdx b/client-sdks/typescript/api-reference/models/modelarchitecture.mdx deleted file mode 100644 index 4661934d..00000000 --- a/client-sdks/typescript/api-reference/models/modelarchitecture.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ModelArchitecture - TypeScript SDK -sidebarTitle: ModelArchitecture -description: ModelArchitecture type definition -seoTitle: ModelArchitecture Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/modelarchitecture -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitecture Type | OpenRouter TypeScript SDK -'og:description': >- - ModelArchitecture type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitecture%20-%20TypeScript%20SDK&description=ModelArchitecture%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Example Usage - -```typescript lines -import { ModelArchitecture } from "@openrouter/sdk/models"; - -let value: ModelArchitecture = { - inputModalities: [ - "text", - ], - modality: "text->text", - outputModalities: [ - "text", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `inputModalities` | [models.InputModality](/client-sdks/typescript/api-reference/models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.ModelArchitectureInstructType](/client-sdks/typescript/api-reference/models/modelarchitectureinstructtype) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text->text | -| `outputModalities` | [models.OutputModality](/client-sdks/typescript/api-reference/models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.ModelGroup](/client-sdks/typescript/api-reference/models/modelgroup) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelarchitectureinstructtype.mdx b/client-sdks/typescript/api-reference/models/modelarchitectureinstructtype.mdx deleted file mode 100644 index db1a8489..00000000 --- a/client-sdks/typescript/api-reference/models/modelarchitectureinstructtype.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ModelArchitectureInstructType - TypeScript SDK -sidebarTitle: ModelArchitectureInstructType -description: ModelArchitectureInstructType type definition -seoTitle: ModelArchitectureInstructType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/modelarchitectureinstructtype -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitectureInstructType Type | OpenRouter TypeScript SDK -'og:description': >- - ModelArchitectureInstructType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitectureInstructType%20-%20TypeScript%20SDK&description=ModelArchitectureInstructType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```typescript lines -import { ModelArchitectureInstructType } from "@openrouter/sdk/models"; - -let value: ModelArchitectureInstructType = "chatml"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"none" | "airoboros" | "alpaca" | "alpaca-modif" | "chatml" | "claude" | "code-llama" | "gemma" | "llama2" | "llama3" | "mistral" | "nemotron" | "neural" | "openchat" | "phi3" | "rwkv" | "vicuna" | "zephyr" | "deepseek-r1" | "deepseek-v3.1" | "qwq" | "qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelenum.mdx b/client-sdks/typescript/api-reference/models/modelenum.mdx deleted file mode 100644 index de8c0e3b..00000000 --- a/client-sdks/typescript/api-reference/models/modelenum.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ModelEnum - TypeScript SDK -sidebarTitle: ModelEnum -description: ModelEnum type definition -seoTitle: ModelEnum Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modelenum' -'og:site_name': OpenRouter Documentation -'og:title': ModelEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ModelEnum type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelEnum%20-%20TypeScript%20SDK&description=ModelEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ModelEnum } from "@openrouter/sdk/models"; - -let value: ModelEnum = "gpt-image-1-mini"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"gpt-image-1" | "gpt-image-1-mini" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelgroup.mdx b/client-sdks/typescript/api-reference/models/modelgroup.mdx deleted file mode 100644 index 278870a0..00000000 --- a/client-sdks/typescript/api-reference/models/modelgroup.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ModelGroup - TypeScript SDK -sidebarTitle: ModelGroup -description: ModelGroup type definition -seoTitle: ModelGroup Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modelgroup' -'og:site_name': OpenRouter Documentation -'og:title': ModelGroup Type | OpenRouter TypeScript SDK -'og:description': >- - ModelGroup type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelGroup%20-%20TypeScript%20SDK&description=ModelGroup%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```typescript lines -import { ModelGroup } from "@openrouter/sdk/models"; - -let value: ModelGroup = "GPT"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"Router" | "Media" | "Other" | "GPT" | "Claude" | "Gemini" | "Gemma" | "Grok" | "Cohere" | "Nova" | "Qwen" | "Yi" | "DeepSeek" | "Mistral" | "Llama2" | "Llama3" | "Llama4" | "PaLM" | "RWKV" | "Qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modellinks.mdx b/client-sdks/typescript/api-reference/models/modellinks.mdx deleted file mode 100644 index dd89b3af..00000000 --- a/client-sdks/typescript/api-reference/models/modellinks.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ModelLinks - TypeScript SDK -sidebarTitle: ModelLinks -description: ModelLinks type definition -seoTitle: ModelLinks Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modellinks' -'og:site_name': OpenRouter Documentation -'og:title': ModelLinks Type | OpenRouter TypeScript SDK -'og:description': >- - ModelLinks type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelLinks%20-%20TypeScript%20SDK&description=ModelLinks%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Related API endpoints and resources for this model. - -## Example Usage - -```typescript lines -import { ModelLinks } from "@openrouter/sdk/models"; - -let value: ModelLinks = { - details: "/api/v1/models/openai/gpt-5.4/endpoints", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `details` | *string* | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelscountresponse.mdx b/client-sdks/typescript/api-reference/models/modelscountresponse.mdx deleted file mode 100644 index 388bce0b..00000000 --- a/client-sdks/typescript/api-reference/models/modelscountresponse.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ModelsCountResponse - TypeScript SDK -sidebarTitle: ModelsCountResponse -description: ModelsCountResponse type definition -seoTitle: ModelsCountResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/modelscountresponse -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ModelsCountResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponse%20-%20TypeScript%20SDK&description=ModelsCountResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model count data - -## Example Usage - -```typescript lines -import { ModelsCountResponse } from "@openrouter/sdk/models"; - -let value: ModelsCountResponse = { - data: { - count: 150, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.ModelsCountResponseData](/client-sdks/typescript/api-reference/models/modelscountresponsedata) | :heavy_check_mark: | Model count data | `{"count": 150}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelscountresponsedata.mdx b/client-sdks/typescript/api-reference/models/modelscountresponsedata.mdx deleted file mode 100644 index de48e04b..00000000 --- a/client-sdks/typescript/api-reference/models/modelscountresponsedata.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ModelsCountResponseData - TypeScript SDK -sidebarTitle: ModelsCountResponseData -description: ModelsCountResponseData type definition -seoTitle: ModelsCountResponseData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/modelscountresponsedata -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponseData Type | OpenRouter TypeScript SDK -'og:description': >- - ModelsCountResponseData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponseData%20-%20TypeScript%20SDK&description=ModelsCountResponseData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model count data - -## Example Usage - -```typescript lines -import { ModelsCountResponseData } from "@openrouter/sdk/models"; - -let value: ModelsCountResponseData = { - count: 150, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *number* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/modelslistresponse.mdx b/client-sdks/typescript/api-reference/models/modelslistresponse.mdx deleted file mode 100644 index c16432ea..00000000 --- a/client-sdks/typescript/api-reference/models/modelslistresponse.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: ModelsListResponse - TypeScript SDK -sidebarTitle: ModelsListResponse -description: ModelsListResponse type definition -seoTitle: ModelsListResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/modelslistresponse -'og:site_name': OpenRouter Documentation -'og:title': ModelsListResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ModelsListResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsListResponse%20-%20TypeScript%20SDK&description=ModelsListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of available models - -## Example Usage - -```typescript expandable lines -import { ModelsListResponse } from "@openrouter/sdk/models"; - -let value: ModelsListResponse = { - data: [ - { - architecture: { - inputModalities: [ - "text", - ], - modality: "text->text", - outputModalities: [ - "text", - ], - }, - canonicalSlug: "openai/gpt-4", - contextLength: 8192, - created: 1692901234, - defaultParameters: null, - id: "openai/gpt-4", - links: { - details: "/api/v1/models/openai/gpt-5.4/endpoints", - }, - name: "GPT-4", - perRequestLimits: null, - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - "frequency_penalty", - "presence_penalty", - ], - supportedVoices: null, - topProvider: { - isModerated: true, - }, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.Model](/client-sdks/typescript/api-reference/models/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-5.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}`
\}
] | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/moderation.mdx b/client-sdks/typescript/api-reference/models/moderation.mdx deleted file mode 100644 index 66fdb34a..00000000 --- a/client-sdks/typescript/api-reference/models/moderation.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Moderation - TypeScript SDK -sidebarTitle: Moderation -description: Moderation type definition -seoTitle: Moderation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/moderation' -'og:site_name': OpenRouter Documentation -'og:title': Moderation Type | OpenRouter TypeScript SDK -'og:description': >- - Moderation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Moderation%20-%20TypeScript%20SDK&description=Moderation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Moderation } from "@openrouter/sdk/models"; - -let value: Moderation = "low"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "low" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/moderationplugin.mdx b/client-sdks/typescript/api-reference/models/moderationplugin.mdx deleted file mode 100644 index 123c29ef..00000000 --- a/client-sdks/typescript/api-reference/models/moderationplugin.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ModerationPlugin - TypeScript SDK -sidebarTitle: ModerationPlugin -description: ModerationPlugin type definition -seoTitle: ModerationPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/moderationplugin -'og:site_name': OpenRouter Documentation -'og:title': ModerationPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ModerationPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModerationPlugin%20-%20TypeScript%20SDK&description=ModerationPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ModerationPlugin } from "@openrouter/sdk/models"; - -let value: ModerationPlugin = { - id: "moderation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *"moderation"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/moderequired.mdx b/client-sdks/typescript/api-reference/models/moderequired.mdx deleted file mode 100644 index 32307209..00000000 --- a/client-sdks/typescript/api-reference/models/moderequired.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ModeRequired - TypeScript SDK -sidebarTitle: ModeRequired -description: ModeRequired type definition -seoTitle: ModeRequired Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/moderequired' -'og:site_name': OpenRouter Documentation -'og:title': ModeRequired Type | OpenRouter TypeScript SDK -'og:description': >- - ModeRequired type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModeRequired%20-%20TypeScript%20SDK&description=ModeRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ModeRequired } from "@openrouter/sdk/models"; - -let value: ModeRequired = "required"; -``` - -## Values - -```typescript lines -"required" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/multimodalmedia.mdx b/client-sdks/typescript/api-reference/models/multimodalmedia.mdx deleted file mode 100644 index 7249ba4f..00000000 --- a/client-sdks/typescript/api-reference/models/multimodalmedia.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MultimodalMedia - TypeScript SDK -sidebarTitle: MultimodalMedia -description: MultimodalMedia type definition -seoTitle: MultimodalMedia Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/multimodalmedia -'og:site_name': OpenRouter Documentation -'og:title': MultimodalMedia Type | OpenRouter TypeScript SDK -'og:description': >- - MultimodalMedia type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MultimodalMedia%20-%20TypeScript%20SDK&description=MultimodalMedia%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MultimodalMedia } from "@openrouter/sdk/models"; - -let value: MultimodalMedia = { - data: "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/nameadvisor.mdx b/client-sdks/typescript/api-reference/models/nameadvisor.mdx deleted file mode 100644 index af9d76c2..00000000 --- a/client-sdks/typescript/api-reference/models/nameadvisor.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: NameAdvisor - TypeScript SDK -sidebarTitle: NameAdvisor -description: NameAdvisor type definition -seoTitle: NameAdvisor Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/nameadvisor' -'og:site_name': OpenRouter Documentation -'og:title': NameAdvisor Type | OpenRouter TypeScript SDK -'og:description': >- - NameAdvisor type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameAdvisor%20-%20TypeScript%20SDK&description=NameAdvisor%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NameAdvisor } from "@openrouter/sdk/models"; - -let value: NameAdvisor = "advisor"; -``` - -## Values - -```typescript lines -"advisor" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/namebash.mdx b/client-sdks/typescript/api-reference/models/namebash.mdx deleted file mode 100644 index 26f745f5..00000000 --- a/client-sdks/typescript/api-reference/models/namebash.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: NameBash - TypeScript SDK -sidebarTitle: NameBash -description: NameBash type definition -seoTitle: NameBash Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/namebash' -'og:site_name': OpenRouter Documentation -'og:title': NameBash Type | OpenRouter TypeScript SDK -'og:description': >- - NameBash type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameBash%20-%20TypeScript%20SDK&description=NameBash%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NameBash } from "@openrouter/sdk/models"; - -let value: NameBash = "bash"; -``` - -## Values - -```typescript lines -"bash" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/namestrreplaceeditor.mdx b/client-sdks/typescript/api-reference/models/namestrreplaceeditor.mdx deleted file mode 100644 index 05ea3ffb..00000000 --- a/client-sdks/typescript/api-reference/models/namestrreplaceeditor.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: NameStrReplaceEditor - TypeScript SDK -sidebarTitle: NameStrReplaceEditor -description: NameStrReplaceEditor type definition -seoTitle: NameStrReplaceEditor Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/namestrreplaceeditor -'og:site_name': OpenRouter Documentation -'og:title': NameStrReplaceEditor Type | OpenRouter TypeScript SDK -'og:description': >- - NameStrReplaceEditor type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameStrReplaceEditor%20-%20TypeScript%20SDK&description=NameStrReplaceEditor%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NameStrReplaceEditor } from "@openrouter/sdk/models"; - -let value: NameStrReplaceEditor = "str_replace_editor"; -``` - -## Values - -```typescript lines -"str_replace_editor" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/namewebsearch1.mdx b/client-sdks/typescript/api-reference/models/namewebsearch1.mdx deleted file mode 100644 index ab01eb42..00000000 --- a/client-sdks/typescript/api-reference/models/namewebsearch1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: NameWebSearch1 - TypeScript SDK -sidebarTitle: NameWebSearch1 -description: NameWebSearch1 type definition -seoTitle: NameWebSearch1 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/namewebsearch1' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch1 Type | OpenRouter TypeScript SDK -'og:description': >- - NameWebSearch1 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch1%20-%20TypeScript%20SDK&description=NameWebSearch1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NameWebSearch1 } from "@openrouter/sdk/models"; - -let value: NameWebSearch1 = "web_search"; -``` - -## Values - -```typescript lines -"web_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/namewebsearch2.mdx b/client-sdks/typescript/api-reference/models/namewebsearch2.mdx deleted file mode 100644 index a60ecdab..00000000 --- a/client-sdks/typescript/api-reference/models/namewebsearch2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: NameWebSearch2 - TypeScript SDK -sidebarTitle: NameWebSearch2 -description: NameWebSearch2 type definition -seoTitle: NameWebSearch2 Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/namewebsearch2' -'og:site_name': OpenRouter Documentation -'og:title': NameWebSearch2 Type | OpenRouter TypeScript SDK -'og:description': >- - NameWebSearch2 type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NameWebSearch2%20-%20TypeScript%20SDK&description=NameWebSearch2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NameWebSearch2 } from "@openrouter/sdk/models"; - -let value: NameWebSearch2 = "web_search"; -``` - -## Values - -```typescript lines -"web_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/never.mdx b/client-sdks/typescript/api-reference/models/never.mdx deleted file mode 100644 index 9ef7e192..00000000 --- a/client-sdks/typescript/api-reference/models/never.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Never - TypeScript SDK -sidebarTitle: Never -description: Never type definition -seoTitle: Never Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/never' -'og:site_name': OpenRouter Documentation -'og:title': Never Type | OpenRouter TypeScript SDK -'og:description': >- - Never type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Never%20-%20TypeScript%20SDK&description=Never%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Never } from "@openrouter/sdk/models"; - -let value: Never = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/notfoundresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/notfoundresponseerrordata.mdx deleted file mode 100644 index 281f8fa5..00000000 --- a/client-sdks/typescript/api-reference/models/notfoundresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: NotFoundResponseErrorData - TypeScript SDK -sidebarTitle: NotFoundResponseErrorData -description: NotFoundResponseErrorData type definition -seoTitle: NotFoundResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/notfoundresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - NotFoundResponseErrorData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseErrorData%20-%20TypeScript%20SDK&description=NotFoundResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for NotFoundResponse - -## Example Usage - -```typescript lines -import { NotFoundResponseErrorData } from "@openrouter/sdk/models"; - -let value: NotFoundResponseErrorData = { - code: 404, - message: "Resource not found", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityarizedestination.mdx b/client-sdks/typescript/api-reference/models/observabilityarizedestination.mdx deleted file mode 100644 index 02839b05..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityarizedestination.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: ObservabilityArizeDestination - TypeScript SDK -sidebarTitle: ObservabilityArizeDestination -description: ObservabilityArizeDestination type definition -seoTitle: ObservabilityArizeDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityarizedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityArizeDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestination%20-%20TypeScript%20SDK&description=ObservabilityArizeDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ObservabilityArizeDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityArizeDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - modelId: "", - spaceKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "arize", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityArizeDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"arize"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityarizedestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityarizedestinationconfig.mdx deleted file mode 100644 index ec8b0cba..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityarizedestinationconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ObservabilityArizeDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityArizeDestinationConfig -description: ObservabilityArizeDestinationConfig type definition -seoTitle: ObservabilityArizeDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityarizedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityArizeDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityArizeDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityArizeDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityArizeDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityArizeDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityArizeDestinationConfig = { - apiKey: "", - modelId: "", - spaceKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `modelId` | *string* | :heavy_check_mark: | N/A | -| `spaceKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitybraintrustdestination.mdx b/client-sdks/typescript/api-reference/models/observabilitybraintrustdestination.mdx deleted file mode 100644 index b1444af0..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitybraintrustdestination.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ObservabilityBraintrustDestination - TypeScript SDK -sidebarTitle: ObservabilityBraintrustDestination -description: ObservabilityBraintrustDestination type definition -seoTitle: ObservabilityBraintrustDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitybraintrustdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityBraintrustDestination type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestination%20-%20TypeScript%20SDK&description=ObservabilityBraintrustDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityBraintrustDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityBraintrustDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - projectId: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "braintrust", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityBraintrustDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"braintrust"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitybraintrustdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitybraintrustdestinationconfig.mdx deleted file mode 100644 index f0d21521..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitybraintrustdestinationconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ObservabilityBraintrustDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityBraintrustDestinationConfig -description: ObservabilityBraintrustDestinationConfig type definition -seoTitle: ObservabilityBraintrustDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitybraintrustdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityBraintrustDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityBraintrustDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityBraintrustDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityBraintrustDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityBraintrustDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityBraintrustDestinationConfig = { - apiKey: "", - projectId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `projectId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityclickhousedestination.mdx b/client-sdks/typescript/api-reference/models/observabilityclickhousedestination.mdx deleted file mode 100644 index 81abd174..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityclickhousedestination.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: ObservabilityClickhouseDestination - TypeScript SDK -sidebarTitle: ObservabilityClickhouseDestination -description: ObservabilityClickhouseDestination type definition -seoTitle: ObservabilityClickhouseDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityclickhousedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityClickhouseDestination type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestination%20-%20TypeScript%20SDK&description=ObservabilityClickhouseDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ObservabilityClickhouseDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityClickhouseDestination = { - apiKeyHashes: null, - config: { - database: "", - host: "major-daddy.org", - password: "aG_VYsEwW_TOcCy", - username: "Kara74", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "clickhouse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityClickhouseDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"clickhouse"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityclickhousedestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityclickhousedestinationconfig.mdx deleted file mode 100644 index 91910c90..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityclickhousedestinationconfig.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ObservabilityClickhouseDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityClickhouseDestinationConfig -description: ObservabilityClickhouseDestinationConfig type definition -seoTitle: ObservabilityClickhouseDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityclickhousedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityClickhouseDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityClickhouseDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityClickhouseDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityClickhouseDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityClickhouseDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityClickhouseDestinationConfig = { - database: "", - host: "evil-airbus.net", - password: "cQ0oWoWiZp9fa9C", - username: "Hyman.Stroman", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `database` | *string* | :heavy_check_mark: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `host` | *string* | :heavy_check_mark: | N/A | -| `password` | *string* | :heavy_check_mark: | N/A | -| `table` | *string* | :heavy_minus_sign: | N/A | -| `username` | *string* | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitydatadogdestination.mdx b/client-sdks/typescript/api-reference/models/observabilitydatadogdestination.mdx deleted file mode 100644 index 3335f76c..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitydatadogdestination.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ObservabilityDatadogDestination - TypeScript SDK -sidebarTitle: ObservabilityDatadogDestination -description: ObservabilityDatadogDestination type definition -seoTitle: ObservabilityDatadogDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitydatadogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityDatadogDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestination%20-%20TypeScript%20SDK&description=ObservabilityDatadogDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityDatadogDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityDatadogDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - mlApp: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "datadog", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityDatadogDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"datadog"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitydatadogdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitydatadogdestinationconfig.mdx deleted file mode 100644 index b70b9b22..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitydatadogdestinationconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ObservabilityDatadogDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityDatadogDestinationConfig -description: ObservabilityDatadogDestinationConfig type definition -seoTitle: ObservabilityDatadogDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitydatadogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDatadogDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityDatadogDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDatadogDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityDatadogDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityDatadogDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityDatadogDestinationConfig = { - apiKey: "", - mlApp: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `mlApp` | *string* | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `url` | *string* | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitydestination.mdx b/client-sdks/typescript/api-reference/models/observabilitydestination.mdx deleted file mode 100644 index 0e4af435..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitydestination.mdx +++ /dev/null @@ -1,409 +0,0 @@ ---- -title: ObservabilityDestination - TypeScript SDK -sidebarTitle: ObservabilityDestination -description: ObservabilityDestination type definition -seoTitle: ObservabilityDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityDestination type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityDestination%20-%20TypeScript%20SDK&description=ObservabilityDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ObservabilityArizeDestination` - -```typescript lines -const value: models.ObservabilityArizeDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - modelId: "", - spaceKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "arize", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityBraintrustDestination` - -```typescript lines -const value: models.ObservabilityBraintrustDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - projectId: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "braintrust", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityClickhouseDestination` - -```typescript lines -const value: models.ObservabilityClickhouseDestination = { - apiKeyHashes: null, - config: { - database: "", - host: "short-term-netsuke.name", - password: "2n5DRy2kH2HJZi1", - username: "Marley28", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "clickhouse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityDatadogDestination` - -```typescript lines -const value: models.ObservabilityDatadogDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - mlApp: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "datadog", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityGrafanaDestination` - -```typescript lines -const value: models.ObservabilityGrafanaDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - instanceId: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "grafana", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityLangfuseDestination` - -```typescript lines -const value: models.ObservabilityLangfuseDestination = { - apiKeyHashes: null, - config: { - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityLangsmithDestination` - -```typescript lines -const value: models.ObservabilityLangsmithDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langsmith", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityNewrelicDestination` - -```typescript lines -const value: models.ObservabilityNewrelicDestination = { - apiKeyHashes: null, - config: { - licenseKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "newrelic", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityOpikDestination` - -```typescript lines -const value: models.ObservabilityOpikDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - projectName: "", - workspace: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "opik", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityOtelCollectorDestination` - -```typescript lines -const value: models.ObservabilityOtelCollectorDestination = { - apiKeyHashes: null, - config: { - endpoint: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "otel-collector", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityPosthogDestination` - -```typescript lines -const value: models.ObservabilityPosthogDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "posthog", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityRampDestination` - -```typescript lines -const value: models.ObservabilityRampDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "ramp", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityS3Destination` - -```typescript lines -const value: models.ObservabilityS3Destination = { - apiKeyHashes: null, - config: { - accessKeyId: "", - bucketName: "", - secretAccessKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "s3", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilitySentryDestination` - -```typescript lines -const value: models.ObservabilitySentryDestination = { - apiKeyHashes: null, - config: { - dsn: "", - otlpEndpoint: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "sentry", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilitySnowflakeDestination` - -```typescript lines -const value: models.ObservabilitySnowflakeDestination = { - apiKeyHashes: null, - config: { - account: "74782436", - token: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "snowflake", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityWeaveDestination` - -```typescript lines -const value: models.ObservabilityWeaveDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - entity: "", - project: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "weave", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -### `models.ObservabilityWebhookDestination` - -```typescript lines -const value: models.ObservabilityWebhookDestination = { - apiKeyHashes: null, - config: { - url: "https://waterlogged-fork.com/", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "webhook", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig.mdx deleted file mode 100644 index 7e1fc4df..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ObservabilityFilterRulesConfig - TypeScript SDK -sidebarTitle: ObservabilityFilterRulesConfig -description: ObservabilityFilterRulesConfig type definition -seoTitle: ObservabilityFilterRulesConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityfilterrulesconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityFilterRulesConfig type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfig%20-%20TypeScript%20SDK&description=ObservabilityFilterRulesConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Optional structured filter rules controlling which events are forwarded. - -## Example Usage - -```typescript lines -import { ObservabilityFilterRulesConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityFilterRulesConfig = { - groups: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `groups` | [models.Group](/client-sdks/typescript/api-reference/models/group)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfigvalue.mdx b/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfigvalue.mdx deleted file mode 100644 index 5de19060..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfigvalue.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObservabilityFilterRulesConfigValue - TypeScript SDK -sidebarTitle: ObservabilityFilterRulesConfigValue -description: ObservabilityFilterRulesConfigValue type definition -seoTitle: ObservabilityFilterRulesConfigValue Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityfilterrulesconfigvalue -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityFilterRulesConfigValue Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityFilterRulesConfigValue type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityFilterRulesConfigValue%20-%20TypeScript%20SDK&description=ObservabilityFilterRulesConfigValue%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitygrafanadestination.mdx b/client-sdks/typescript/api-reference/models/observabilitygrafanadestination.mdx deleted file mode 100644 index 6d4909a2..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitygrafanadestination.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ObservabilityGrafanaDestination - TypeScript SDK -sidebarTitle: ObservabilityGrafanaDestination -description: ObservabilityGrafanaDestination type definition -seoTitle: ObservabilityGrafanaDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitygrafanadestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityGrafanaDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestination%20-%20TypeScript%20SDK&description=ObservabilityGrafanaDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityGrafanaDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityGrafanaDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - instanceId: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "grafana", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityGrafanaDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"grafana"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitygrafanadestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitygrafanadestinationconfig.mdx deleted file mode 100644 index 4c2f0abf..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitygrafanadestinationconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ObservabilityGrafanaDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityGrafanaDestinationConfig -description: ObservabilityGrafanaDestinationConfig type definition -seoTitle: ObservabilityGrafanaDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitygrafanadestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityGrafanaDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityGrafanaDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityGrafanaDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityGrafanaDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityGrafanaDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityGrafanaDestinationConfig = { - apiKey: "", - instanceId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `instanceId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitylangfusedestination.mdx b/client-sdks/typescript/api-reference/models/observabilitylangfusedestination.mdx deleted file mode 100644 index 297cfcd9..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitylangfusedestination.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ObservabilityLangfuseDestination - TypeScript SDK -sidebarTitle: ObservabilityLangfuseDestination -description: ObservabilityLangfuseDestination type definition -seoTitle: ObservabilityLangfuseDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitylangfusedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityLangfuseDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestination%20-%20TypeScript%20SDK&description=ObservabilityLangfuseDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityLangfuseDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityLangfuseDestination = { - apiKeyHashes: null, - config: { - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityLangfuseDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"langfuse"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitylangfusedestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitylangfusedestinationconfig.mdx deleted file mode 100644 index 10cda4f6..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitylangfusedestinationconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ObservabilityLangfuseDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityLangfuseDestinationConfig -description: ObservabilityLangfuseDestinationConfig type definition -seoTitle: ObservabilityLangfuseDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitylangfusedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangfuseDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityLangfuseDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangfuseDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityLangfuseDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityLangfuseDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityLangfuseDestinationConfig = { - publicKey: "", - secretKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `publicKey` | *string* | :heavy_check_mark: | N/A | -| `secretKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitylangsmithdestination.mdx b/client-sdks/typescript/api-reference/models/observabilitylangsmithdestination.mdx deleted file mode 100644 index 552f24fc..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitylangsmithdestination.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ObservabilityLangsmithDestination - TypeScript SDK -sidebarTitle: ObservabilityLangsmithDestination -description: ObservabilityLangsmithDestination type definition -seoTitle: ObservabilityLangsmithDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitylangsmithdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityLangsmithDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestination%20-%20TypeScript%20SDK&description=ObservabilityLangsmithDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityLangsmithDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityLangsmithDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langsmith", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityLangsmithDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"langsmith"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitylangsmithdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitylangsmithdestinationconfig.mdx deleted file mode 100644 index 102f1476..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitylangsmithdestinationconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ObservabilityLangsmithDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityLangsmithDestinationConfig -description: ObservabilityLangsmithDestinationConfig type definition -seoTitle: ObservabilityLangsmithDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitylangsmithdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityLangsmithDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityLangsmithDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityLangsmithDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityLangsmithDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityLangsmithDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityLangsmithDestinationConfig = { - apiKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *string* | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `workspaceId` | *string* | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitynewrelicdestination.mdx b/client-sdks/typescript/api-reference/models/observabilitynewrelicdestination.mdx deleted file mode 100644 index 079a08cb..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitynewrelicdestination.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ObservabilityNewrelicDestination - TypeScript SDK -sidebarTitle: ObservabilityNewrelicDestination -description: ObservabilityNewrelicDestination type definition -seoTitle: ObservabilityNewrelicDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitynewrelicdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityNewrelicDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestination%20-%20TypeScript%20SDK&description=ObservabilityNewrelicDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityNewrelicDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityNewrelicDestination = { - apiKeyHashes: null, - config: { - licenseKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "newrelic", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityNewrelicDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"newrelic"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitynewrelicdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitynewrelicdestinationconfig.mdx deleted file mode 100644 index 51acb0e3..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitynewrelicdestinationconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ObservabilityNewrelicDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityNewrelicDestinationConfig -description: ObservabilityNewrelicDestinationConfig type definition -seoTitle: ObservabilityNewrelicDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitynewrelicdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityNewrelicDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityNewrelicDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityNewrelicDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityNewrelicDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityNewrelicDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityNewrelicDestinationConfig = { - licenseKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `licenseKey` | *string* | :heavy_check_mark: | N/A | -| `region` | [models.Region](/client-sdks/typescript/api-reference/models/region) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityopikdestination.mdx b/client-sdks/typescript/api-reference/models/observabilityopikdestination.mdx deleted file mode 100644 index 87071a55..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityopikdestination.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ObservabilityOpikDestination - TypeScript SDK -sidebarTitle: ObservabilityOpikDestination -description: ObservabilityOpikDestination type definition -seoTitle: ObservabilityOpikDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityopikdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityOpikDestination type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestination%20-%20TypeScript%20SDK&description=ObservabilityOpikDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityOpikDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityOpikDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - projectName: "", - workspace: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "opik", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityOpikDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"opik"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityopikdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityopikdestinationconfig.mdx deleted file mode 100644 index e34d7314..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityopikdestinationconfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ObservabilityOpikDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityOpikDestinationConfig -description: ObservabilityOpikDestinationConfig type definition -seoTitle: ObservabilityOpikDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityopikdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOpikDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityOpikDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOpikDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityOpikDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityOpikDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityOpikDestinationConfig = { - apiKey: "", - projectName: "", - workspace: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `projectName` | *string* | :heavy_check_mark: | N/A | -| `workspace` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityotelcollectordestination.mdx b/client-sdks/typescript/api-reference/models/observabilityotelcollectordestination.mdx deleted file mode 100644 index ddfb11ee..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityotelcollectordestination.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestination - TypeScript SDK -sidebarTitle: ObservabilityOtelCollectorDestination -description: ObservabilityOtelCollectorDestination type definition -seoTitle: ObservabilityOtelCollectorDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityotelcollectordestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityOtelCollectorDestination type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestination%20-%20TypeScript%20SDK&description=ObservabilityOtelCollectorDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityOtelCollectorDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityOtelCollectorDestination = { - apiKeyHashes: null, - config: { - endpoint: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "otel-collector", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityOtelCollectorDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"otel-collector"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityotelcollectordestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityotelcollectordestinationconfig.mdx deleted file mode 100644 index fbeecf22..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityotelcollectordestinationconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ObservabilityOtelCollectorDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityOtelCollectorDestinationConfig -description: ObservabilityOtelCollectorDestinationConfig type definition -seoTitle: ObservabilityOtelCollectorDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityotelcollectordestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityOtelCollectorDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityOtelCollectorDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityOtelCollectorDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityOtelCollectorDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityOtelCollectorDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityOtelCollectorDestinationConfig = { - endpoint: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use `{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityposthogdestination.mdx b/client-sdks/typescript/api-reference/models/observabilityposthogdestination.mdx deleted file mode 100644 index fc97f142..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityposthogdestination.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ObservabilityPosthogDestination - TypeScript SDK -sidebarTitle: ObservabilityPosthogDestination -description: ObservabilityPosthogDestination type definition -seoTitle: ObservabilityPosthogDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityposthogdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityPosthogDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestination%20-%20TypeScript%20SDK&description=ObservabilityPosthogDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityPosthogDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityPosthogDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "posthog", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityPosthogDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"posthog"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityposthogdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityposthogdestinationconfig.mdx deleted file mode 100644 index b8f47f42..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityposthogdestinationconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ObservabilityPosthogDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityPosthogDestinationConfig -description: ObservabilityPosthogDestinationConfig type definition -seoTitle: ObservabilityPosthogDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityposthogdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityPosthogDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityPosthogDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityPosthogDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityPosthogDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityPosthogDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityPosthogDestinationConfig = { - apiKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityrampdestination.mdx b/client-sdks/typescript/api-reference/models/observabilityrampdestination.mdx deleted file mode 100644 index ed7115e5..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityrampdestination.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ObservabilityRampDestination - TypeScript SDK -sidebarTitle: ObservabilityRampDestination -description: ObservabilityRampDestination type definition -seoTitle: ObservabilityRampDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityrampdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityRampDestination type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestination%20-%20TypeScript%20SDK&description=ObservabilityRampDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityRampDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityRampDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "ramp", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityRampDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"ramp"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityrampdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityrampdestinationconfig.mdx deleted file mode 100644 index b33aa034..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityrampdestinationconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ObservabilityRampDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityRampDestinationConfig -description: ObservabilityRampDestinationConfig type definition -seoTitle: ObservabilityRampDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityrampdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityRampDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityRampDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityRampDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityRampDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityRampDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityRampDestinationConfig = { - apiKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitys3destination.mdx b/client-sdks/typescript/api-reference/models/observabilitys3destination.mdx deleted file mode 100644 index ba49b207..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitys3destination.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: ObservabilityS3Destination - TypeScript SDK -sidebarTitle: ObservabilityS3Destination -description: ObservabilityS3Destination type definition -seoTitle: ObservabilityS3Destination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitys3destination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3Destination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityS3Destination type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3Destination%20-%20TypeScript%20SDK&description=ObservabilityS3Destination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityS3Destination } from "@openrouter/sdk/models"; - -let value: ObservabilityS3Destination = { - apiKeyHashes: null, - config: { - accessKeyId: "", - bucketName: "", - secretAccessKey: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "s3", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityS3DestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"s3"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitys3destinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitys3destinationconfig.mdx deleted file mode 100644 index f1da828e..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitys3destinationconfig.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ObservabilityS3DestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityS3DestinationConfig -description: ObservabilityS3DestinationConfig type definition -seoTitle: ObservabilityS3DestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitys3destinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityS3DestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityS3DestinationConfig type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityS3DestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityS3DestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityS3DestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityS3DestinationConfig = { - accessKeyId: "", - bucketName: "", - secretAccessKey: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accessKeyId` | *string* | :heavy_check_mark: | N/A | -| `bucketName` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `pathTemplate` | *string* | :heavy_minus_sign: | Template for S3 object path. The filename (`{traceId}`-`{timestamp}`.json) is automatically appended. Available variables: `{prefix}`, `{date}`, `{year}`, `{month}`, `{day}`, `{apiKeyName}` | -| `prefix` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `secretAccessKey` | *string* | :heavy_check_mark: | N/A | -| `sessionToken` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitysentrydestination.mdx b/client-sdks/typescript/api-reference/models/observabilitysentrydestination.mdx deleted file mode 100644 index fa3db368..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitysentrydestination.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ObservabilitySentryDestination - TypeScript SDK -sidebarTitle: ObservabilitySentryDestination -description: ObservabilitySentryDestination type definition -seoTitle: ObservabilitySentryDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitysentrydestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilitySentryDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestination%20-%20TypeScript%20SDK&description=ObservabilitySentryDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilitySentryDestination } from "@openrouter/sdk/models"; - -let value: ObservabilitySentryDestination = { - apiKeyHashes: null, - config: { - dsn: "", - otlpEndpoint: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "sentry", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilitySentryDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"sentry"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitysentrydestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitysentrydestinationconfig.mdx deleted file mode 100644 index 3e7b1f51..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitysentrydestinationconfig.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ObservabilitySentryDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilitySentryDestinationConfig -description: ObservabilitySentryDestinationConfig type definition -seoTitle: ObservabilitySentryDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitysentrydestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySentryDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilitySentryDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySentryDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilitySentryDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilitySentryDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilitySentryDestinationConfig = { - dsn: "", - otlpEndpoint: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dsn` | *string* | :heavy_check_mark: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `otlpEndpoint` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitysnowflakedestination.mdx b/client-sdks/typescript/api-reference/models/observabilitysnowflakedestination.mdx deleted file mode 100644 index 7b9e9bfd..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitysnowflakedestination.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ObservabilitySnowflakeDestination - TypeScript SDK -sidebarTitle: ObservabilitySnowflakeDestination -description: ObservabilitySnowflakeDestination type definition -seoTitle: ObservabilitySnowflakeDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitysnowflakedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilitySnowflakeDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestination%20-%20TypeScript%20SDK&description=ObservabilitySnowflakeDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilitySnowflakeDestination } from "@openrouter/sdk/models"; - -let value: ObservabilitySnowflakeDestination = { - apiKeyHashes: null, - config: { - account: "73017229", - token: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "snowflake", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilitySnowflakeDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"snowflake"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitysnowflakedestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitysnowflakedestinationconfig.mdx deleted file mode 100644 index f548018f..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitysnowflakedestinationconfig.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ObservabilitySnowflakeDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilitySnowflakeDestinationConfig -description: ObservabilitySnowflakeDestinationConfig type definition -seoTitle: ObservabilitySnowflakeDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitysnowflakedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilitySnowflakeDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilitySnowflakeDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilitySnowflakeDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilitySnowflakeDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilitySnowflakeDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilitySnowflakeDestinationConfig = { - account: "93697714", - token: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `account` | *string* | :heavy_check_mark: | N/A | -| `database` | *string* | :heavy_minus_sign: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `schema` | *string* | :heavy_minus_sign: | N/A | -| `table` | *string* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `warehouse` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityweavedestination.mdx b/client-sdks/typescript/api-reference/models/observabilityweavedestination.mdx deleted file mode 100644 index 93974772..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityweavedestination.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: ObservabilityWeaveDestination - TypeScript SDK -sidebarTitle: ObservabilityWeaveDestination -description: ObservabilityWeaveDestination type definition -seoTitle: ObservabilityWeaveDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityweavedestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityWeaveDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestination%20-%20TypeScript%20SDK&description=ObservabilityWeaveDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ObservabilityWeaveDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityWeaveDestination = { - apiKeyHashes: null, - config: { - apiKey: "", - baseUrl: "https://us.cloud.langfuse.com", - entity: "", - project: "", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "weave", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityWeaveDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"weave"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilityweavedestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilityweavedestinationconfig.mdx deleted file mode 100644 index a78b2fe3..00000000 --- a/client-sdks/typescript/api-reference/models/observabilityweavedestinationconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ObservabilityWeaveDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityWeaveDestinationConfig -description: ObservabilityWeaveDestinationConfig type definition -seoTitle: ObservabilityWeaveDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilityweavedestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWeaveDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityWeaveDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWeaveDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityWeaveDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityWeaveDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityWeaveDestinationConfig = { - apiKey: "", - entity: "", - project: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `entity` | *string* | :heavy_check_mark: | N/A | -| `headers` | `Record` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitywebhookdestination.mdx b/client-sdks/typescript/api-reference/models/observabilitywebhookdestination.mdx deleted file mode 100644 index cbe02b11..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitywebhookdestination.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: ObservabilityWebhookDestination - TypeScript SDK -sidebarTitle: ObservabilityWebhookDestination -description: ObservabilityWebhookDestination type definition -seoTitle: ObservabilityWebhookDestination Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitywebhookdestination -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestination Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityWebhookDestination type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestination%20-%20TypeScript%20SDK&description=ObservabilityWebhookDestination%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityWebhookDestination } from "@openrouter/sdk/models"; - -let value: ObservabilityWebhookDestination = { - apiKeyHashes: null, - config: { - url: "https://scornful-disposer.org", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "webhook", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| 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. | `` | -| `config` | [models.ObservabilityWebhookDestinationConfig](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | `` | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"webhook"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/observabilitywebhookdestinationconfig.mdx b/client-sdks/typescript/api-reference/models/observabilitywebhookdestinationconfig.mdx deleted file mode 100644 index 0b730d03..00000000 --- a/client-sdks/typescript/api-reference/models/observabilitywebhookdestinationconfig.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ObservabilityWebhookDestinationConfig - TypeScript SDK -sidebarTitle: ObservabilityWebhookDestinationConfig -description: ObservabilityWebhookDestinationConfig type definition -seoTitle: ObservabilityWebhookDestinationConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/observabilitywebhookdestinationconfig -'og:site_name': OpenRouter Documentation -'og:title': ObservabilityWebhookDestinationConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ObservabilityWebhookDestinationConfig type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObservabilityWebhookDestinationConfig%20-%20TypeScript%20SDK&description=ObservabilityWebhookDestinationConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObservabilityWebhookDestinationConfig } from "@openrouter/sdk/models"; - -let value: ObservabilityWebhookDestinationConfig = { - url: "https://pink-nucleotidase.info/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `headers` | `Record` | :heavy_minus_sign: | N/A | -| `method` | [models.Method](/client-sdks/typescript/api-reference/models/method) | :heavy_minus_sign: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/only.mdx b/client-sdks/typescript/api-reference/models/only.mdx deleted file mode 100644 index a3f1052d..00000000 --- a/client-sdks/typescript/api-reference/models/only.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Only - TypeScript SDK -sidebarTitle: Only -description: Only type definition -seoTitle: Only Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/only' -'og:site_name': OpenRouter Documentation -'og:title': Only Type | OpenRouter TypeScript SDK -'og:description': >- - Only type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Only%20-%20TypeScript%20SDK&description=Only%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcall.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcall.mdx deleted file mode 100644 index 02d14c51..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcall.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAIResponseCustomToolCall - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCall -description: OpenAIResponseCustomToolCall type definition -seoTitle: OpenAIResponseCustomToolCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCall Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCall type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCall%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseCustomToolCall } from "@openrouter/sdk/models"; - -let value: OpenAIResponseCustomToolCall = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `input` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.OpenAIResponseCustomToolCallType](/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutput.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutput.mdx deleted file mode 100644 index 2cdd05b0..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutput.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutput - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCallOutput -description: OpenAIResponseCustomToolCallOutput type definition -seoTitle: OpenAIResponseCustomToolCallOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutput Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCallOutput type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutput%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseCustomToolCallOutput } from "@openrouter/sdk/models"; - -let value: OpenAIResponseCustomToolCallOutput = { - callId: "call-abc123", - output: "patch applied successfully", - type: "custom_tool_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *models.OpenAIResponseCustomToolCallOutputOutput2* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseCustomToolCallOutputType](/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx deleted file mode 100644 index 8a82e24f..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput1.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput1 - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput1 -description: OpenAIResponseCustomToolCallOutputOutput1 type definition -seoTitle: OpenAIResponseCustomToolCallOutputOutput1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput1 Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput1 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput1%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCallOutputOutput1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputImage` - -```typescript lines -const value: models.InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx deleted file mode 100644 index 72f24e10..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput2.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputOutput2 - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputOutput2 -description: OpenAIResponseCustomToolCallOutputOutput2 type definition -seoTitle: OpenAIResponseCustomToolCallOutputOutput2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputOutput2 Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputOutput2 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputOutput2%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCallOutputOutput2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.OpenAIResponseCustomToolCallOutputOutput1[]` - -```typescript lines -const value: models.OpenAIResponseCustomToolCallOutputOutput1[] = [ - { - type: "input_file", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx deleted file mode 100644 index e48bdfc2..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallOutputType - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCallOutputType -description: OpenAIResponseCustomToolCallOutputType type definition -seoTitle: OpenAIResponseCustomToolCallOutputType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallOutputType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCallOutputType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallOutputType%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCallOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseCustomToolCallOutputType } from "@openrouter/sdk/models"; - -let value: OpenAIResponseCustomToolCallOutputType = "custom_tool_call_output"; -``` - -## Values - -```typescript lines -"custom_tool_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalltype.mdx b/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalltype.mdx deleted file mode 100644 index 62f0449d..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsecustomtoolcalltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseCustomToolCallType - TypeScript SDK -sidebarTitle: OpenAIResponseCustomToolCallType -description: OpenAIResponseCustomToolCallType type definition -seoTitle: OpenAIResponseCustomToolCallType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsecustomtoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseCustomToolCallType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseCustomToolCallType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseCustomToolCallType%20-%20TypeScript%20SDK&description=OpenAIResponseCustomToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseCustomToolCallType } from "@openrouter/sdk/models"; - -let value: OpenAIResponseCustomToolCallType = "custom_tool_call"; -``` - -## Values - -```typescript lines -"custom_tool_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcall.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcall.mdx deleted file mode 100644 index e7541736..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcall.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCall - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCall -description: OpenAIResponseFunctionToolCall type definition -seoTitle: OpenAIResponseFunctionToolCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCall Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCall type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCall%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseFunctionToolCall } from "@openrouter/sdk/models"; - -let value: OpenAIResponseFunctionToolCall = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.OpenAIResponseFunctionToolCallType](/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutput.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutput.mdx deleted file mode 100644 index c44ee318..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutput.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutput - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutput -description: OpenAIResponseFunctionToolCallOutput type definition -seoTitle: OpenAIResponseFunctionToolCallOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutput Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutput type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutput%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseFunctionToolCallOutput } from "@openrouter/sdk/models"; - -let value: OpenAIResponseFunctionToolCallOutput = { - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", - type: "function_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `output` | *models.OpenAIResponseFunctionToolCallOutputOutput2* | :heavy_check_mark: | N/A | | -| `status` | [models.OpenAIResponseFunctionToolCallOutputStatus](/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.OpenAIResponseFunctionToolCallOutputType](/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx deleted file mode 100644 index faa16039..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput1.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput1 - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput1 -description: OpenAIResponseFunctionToolCallOutputOutput1 type definition -seoTitle: OpenAIResponseFunctionToolCallOutputOutput1 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput1 Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput1 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput1%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput1%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputImage` - -```typescript lines -const value: models.InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx deleted file mode 100644 index 34673b72..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputOutput2 - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputOutput2 -description: OpenAIResponseFunctionToolCallOutputOutput2 type definition -seoTitle: OpenAIResponseFunctionToolCallOutputOutput2 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputoutput2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputOutput2 Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputOutput2 type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputOutput2%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallOutputOutput2%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.OpenAIResponseFunctionToolCallOutputOutput1[]` - -```typescript lines -const value: models.OpenAIResponseFunctionToolCallOutputOutput1[] = []; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx deleted file mode 100644 index 2af85262..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputStatus - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputStatus -description: OpenAIResponseFunctionToolCallOutputStatus type definition -seoTitle: OpenAIResponseFunctionToolCallOutputStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputstatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputStatus Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputStatus type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputStatus%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallOutputStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseFunctionToolCallOutputStatus } from "@openrouter/sdk/models"; - -let value: OpenAIResponseFunctionToolCallOutputStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx deleted file mode 100644 index d1c72978..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallOutputType - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallOutputType -description: OpenAIResponseFunctionToolCallOutputType type definition -seoTitle: OpenAIResponseFunctionToolCallOutputType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallOutputType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallOutputType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallOutputType%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallOutputType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseFunctionToolCallOutputType } from "@openrouter/sdk/models"; - -let value: OpenAIResponseFunctionToolCallOutputType = "function_call_output"; -``` - -## Values - -```typescript lines -"function_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalltype.mdx b/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalltype.mdx deleted file mode 100644 index 97f2d803..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsefunctiontoolcalltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseFunctionToolCallType - TypeScript SDK -sidebarTitle: OpenAIResponseFunctionToolCallType -description: OpenAIResponseFunctionToolCallType type definition -seoTitle: OpenAIResponseFunctionToolCallType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsefunctiontoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseFunctionToolCallType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseFunctionToolCallType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseFunctionToolCallType%20-%20TypeScript%20SDK&description=OpenAIResponseFunctionToolCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseFunctionToolCallType } from "@openrouter/sdk/models"; - -let value: OpenAIResponseFunctionToolCallType = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitem.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitem.mdx deleted file mode 100644 index bc58908a..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OpenAIResponseInputMessageItem - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItem -description: OpenAIResponseInputMessageItem type definition -seoTitle: OpenAIResponseInputMessageItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItem Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItem%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseInputMessageItem } from "@openrouter/sdk/models"; - -let value: OpenAIResponseInputMessageItem = { - content: [ - { - text: "Hello, how are you?", - type: "input_text", - }, - ], - id: "msg-abc123", - role: "user", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content` | *models.OpenAIResponseInputMessageItemContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `role` | *models.OpenAIResponseInputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseInputMessageItemType](/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemcontent.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemcontent.mdx deleted file mode 100644 index 86488ea8..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemcontent.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemContent - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemContent -description: OpenAIResponseInputMessageItemContent type definition -seoTitle: OpenAIResponseInputMessageItemContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemContent Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemContent type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemContent%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.InputAudio` - -```typescript lines -const value: models.InputAudio = { - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, - type: "input_audio", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` - -### `models.InputImage` - -```typescript lines -const value: models.InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx deleted file mode 100644 index 3a579891..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleDeveloper - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleDeveloper -description: OpenAIResponseInputMessageItemRoleDeveloper type definition -seoTitle: OpenAIResponseInputMessageItemRoleDeveloper Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleDeveloper Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleDeveloper type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleDeveloper%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemRoleDeveloper%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseInputMessageItemRoleDeveloper } from "@openrouter/sdk/models"; - -let value: OpenAIResponseInputMessageItemRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemrolesystem.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemrolesystem.mdx deleted file mode 100644 index 48f36b79..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemrolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleSystem - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleSystem -description: OpenAIResponseInputMessageItemRoleSystem type definition -seoTitle: OpenAIResponseInputMessageItemRoleSystem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleSystem Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleSystem type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleSystem%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemRoleSystem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseInputMessageItemRoleSystem } from "@openrouter/sdk/models"; - -let value: OpenAIResponseInputMessageItemRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleunion.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleunion.mdx deleted file mode 100644 index 71cec580..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUnion - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUnion -description: OpenAIResponseInputMessageItemRoleUnion type definition -seoTitle: OpenAIResponseInputMessageItemRoleUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUnion type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUnion%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemRoleUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponseInputMessageItemRoleUser` - -```typescript lines -const value: models.OpenAIResponseInputMessageItemRoleUser = "user"; -``` - -### `models.OpenAIResponseInputMessageItemRoleSystem` - -```typescript lines -const value: models.OpenAIResponseInputMessageItemRoleSystem = "system"; -``` - -### `models.OpenAIResponseInputMessageItemRoleDeveloper` - -```typescript lines -const value: models.OpenAIResponseInputMessageItemRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleuser.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleuser.mdx deleted file mode 100644 index affc3d35..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemroleuser.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemRoleUser - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemRoleUser -description: OpenAIResponseInputMessageItemRoleUser type definition -seoTitle: OpenAIResponseInputMessageItemRoleUser Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemRoleUser Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemRoleUser type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemRoleUser%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemRoleUser%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseInputMessageItemRoleUser } from "@openrouter/sdk/models"; - -let value: OpenAIResponseInputMessageItemRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemtype.mdx b/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemtype.mdx deleted file mode 100644 index 4f747f10..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponseinputmessageitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponseInputMessageItemType - TypeScript SDK -sidebarTitle: OpenAIResponseInputMessageItemType -description: OpenAIResponseInputMessageItemType type definition -seoTitle: OpenAIResponseInputMessageItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponseinputmessageitemtype -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponseInputMessageItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponseInputMessageItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponseInputMessageItemType%20-%20TypeScript%20SDK&description=OpenAIResponseInputMessageItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponseInputMessageItemType } from "@openrouter/sdk/models"; - -let value: OpenAIResponseInputMessageItemType = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsesannotation.mdx b/client-sdks/typescript/api-reference/models/openairesponsesannotation.mdx deleted file mode 100644 index 4f20c0ed..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsesannotation.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OpenAIResponsesAnnotation - TypeScript SDK -sidebarTitle: OpenAIResponsesAnnotation -description: OpenAIResponsesAnnotation type definition -seoTitle: OpenAIResponsesAnnotation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsesannotation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesAnnotation Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesAnnotation type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesAnnotation%20-%20TypeScript%20SDK&description=OpenAIResponsesAnnotation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.FileCitation` - -```typescript lines -const value: models.FileCitation = { - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, - type: "file_citation", -}; -``` - -### `models.URLCitation` - -```typescript lines -const value: models.URLCitation = { - endIndex: 582752, - startIndex: 114325, - title: "", - type: "url_citation", - url: "https://dim-jet.biz/", -}; -``` - -### `models.FilePath` - -```typescript lines -const value: models.FilePath = { - fileId: "file-abc123", - index: 0, - type: "file_path", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsesrefusalcontent.mdx b/client-sdks/typescript/api-reference/models/openairesponsesrefusalcontent.mdx deleted file mode 100644 index 0aeb5953..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsesrefusalcontent.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponsesRefusalContent - TypeScript SDK -sidebarTitle: OpenAIResponsesRefusalContent -description: OpenAIResponsesRefusalContent type definition -seoTitle: OpenAIResponsesRefusalContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsesrefusalcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContent Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesRefusalContent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContent%20-%20TypeScript%20SDK&description=OpenAIResponsesRefusalContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesRefusalContent } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `type` | *"refusal"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsesresponsestatus.mdx b/client-sdks/typescript/api-reference/models/openairesponsesresponsestatus.mdx deleted file mode 100644 index d92f4481..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsesresponsestatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesResponseStatus - TypeScript SDK -sidebarTitle: OpenAIResponsesResponseStatus -description: OpenAIResponsesResponseStatus type definition -seoTitle: OpenAIResponsesResponseStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsesresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesResponseStatus Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesResponseStatus type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesResponseStatus%20-%20TypeScript%20SDK&description=OpenAIResponsesResponseStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesResponseStatus } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesResponseStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"completed" | "incomplete" | "in_progress" | "failed" | "cancelled" | "queued" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoice.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoice.mdx deleted file mode 100644 index beb674c5..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoice.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoice - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoice -description: OpenAIResponsesToolChoice type definition -seoTitle: OpenAIResponsesToolChoice Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoice -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoice Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoice type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoice%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoice } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoice = { - type: "web_search_preview", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *models.Type* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceapplypatch.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceapplypatch.mdx deleted file mode 100644 index cfaff508..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceapplypatch.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceApplyPatch - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceApplyPatch -description: OpenAIResponsesToolChoiceApplyPatch type definition -seoTitle: OpenAIResponsesToolChoiceApplyPatch Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoiceapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceApplyPatch Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceApplyPatch type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceApplyPatch%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceApplyPatch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceApplyPatch } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceApplyPatch = { - type: "apply_patch", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [models.OpenAIResponsesToolChoiceTypeApplyPatch](/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeapplypatch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceauto.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceauto.mdx deleted file mode 100644 index dfa0de6f..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceauto.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceAuto - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceAuto -description: OpenAIResponsesToolChoiceAuto type definition -seoTitle: OpenAIResponsesToolChoiceAuto Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceAuto Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceAuto type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceAuto%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceAuto } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceAuto = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicefunction.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicefunction.mdx deleted file mode 100644 index 740ef581..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicefunction.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceFunction - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceFunction -description: OpenAIResponsesToolChoiceFunction type definition -seoTitle: OpenAIResponsesToolChoiceFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceFunction Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceFunction type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceFunction%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceFunction } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceFunction = { - name: "", - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicenone.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicenone.mdx deleted file mode 100644 index 8425ef1a..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicenone.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceNone - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceNone -description: OpenAIResponsesToolChoiceNone type definition -seoTitle: OpenAIResponsesToolChoiceNone Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceNone Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceNone type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceNone%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceNone } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceNone = "none"; -``` - -## Values - -```typescript lines -"none" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicerequired.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicerequired.mdx deleted file mode 100644 index 59dfd990..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicerequired.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceRequired - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceRequired -description: OpenAIResponsesToolChoiceRequired type definition -seoTitle: OpenAIResponsesToolChoiceRequired Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceRequired Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceRequired type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceRequired%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceRequired%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceRequired } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceRequired = "required"; -``` - -## Values - -```typescript lines -"required" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceshell.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceshell.mdx deleted file mode 100644 index 1cf626c2..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceshell.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceShell - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceShell -description: OpenAIResponsesToolChoiceShell type definition -seoTitle: OpenAIResponsesToolChoiceShell Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoiceshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceShell Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceShell type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceShell%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceShell%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceShell } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceShell = { - type: "shell", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [models.OpenAIResponsesToolChoiceTypeShell](/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeshell) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx deleted file mode 100644 index 981a4a1e..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeapplypatch.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeApplyPatch - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeApplyPatch -description: OpenAIResponsesToolChoiceTypeApplyPatch type definition -seoTitle: OpenAIResponsesToolChoiceTypeApplyPatch Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicetypeapplypatch -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeApplyPatch Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeApplyPatch type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeApplyPatch%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeApplyPatch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeApplyPatch } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeApplyPatch = "apply_patch"; -``` - -## Values - -```typescript lines -"apply_patch" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypefunction.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypefunction.mdx deleted file mode 100644 index e4237ce7..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypefunction.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeFunction - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeFunction -description: OpenAIResponsesToolChoiceTypeFunction type definition -seoTitle: OpenAIResponsesToolChoiceTypeFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicetypefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeFunction Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeFunction type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeFunction%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeFunction } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeFunction = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeshell.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeshell.mdx deleted file mode 100644 index b87b9c73..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypeshell.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeShell - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeShell -description: OpenAIResponsesToolChoiceTypeShell type definition -seoTitle: OpenAIResponsesToolChoiceTypeShell Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicetypeshell -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeShell Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeShell type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeShell%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeShell%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeShell } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeShell = "shell"; -``` - -## Values - -```typescript lines -"shell" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx deleted file mode 100644 index 95a3de27..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview -description: OpenAIResponsesToolChoiceTypeWebSearchPreview type definition -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview type reference for the - OpenRouter TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeWebSearchPreview } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeWebSearchPreview = "web_search_preview"; -``` - -## Values - -```typescript lines -"web_search_preview" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx deleted file mode 100644 index 2da02f1c..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 -description: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 type definition -seoTitle: >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 Type | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoicetypewebsearchpreview20250311 -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 Type | OpenRouter - TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 type reference for the - OpenRouter TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = - "web_search_preview_2025_03_11"; -``` - -## Values - -```typescript lines -"web_search_preview_2025_03_11" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceunion.mdx b/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceunion.mdx deleted file mode 100644 index c6d99dc4..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestoolchoiceunion.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceUnion - TypeScript SDK -sidebarTitle: OpenAIResponsesToolChoiceUnion -description: OpenAIResponsesToolChoiceUnion type definition -seoTitle: OpenAIResponsesToolChoiceUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestoolchoiceunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceUnion type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceUnion%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesToolChoiceAuto` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceAuto = "auto"; -``` - -### `models.OpenAIResponsesToolChoiceNone` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceNone = "none"; -``` - -### `models.OpenAIResponsesToolChoiceRequired` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceRequired = "required"; -``` - -### `models.OpenAIResponsesToolChoiceFunction` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceFunction = { - name: "", - type: "function", -}; -``` - -### `models.OpenAIResponsesToolChoice` - -```typescript lines -const value: models.OpenAIResponsesToolChoice = { - type: "web_search_preview", -}; -``` - -### `models.ToolChoiceAllowed` - -```typescript lines -const value: models.ToolChoiceAllowed = { - mode: "auto", - tools: [ - { - "name": "get_weather", - "type": "function", - }, - ], - type: "allowed_tools", -}; -``` - -### `models.OpenAIResponsesToolChoiceApplyPatch` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceApplyPatch = { - type: "apply_patch", -}; -``` - -### `models.OpenAIResponsesToolChoiceShell` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceShell = { - type: "shell", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openairesponsestruncation.mdx b/client-sdks/typescript/api-reference/models/openairesponsestruncation.mdx deleted file mode 100644 index 59a2727c..00000000 --- a/client-sdks/typescript/api-reference/models/openairesponsestruncation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OpenAIResponsesTruncation - TypeScript SDK -sidebarTitle: OpenAIResponsesTruncation -description: OpenAIResponsesTruncation type definition -seoTitle: OpenAIResponsesTruncation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openairesponsestruncation -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesTruncation Type | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesTruncation type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesTruncation%20-%20TypeScript%20SDK&description=OpenAIResponsesTruncation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesTruncation } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesTruncation = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "disabled" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openresponsescreatedevent.mdx b/client-sdks/typescript/api-reference/models/openresponsescreatedevent.mdx deleted file mode 100644 index 3a1d35bd..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsescreatedevent.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesCreatedEvent - TypeScript SDK -sidebarTitle: OpenResponsesCreatedEvent -description: OpenResponsesCreatedEvent type definition -seoTitle: OpenResponsesCreatedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsescreatedevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesCreatedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesCreatedEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesCreatedEvent%20-%20TypeScript%20SDK&description=OpenResponsesCreatedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is created - -## Example Usage - -```typescript expandable lines -import { OpenResponsesCreatedEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesCreatedEvent = { - response: { - completedAt: null, - createdAt: 1704067200, - error: null, - frequencyPenalty: 2702.39, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 134.06, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.created", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](/client-sdks/typescript/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": `{"input_tokens": 10,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 25,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `35
`\}
\} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.created"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openresponsesinprogressevent.mdx b/client-sdks/typescript/api-reference/models/openresponsesinprogressevent.mdx deleted file mode 100644 index c9149b65..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsesinprogressevent.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesInProgressEvent - TypeScript SDK -sidebarTitle: OpenResponsesInProgressEvent -description: OpenResponsesInProgressEvent type definition -seoTitle: OpenResponsesInProgressEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsesinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInProgressEvent Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInProgressEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInProgressEvent%20-%20TypeScript%20SDK&description=OpenResponsesInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is in progress - -## Example Usage - -```typescript expandable lines -import { OpenResponsesInProgressEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesInProgressEvent = { - response: { - completedAt: 950130, - createdAt: 1704067200, - error: null, - frequencyPenalty: 300.6, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 8561.18, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.in_progress", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](/client-sdks/typescript/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": `{"input_tokens": 10,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 25,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `35
`\}
\} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.in_progress"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openresponsesresult.mdx b/client-sdks/typescript/api-reference/models/openresponsesresult.mdx deleted file mode 100644 index a3911845..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsesresult.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: OpenResponsesResult - TypeScript SDK -sidebarTitle: OpenResponsesResult -description: OpenResponsesResult type definition -seoTitle: OpenResponsesResult Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsesresult -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResult Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResult type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResult%20-%20TypeScript%20SDK&description=OpenResponsesResult%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Complete non-streaming response from the Responses API - -## Example Usage - -```typescript expandable lines -import { OpenResponsesResult } from "@openrouter/sdk/models"; - -let value: OpenResponsesResult = { - completedAt: 831625, - createdAt: 1704067200, - error: null, - frequencyPenalty: 9553.57, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [ - { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - ], - parallelToolCalls: true, - presencePenalty: 9626.13, - status: "completed", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `completedAt` | *number* | :heavy_check_mark: | N/A | | -| `createdAt` | *number* | :heavy_check_mark: | N/A | | -| `error` | [models.ResponsesErrorField](/client-sdks/typescript/api-reference/models/responseserrorfield) | :heavy_check_mark: | Error information returned from the API | `{"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."}` | -| `frequencyPenalty` | *number* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `incompleteDetails` | [models.IncompleteDetails](/client-sdks/typescript/api-reference/models/incompletedetails) | :heavy_check_mark: | N/A | `{"reason": "max_output_tokens"}` | -| `instructions` | *models.BaseInputsUnion* | :heavy_check_mark: | N/A | [
`{"content": "What is the weather today?","role": "user"}`
] | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | -| `metadata` | `Record` | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | `{"session_id": "abc-def-ghi","user_id": "123"}` | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `object` | [models.OpenResponsesResultObject](/client-sdks/typescript/api-reference/models/openresponsesresultobject) | :heavy_check_mark: | N/A | | -| `output` | *models.OutputItems*[] | :heavy_check_mark: | N/A | | -| `outputText` | *string* | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_check_mark: | N/A | | -| `presencePenalty` | *number* | :heavy_check_mark: | N/A | | -| `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | [models.StoredPromptTemplate](/client-sdks/typescript/api-reference/models/storedprompttemplate) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `reasoning` | [models.BaseReasoningConfig](/client-sdks/typescript/api-reference/models/basereasoningconfig) | :heavy_minus_sign: | N/A | `{"effort": "medium","summary": "auto"}` | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | -| `serviceTier` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.OpenAIResponsesResponseStatus](/client-sdks/typescript/api-reference/models/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | completed | -| `store` | *boolean* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_check_mark: | N/A | | -| `text` | [models.TextExtendedConfig](/client-sdks/typescript/api-reference/models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`
\} | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_check_mark: | N/A | auto | -| `tools` | *models.OpenResponsesResultToolUnion*[] | :heavy_check_mark: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_check_mark: | N/A | | -| `truncation` | [models.Truncation](/client-sdks/typescript/api-reference/models/truncation) | :heavy_minus_sign: | N/A | auto | -| `usage` | [models.Usage](/client-sdks/typescript/api-reference/models/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` | *string* | :heavy_minus_sign: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/openresponsesresultobject.mdx b/client-sdks/typescript/api-reference/models/openresponsesresultobject.mdx deleted file mode 100644 index 31059890..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsesresultobject.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesResultObject - TypeScript SDK -sidebarTitle: OpenResponsesResultObject -description: OpenResponsesResultObject type definition -seoTitle: OpenResponsesResultObject Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsesresultobject -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultObject Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResultObject type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultObject%20-%20TypeScript%20SDK&description=OpenResponsesResultObject%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesResultObject } from "@openrouter/sdk/models"; - -let value: OpenResponsesResultObject = "response"; -``` - -## Values - -```typescript lines -"response" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openresponsesresulttoolfunction.mdx b/client-sdks/typescript/api-reference/models/openresponsesresulttoolfunction.mdx deleted file mode 100644 index 55375a82..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsesresulttoolfunction.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: OpenResponsesResultToolFunction - TypeScript SDK -sidebarTitle: OpenResponsesResultToolFunction -description: OpenResponsesResultToolFunction type definition -seoTitle: OpenResponsesResultToolFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsesresulttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolFunction Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResultToolFunction type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolFunction%20-%20TypeScript%20SDK&description=OpenResponsesResultToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Example Usage - -```typescript expandable lines -import { OpenResponsesResultToolFunction } from "@openrouter/sdk/models"; - -let value: OpenResponsesResultToolFunction = { - name: "get_weather", - parameters: { - "properties": { - "location": { - "description": "The city and state", - "type": "string", - }, - "unit": { - "enum": [ - "celsius", - "fahrenheit", - ], - "type": "string", - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - "type": "object", - }, - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `parameters` | `Record` | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"function"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openresponsesresulttoolunion.mdx b/client-sdks/typescript/api-reference/models/openresponsesresulttoolunion.mdx deleted file mode 100644 index ba5e1145..00000000 --- a/client-sdks/typescript/api-reference/models/openresponsesresulttoolunion.mdx +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: OpenResponsesResultToolUnion - TypeScript SDK -sidebarTitle: OpenResponsesResultToolUnion -description: OpenResponsesResultToolUnion type definition -seoTitle: OpenResponsesResultToolUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openresponsesresulttoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResultToolUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResultToolUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResultToolUnion%20-%20TypeScript%20SDK&description=OpenResponsesResultToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesResultToolFunction` - -```typescript expandable lines -const value: models.OpenResponsesResultToolFunction = { - name: "get_weather", - parameters: { - "properties": { - "location": { - "description": "The city and state", - "type": "string", - }, - "unit": { - "enum": [ - "celsius", - "fahrenheit", - ], - "type": "string", - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - "type": "object", - }, - type: "function", -}; -``` - -### `models.PreviewWebSearchServerTool` - -```typescript lines -const value: models.PreviewWebSearchServerTool = { - type: "web_search_preview", -}; -``` - -### `models.Preview20250311WebSearchServerTool` - -```typescript lines -const value: models.Preview20250311WebSearchServerTool = { - type: "web_search_preview_2025_03_11", -}; -``` - -### `models.LegacyWebSearchServerTool` - -```typescript lines -const value: models.LegacyWebSearchServerTool = { - type: "web_search", -}; -``` - -### `models.WebSearchServerTool` - -```typescript lines -const value: models.WebSearchServerTool = { - type: "web_search_2025_08_26", -}; -``` - -### `models.FileSearchServerTool` - -```typescript lines -const value: models.FileSearchServerTool = { - type: "file_search", - vectorStoreIds: [ - "vs_abc123", - ], -}; -``` - -### `models.ComputerUseServerTool` - -```typescript lines -const value: models.ComputerUseServerTool = { - displayHeight: 768, - displayWidth: 1024, - environment: "linux", - type: "computer_use_preview", -}; -``` - -### `models.CodeInterpreterServerTool` - -```typescript lines -const value: models.CodeInterpreterServerTool = { - container: "auto", - type: "code_interpreter", -}; -``` - -### `models.McpServerTool` - -```typescript lines -const value: models.McpServerTool = { - serverLabel: "my-server", - type: "mcp", -}; -``` - -### `models.ImageGenerationServerTool` - -```typescript lines -const value: models.ImageGenerationServerTool = { - type: "image_generation", -}; -``` - -### `models.CodexLocalShellTool` - -```typescript lines -const value: models.CodexLocalShellTool = { - type: "local_shell", -}; -``` - -### `models.ShellServerTool` - -```typescript lines -const value: models.ShellServerTool = { - type: "shell", -}; -``` - -### `models.ApplyPatchServerTool` - -```typescript lines -const value: models.ApplyPatchServerTool = { - type: "apply_patch", -}; -``` - -### `models.CustomTool` - -```typescript lines -const value: models.CustomTool = { - name: "my_tool", - type: "custom", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openroutermetadata.mdx b/client-sdks/typescript/api-reference/models/openroutermetadata.mdx deleted file mode 100644 index 19b38d00..00000000 --- a/client-sdks/typescript/api-reference/models/openroutermetadata.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OpenRouterMetadata - TypeScript SDK -sidebarTitle: OpenRouterMetadata -description: OpenRouterMetadata type definition -seoTitle: OpenRouterMetadata Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openroutermetadata -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterMetadata Type | OpenRouter TypeScript SDK -'og:description': >- - OpenRouterMetadata type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterMetadata%20-%20TypeScript%20SDK&description=OpenRouterMetadata%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenRouterMetadata } from "@openrouter/sdk/models"; - -let value: OpenRouterMetadata = { - attempt: 1, - endpoints: { - available: [ - { - model: "openai/gpt-4o", - provider: "OpenAI", - selected: true, - }, - ], - total: 1, - }, - isByok: false, - region: "iad", - requested: "openai/gpt-4o", - strategy: "direct", - summary: "available=1, selected=OpenAI", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `attempt` | *number* | :heavy_check_mark: | N/A | | -| `attempts` | [models.RouterAttempt](/client-sdks/typescript/api-reference/models/routerattempt)[] | :heavy_minus_sign: | N/A | | -| `endpoints` | [models.EndpointsMetadata](/client-sdks/typescript/api-reference/models/endpointsmetadata) | :heavy_check_mark: | N/A | `{"available": [{"model": "openai/gpt-4o","provider": "OpenAI","selected": true}`
],
"total": `3
`\} | -| `isByok` | *boolean* | :heavy_check_mark: | N/A | | -| `params` | [models.RouterParams](/client-sdks/typescript/api-reference/models/routerparams) | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | -| `pipeline` | [models.PipelineStage](/client-sdks/typescript/api-reference/models/pipelinestage)[] | :heavy_minus_sign: | N/A | | -| `region` | *string* | :heavy_check_mark: | N/A | | -| `requested` | *string* | :heavy_check_mark: | N/A | | -| `strategy` | [models.RoutingStrategy](/client-sdks/typescript/api-reference/models/routingstrategy) | :heavy_check_mark: | N/A | direct | -| `summary` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openrouterwebsearchservertool.mdx b/client-sdks/typescript/api-reference/models/openrouterwebsearchservertool.mdx deleted file mode 100644 index 62fe57ae..00000000 --- a/client-sdks/typescript/api-reference/models/openrouterwebsearchservertool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenRouterWebSearchServerTool - TypeScript SDK -sidebarTitle: OpenRouterWebSearchServerTool -description: OpenRouterWebSearchServerTool type definition -seoTitle: OpenRouterWebSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openrouterwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - OpenRouterWebSearchServerTool type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerTool%20-%20TypeScript%20SDK&description=OpenRouterWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Example Usage - -```typescript lines -import { OpenRouterWebSearchServerTool } from "@openrouter/sdk/models"; - -let value: OpenRouterWebSearchServerTool = { - type: "openrouter:web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [models.WebSearchConfig](/client-sdks/typescript/api-reference/models/websearchconfig) | :heavy_minus_sign: | N/A | `{"max_results": 5,"search_context_size": "medium"}` | -| `type` | [models.OpenRouterWebSearchServerToolType](/client-sdks/typescript/api-reference/models/openrouterwebsearchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/openrouterwebsearchservertooltype.mdx b/client-sdks/typescript/api-reference/models/openrouterwebsearchservertooltype.mdx deleted file mode 100644 index 11d0c04e..00000000 --- a/client-sdks/typescript/api-reference/models/openrouterwebsearchservertooltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenRouterWebSearchServerToolType - TypeScript SDK -sidebarTitle: OpenRouterWebSearchServerToolType -description: OpenRouterWebSearchServerToolType type definition -seoTitle: OpenRouterWebSearchServerToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/openrouterwebsearchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': OpenRouterWebSearchServerToolType Type | OpenRouter TypeScript SDK -'og:description': >- - OpenRouterWebSearchServerToolType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenRouterWebSearchServerToolType%20-%20TypeScript%20SDK&description=OpenRouterWebSearchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenRouterWebSearchServerToolType } from "@openrouter/sdk/models"; - -let value: OpenRouterWebSearchServerToolType = "openrouter:web_search"; -``` - -## Values - -```typescript lines -"openrouter:web_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/operator.mdx b/client-sdks/typescript/api-reference/models/operator.mdx deleted file mode 100644 index fd8bd837..00000000 --- a/client-sdks/typescript/api-reference/models/operator.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Operator - TypeScript SDK -sidebarTitle: Operator -description: Operator type definition -seoTitle: Operator Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/operator' -'og:site_name': OpenRouter Documentation -'og:title': Operator Type | OpenRouter TypeScript SDK -'og:description': >- - Operator type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Operator%20-%20TypeScript%20SDK&description=Operator%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Operator } from "@openrouter/sdk/models"; - -let value: Operator = "ends_with"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"equals" | "not_equals" | "contains" | "not_contains" | "regex" | "starts_with" | "ends_with" | "gt" | "lt" | "gte" | "lte" | "exists" | "not_exists" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/options.mdx b/client-sdks/typescript/api-reference/models/options.mdx deleted file mode 100644 index 9b94d88b..00000000 --- a/client-sdks/typescript/api-reference/models/options.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: Options - TypeScript SDK -sidebarTitle: Options -description: Options type definition -seoTitle: Options Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/options' -'og:site_name': OpenRouter Documentation -'og:title': Options Type | OpenRouter TypeScript SDK -'og:description': >- - Options type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Options%20-%20TypeScript%20SDK&description=Options%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Example Usage - -```typescript lines -import { Options } from "@openrouter/sdk/models"; - -let value: Options = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `oneai` | `Record` | :heavy_minus_sign: | N/A | -| `ai21` | `Record` | :heavy_minus_sign: | N/A | -| `aionLabs` | `Record` | :heavy_minus_sign: | N/A | -| `akashml` | `Record` | :heavy_minus_sign: | N/A | -| `alibaba` | `Record` | :heavy_minus_sign: | N/A | -| `amazonBedrock` | `Record` | :heavy_minus_sign: | N/A | -| `amazonNova` | `Record` | :heavy_minus_sign: | N/A | -| `ambient` | `Record` | :heavy_minus_sign: | N/A | -| `anthropic` | `Record` | :heavy_minus_sign: | N/A | -| `anyscale` | `Record` | :heavy_minus_sign: | N/A | -| `arceeAi` | `Record` | :heavy_minus_sign: | N/A | -| `atlasCloud` | `Record` | :heavy_minus_sign: | N/A | -| `atoma` | `Record` | :heavy_minus_sign: | N/A | -| `avian` | `Record` | :heavy_minus_sign: | N/A | -| `azure` | `Record` | :heavy_minus_sign: | N/A | -| `baidu` | `Record` | :heavy_minus_sign: | N/A | -| `baseten` | `Record` | :heavy_minus_sign: | N/A | -| `blackForestLabs` | `Record` | :heavy_minus_sign: | N/A | -| `byteplus` | `Record` | :heavy_minus_sign: | N/A | -| `centml` | `Record` | :heavy_minus_sign: | N/A | -| `cerebras` | `Record` | :heavy_minus_sign: | N/A | -| `chutes` | `Record` | :heavy_minus_sign: | N/A | -| `cirrascale` | `Record` | :heavy_minus_sign: | N/A | -| `clarifai` | `Record` | :heavy_minus_sign: | N/A | -| `cloudflare` | `Record` | :heavy_minus_sign: | N/A | -| `cohere` | `Record` | :heavy_minus_sign: | N/A | -| `crofai` | `Record` | :heavy_minus_sign: | N/A | -| `crucible` | `Record` | :heavy_minus_sign: | N/A | -| `crusoe` | `Record` | :heavy_minus_sign: | N/A | -| `darkbloom` | `Record` | :heavy_minus_sign: | N/A | -| `deepinfra` | `Record` | :heavy_minus_sign: | N/A | -| `deepseek` | `Record` | :heavy_minus_sign: | N/A | -| `dekallm` | `Record` | :heavy_minus_sign: | N/A | -| `digitalocean` | `Record` | :heavy_minus_sign: | N/A | -| `enfer` | `Record` | :heavy_minus_sign: | N/A | -| `fakeProvider` | `Record` | :heavy_minus_sign: | N/A | -| `featherless` | `Record` | :heavy_minus_sign: | N/A | -| `fireworks` | `Record` | :heavy_minus_sign: | N/A | -| `friendli` | `Record` | :heavy_minus_sign: | N/A | -| `gmicloud` | `Record` | :heavy_minus_sign: | N/A | -| `googleAiStudio` | `Record` | :heavy_minus_sign: | N/A | -| `googleVertex` | `Record` | :heavy_minus_sign: | N/A | -| `gopomelo` | `Record` | :heavy_minus_sign: | N/A | -| `groq` | `Record` | :heavy_minus_sign: | N/A | -| `huggingface` | `Record` | :heavy_minus_sign: | N/A | -| `hyperbolic` | `Record` | :heavy_minus_sign: | N/A | -| `hyperbolicQuantized` | `Record` | :heavy_minus_sign: | N/A | -| `inception` | `Record` | :heavy_minus_sign: | N/A | -| `inceptron` | `Record` | :heavy_minus_sign: | N/A | -| `inferenceNet` | `Record` | :heavy_minus_sign: | N/A | -| `infermatic` | `Record` | :heavy_minus_sign: | N/A | -| `inflection` | `Record` | :heavy_minus_sign: | N/A | -| `inocloud` | `Record` | :heavy_minus_sign: | N/A | -| `ioNet` | `Record` | :heavy_minus_sign: | N/A | -| `ionstream` | `Record` | :heavy_minus_sign: | N/A | -| `klusterai` | `Record` | :heavy_minus_sign: | N/A | -| `lambda` | `Record` | :heavy_minus_sign: | N/A | -| `lepton` | `Record` | :heavy_minus_sign: | N/A | -| `liquid` | `Record` | :heavy_minus_sign: | N/A | -| `lynn` | `Record` | :heavy_minus_sign: | N/A | -| `lynnPrivate` | `Record` | :heavy_minus_sign: | N/A | -| `mancer` | `Record` | :heavy_minus_sign: | N/A | -| `mancerOld` | `Record` | :heavy_minus_sign: | N/A | -| `mara` | `Record` | :heavy_minus_sign: | N/A | -| `meta` | `Record` | :heavy_minus_sign: | N/A | -| `minimax` | `Record` | :heavy_minus_sign: | N/A | -| `mistral` | `Record` | :heavy_minus_sign: | N/A | -| `modal` | `Record` | :heavy_minus_sign: | N/A | -| `modelrun` | `Record` | :heavy_minus_sign: | N/A | -| `modular` | `Record` | :heavy_minus_sign: | N/A | -| `moonshotai` | `Record` | :heavy_minus_sign: | N/A | -| `morph` | `Record` | :heavy_minus_sign: | N/A | -| `ncompass` | `Record` | :heavy_minus_sign: | N/A | -| `nebius` | `Record` | :heavy_minus_sign: | N/A | -| `nexAgi` | `Record` | :heavy_minus_sign: | N/A | -| `nextbit` | `Record` | :heavy_minus_sign: | N/A | -| `nineteen` | `Record` | :heavy_minus_sign: | N/A | -| `novita` | `Record` | :heavy_minus_sign: | N/A | -| `nvidia` | `Record` | :heavy_minus_sign: | N/A | -| `octoai` | `Record` | :heavy_minus_sign: | N/A | -| `openInference` | `Record` | :heavy_minus_sign: | N/A | -| `openai` | `Record` | :heavy_minus_sign: | N/A | -| `parasail` | `Record` | :heavy_minus_sign: | N/A | -| `perceptron` | `Record` | :heavy_minus_sign: | N/A | -| `perplexity` | `Record` | :heavy_minus_sign: | N/A | -| `phala` | `Record` | :heavy_minus_sign: | N/A | -| `poolside` | `Record` | :heavy_minus_sign: | N/A | -| `recraft` | `Record` | :heavy_minus_sign: | N/A | -| `recursal` | `Record` | :heavy_minus_sign: | N/A | -| `reflection` | `Record` | :heavy_minus_sign: | N/A | -| `reka` | `Record` | :heavy_minus_sign: | N/A | -| `relace` | `Record` | :heavy_minus_sign: | N/A | -| `replicate` | `Record` | :heavy_minus_sign: | N/A | -| `sambanova` | `Record` | :heavy_minus_sign: | N/A | -| `sambanovaCloaked` | `Record` | :heavy_minus_sign: | N/A | -| `seed` | `Record` | :heavy_minus_sign: | N/A | -| `sfCompute` | `Record` | :heavy_minus_sign: | N/A | -| `siliconflow` | `Record` | :heavy_minus_sign: | N/A | -| `sourceful` | `Record` | :heavy_minus_sign: | N/A | -| `stealth` | `Record` | :heavy_minus_sign: | N/A | -| `stepfun` | `Record` | :heavy_minus_sign: | N/A | -| `streamlake` | `Record` | :heavy_minus_sign: | N/A | -| `switchpoint` | `Record` | :heavy_minus_sign: | N/A | -| `targon` | `Record` | :heavy_minus_sign: | N/A | -| `together` | `Record` | :heavy_minus_sign: | N/A | -| `togetherLite` | `Record` | :heavy_minus_sign: | N/A | -| `ubicloud` | `Record` | :heavy_minus_sign: | N/A | -| `upstage` | `Record` | :heavy_minus_sign: | N/A | -| `venice` | `Record` | :heavy_minus_sign: | N/A | -| `wandb` | `Record` | :heavy_minus_sign: | N/A | -| `xai` | `Record` | :heavy_minus_sign: | N/A | -| `xiaomi` | `Record` | :heavy_minus_sign: | N/A | -| `zAi` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/order.mdx b/client-sdks/typescript/api-reference/models/order.mdx deleted file mode 100644 index ce224f5d..00000000 --- a/client-sdks/typescript/api-reference/models/order.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Order - TypeScript SDK -sidebarTitle: Order -description: Order type definition -seoTitle: Order Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/order' -'og:site_name': OpenRouter Documentation -'og:title': Order Type | OpenRouter TypeScript SDK -'og:description': >- - Order type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Order%20-%20TypeScript%20SDK&description=Order%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputapplypatchcallitem.mdx b/client-sdks/typescript/api-reference/models/outputapplypatchcallitem.mdx deleted file mode 100644 index cc7b4164..00000000 --- a/client-sdks/typescript/api-reference/models/outputapplypatchcallitem.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: OutputApplyPatchCallItem - TypeScript SDK -sidebarTitle: OutputApplyPatchCallItem -description: OutputApplyPatchCallItem type definition -seoTitle: OutputApplyPatchCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputapplypatchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputApplyPatchCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchCallItem%20-%20TypeScript%20SDK&description=OutputApplyPatchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A native `apply_patch_call` output item matching OpenAI's Responses API shape. Emitted when the client requested the `apply_patch` shorthand. - -## Example Usage - -```typescript lines -import { OutputApplyPatchCallItem } from "@openrouter/sdk/models"; - -let value: OutputApplyPatchCallItem = { - callId: "", - id: "msg-abc123", - operation: { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", - }, - status: "completed", - type: "apply_patch_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `status` | [models.ApplyPatchCallStatus](/client-sdks/typescript/api-reference/models/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | *"apply_patch_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitem.mdx deleted file mode 100644 index d94739d9..00000000 --- a/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputApplyPatchServerToolItem - TypeScript SDK -sidebarTitle: OutputApplyPatchServerToolItem -description: OutputApplyPatchServerToolItem type definition -seoTitle: OutputApplyPatchServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputapplypatchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputApplyPatchServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItem%20-%20TypeScript%20SDK&description=OutputApplyPatchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:apply_patch server tool output item. The turn halts when validation succeeds so the client can apply the patch and echo an `apply_patch_call_output` on the next turn. - -## Example Usage - -```typescript lines -import { OutputApplyPatchServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputApplyPatchServerToolItem = { - status: "completed", - type: "openrouter:apply_patch", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_minus_sign: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | `{"diff": "@@ function main() {\n+ console.log(\"hi\");\n }`",
"path": "/src/main.ts",
"type": "update_file"
\} | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputApplyPatchServerToolItemType](/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitemtype.mdx deleted file mode 100644 index 7297994b..00000000 --- a/client-sdks/typescript/api-reference/models/outputapplypatchservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputApplyPatchServerToolItemType - TypeScript SDK -sidebarTitle: OutputApplyPatchServerToolItemType -description: OutputApplyPatchServerToolItemType type definition -seoTitle: OutputApplyPatchServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputapplypatchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputApplyPatchServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputApplyPatchServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputApplyPatchServerToolItemType%20-%20TypeScript%20SDK&description=OutputApplyPatchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputApplyPatchServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputApplyPatchServerToolItemType = "openrouter:apply_patch"; -``` - -## Values - -```typescript lines -"openrouter:apply_patch" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputbashservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputbashservertoolitem.mdx deleted file mode 100644 index ac0a301d..00000000 --- a/client-sdks/typescript/api-reference/models/outputbashservertoolitem.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OutputBashServerToolItem - TypeScript SDK -sidebarTitle: OutputBashServerToolItem -description: OutputBashServerToolItem type definition -seoTitle: OutputBashServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputbashservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputBashServerToolItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItem%20-%20TypeScript%20SDK&description=OutputBashServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:bash server tool output item - -## Example Usage - -```typescript lines -import { OutputBashServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputBashServerToolItem = { - status: "completed", - type: "openrouter:bash", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `command` | *string* | :heavy_minus_sign: | N/A | | -| `exitCode` | *number* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `stderr` | *string* | :heavy_minus_sign: | N/A | | -| `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputBashServerToolItemType](/client-sdks/typescript/api-reference/models/outputbashservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputbashservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputbashservertoolitemtype.mdx deleted file mode 100644 index 57a99ba8..00000000 --- a/client-sdks/typescript/api-reference/models/outputbashservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputBashServerToolItemType - TypeScript SDK -sidebarTitle: OutputBashServerToolItemType -description: OutputBashServerToolItemType type definition -seoTitle: OutputBashServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputbashservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBashServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputBashServerToolItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBashServerToolItemType%20-%20TypeScript%20SDK&description=OutputBashServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputBashServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputBashServerToolItemType = "openrouter:bash"; -``` - -## Values - -```typescript lines -"openrouter:bash" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitem.mdx deleted file mode 100644 index 29a9f093..00000000 --- a/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputBrowserUseServerToolItem - TypeScript SDK -sidebarTitle: OutputBrowserUseServerToolItem -description: OutputBrowserUseServerToolItem type definition -seoTitle: OutputBrowserUseServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputbrowseruseservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputBrowserUseServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItem%20-%20TypeScript%20SDK&description=OutputBrowserUseServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:browser_use server tool output item - -## Example Usage - -```typescript lines -import { OutputBrowserUseServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputBrowserUseServerToolItem = { - status: "completed", - type: "openrouter:browser_use", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `action` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `screenshotB64` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputBrowserUseServerToolItemType](/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitemtype.mdx deleted file mode 100644 index 9d41e439..00000000 --- a/client-sdks/typescript/api-reference/models/outputbrowseruseservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputBrowserUseServerToolItemType - TypeScript SDK -sidebarTitle: OutputBrowserUseServerToolItemType -description: OutputBrowserUseServerToolItemType type definition -seoTitle: OutputBrowserUseServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputbrowseruseservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputBrowserUseServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputBrowserUseServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputBrowserUseServerToolItemType%20-%20TypeScript%20SDK&description=OutputBrowserUseServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputBrowserUseServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputBrowserUseServerToolItemType = "openrouter:browser_use"; -``` - -## Values - -```typescript lines -"openrouter:browser_use" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitem.mdx b/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitem.mdx deleted file mode 100644 index b9888d43..00000000 --- a/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitem.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: OutputCodeInterpreterCallItem - TypeScript SDK -sidebarTitle: OutputCodeInterpreterCallItem -description: OutputCodeInterpreterCallItem type definition -seoTitle: OutputCodeInterpreterCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcodeinterpretercallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCodeInterpreterCallItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItem%20-%20TypeScript%20SDK&description=OutputCodeInterpreterCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A code interpreter execution call with outputs - -## Example Usage - -```typescript lines -import { OutputCodeInterpreterCallItem } from "@openrouter/sdk/models"; - -let value: OutputCodeInterpreterCallItem = { - code: "print(\"hello\")", - containerId: "ctr-xyz789", - id: "ci-abc123", - outputs: [ - { - logs: "hello\n", - type: "logs", - }, - ], - status: "completed", - type: "code_interpreter_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `code` | *string* | :heavy_check_mark: | N/A | | -| `containerId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `outputs` | *models.OutputCodeInterpreterCallItemOutputUnion*[] | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeCodeInterpreterCall](/client-sdks/typescript/api-reference/models/typecodeinterpretercall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx b/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx deleted file mode 100644 index 72b548d3..00000000 --- a/client-sdks/typescript/api-reference/models/outputcodeinterpretercallitemoutputunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputCodeInterpreterCallItemOutputUnion - TypeScript SDK -sidebarTitle: OutputCodeInterpreterCallItemOutputUnion -description: OutputCodeInterpreterCallItemOutputUnion type definition -seoTitle: OutputCodeInterpreterCallItemOutputUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcodeinterpretercallitemoutputunion -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterCallItemOutputUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCodeInterpreterCallItemOutputUnion type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterCallItemOutputUnion%20-%20TypeScript%20SDK&description=OutputCodeInterpreterCallItemOutputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputImage` - -```typescript lines -const value: models.OutputImage = { - type: "image", - url: "https://circular-epic.info/", -}; -``` - -### `models.OutputLogs` - -```typescript lines -const value: models.OutputLogs = { - logs: "", - type: "logs", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitem.mdx deleted file mode 100644 index fda521f2..00000000 --- a/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItem - TypeScript SDK -sidebarTitle: OutputCodeInterpreterServerToolItem -description: OutputCodeInterpreterServerToolItem type definition -seoTitle: OutputCodeInterpreterServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCodeInterpreterServerToolItem type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItem%20-%20TypeScript%20SDK&description=OutputCodeInterpreterServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:code_interpreter server tool output item - -## Example Usage - -```typescript lines -import { OutputCodeInterpreterServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputCodeInterpreterServerToolItem = { - status: "completed", - type: "openrouter:code_interpreter", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `code` | *string* | :heavy_minus_sign: | N/A | | -| `exitCode` | *number* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `language` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `stderr` | *string* | :heavy_minus_sign: | N/A | | -| `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputCodeInterpreterServerToolItemType](/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx deleted file mode 100644 index 4bdf2cf4..00000000 --- a/client-sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputCodeInterpreterServerToolItemType - TypeScript SDK -sidebarTitle: OutputCodeInterpreterServerToolItemType -description: OutputCodeInterpreterServerToolItemType type definition -seoTitle: OutputCodeInterpreterServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcodeinterpreterservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCodeInterpreterServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCodeInterpreterServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCodeInterpreterServerToolItemType%20-%20TypeScript%20SDK&description=OutputCodeInterpreterServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputCodeInterpreterServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputCodeInterpreterServerToolItemType = - "openrouter:code_interpreter"; -``` - -## Values - -```typescript lines -"openrouter:code_interpreter" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcomputercallitem.mdx b/client-sdks/typescript/api-reference/models/outputcomputercallitem.mdx deleted file mode 100644 index d7c2b178..00000000 --- a/client-sdks/typescript/api-reference/models/outputcomputercallitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OutputComputerCallItem - TypeScript SDK -sidebarTitle: OutputComputerCallItem -description: OutputComputerCallItem type definition -seoTitle: OutputComputerCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcomputercallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputComputerCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItem%20-%20TypeScript%20SDK&description=OutputComputerCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputComputerCallItem } from "@openrouter/sdk/models"; - -let value: OutputComputerCallItem = { - callId: "call-abc123", - pendingSafetyChecks: [], - status: "completed", - type: "computer_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `action` | *any* | :heavy_minus_sign: | N/A | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `pendingSafetyChecks` | [models.PendingSafetyCheck](/client-sdks/typescript/api-reference/models/pendingsafetycheck)[] | :heavy_check_mark: | N/A | -| `status` | [models.OutputComputerCallItemStatus](/client-sdks/typescript/api-reference/models/outputcomputercallitemstatus) | :heavy_check_mark: | N/A | -| `type` | [models.OutputComputerCallItemType](/client-sdks/typescript/api-reference/models/outputcomputercallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcomputercallitemstatus.mdx b/client-sdks/typescript/api-reference/models/outputcomputercallitemstatus.mdx deleted file mode 100644 index 94e5da08..00000000 --- a/client-sdks/typescript/api-reference/models/outputcomputercallitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputComputerCallItemStatus - TypeScript SDK -sidebarTitle: OutputComputerCallItemStatus -description: OutputComputerCallItemStatus type definition -seoTitle: OutputComputerCallItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcomputercallitemstatus -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - OutputComputerCallItemStatus type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemStatus%20-%20TypeScript%20SDK&description=OutputComputerCallItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputComputerCallItemStatus } from "@openrouter/sdk/models"; - -let value: OutputComputerCallItemStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"completed" | "incomplete" | "in_progress" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcomputercallitemtype.mdx b/client-sdks/typescript/api-reference/models/outputcomputercallitemtype.mdx deleted file mode 100644 index f1c246a6..00000000 --- a/client-sdks/typescript/api-reference/models/outputcomputercallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputComputerCallItemType - TypeScript SDK -sidebarTitle: OutputComputerCallItemType -description: OutputComputerCallItemType type definition -seoTitle: OutputComputerCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcomputercallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputComputerCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputComputerCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputComputerCallItemType%20-%20TypeScript%20SDK&description=OutputComputerCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputComputerCallItemType } from "@openrouter/sdk/models"; - -let value: OutputComputerCallItemType = "computer_call"; -``` - -## Values - -```typescript lines -"computer_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcustomtoolcallitem.mdx b/client-sdks/typescript/api-reference/models/outputcustomtoolcallitem.mdx deleted file mode 100644 index b554f71e..00000000 --- a/client-sdks/typescript/api-reference/models/outputcustomtoolcallitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputCustomToolCallItem - TypeScript SDK -sidebarTitle: OutputCustomToolCallItem -description: OutputCustomToolCallItem type definition -seoTitle: OutputCustomToolCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcustomtoolcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCustomToolCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItem%20-%20TypeScript%20SDK&description=OutputCustomToolCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A call to a custom (freeform-grammar) tool created by the model — distinct from `function_call`. Used for tools like Codex CLI's `apply_patch` whose payload is opaque text rather than JSON arguments. - -## Example Usage - -```typescript lines -import { OutputCustomToolCallItem } from "@openrouter/sdk/models"; - -let value: OutputCustomToolCallItem = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `input` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `type` | [models.OutputCustomToolCallItemType](/client-sdks/typescript/api-reference/models/outputcustomtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputcustomtoolcallitemtype.mdx b/client-sdks/typescript/api-reference/models/outputcustomtoolcallitemtype.mdx deleted file mode 100644 index 734d4d12..00000000 --- a/client-sdks/typescript/api-reference/models/outputcustomtoolcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputCustomToolCallItemType - TypeScript SDK -sidebarTitle: OutputCustomToolCallItemType -description: OutputCustomToolCallItemType type definition -seoTitle: OutputCustomToolCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputcustomtoolcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputCustomToolCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputCustomToolCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputCustomToolCallItemType%20-%20TypeScript%20SDK&description=OutputCustomToolCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputCustomToolCallItemType } from "@openrouter/sdk/models"; - -let value: OutputCustomToolCallItemType = "custom_tool_call"; -``` - -## Values - -```typescript lines -"custom_tool_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputdatetimeitem.mdx b/client-sdks/typescript/api-reference/models/outputdatetimeitem.mdx deleted file mode 100644 index aefdb4e2..00000000 --- a/client-sdks/typescript/api-reference/models/outputdatetimeitem.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OutputDatetimeItem - TypeScript SDK -sidebarTitle: OutputDatetimeItem -description: OutputDatetimeItem type definition -seoTitle: OutputDatetimeItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputdatetimeitem -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputDatetimeItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItem%20-%20TypeScript%20SDK&description=OutputDatetimeItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:datetime server tool output item - -## Example Usage - -```typescript lines -import { OutputDatetimeItem } from "@openrouter/sdk/models"; - -let value: OutputDatetimeItem = { - datetime: "2026-03-12T14:30:00.000Z", - status: "completed", - timezone: "UTC", - type: "openrouter:datetime", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `datetime` | *string* | :heavy_check_mark: | ISO 8601 datetime string | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `timezone` | *string* | :heavy_check_mark: | IANA timezone name | | -| `type` | [models.OutputDatetimeItemType](/client-sdks/typescript/api-reference/models/outputdatetimeitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputdatetimeitemtype.mdx b/client-sdks/typescript/api-reference/models/outputdatetimeitemtype.mdx deleted file mode 100644 index 70ad5aef..00000000 --- a/client-sdks/typescript/api-reference/models/outputdatetimeitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputDatetimeItemType - TypeScript SDK -sidebarTitle: OutputDatetimeItemType -description: OutputDatetimeItemType type definition -seoTitle: OutputDatetimeItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputdatetimeitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputDatetimeItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputDatetimeItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputDatetimeItemType%20-%20TypeScript%20SDK&description=OutputDatetimeItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputDatetimeItemType } from "@openrouter/sdk/models"; - -let value: OutputDatetimeItemType = "openrouter:datetime"; -``` - -## Values - -```typescript lines -"openrouter:datetime" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfilesearchcallitem.mdx b/client-sdks/typescript/api-reference/models/outputfilesearchcallitem.mdx deleted file mode 100644 index 4958a637..00000000 --- a/client-sdks/typescript/api-reference/models/outputfilesearchcallitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OutputFileSearchCallItem - TypeScript SDK -sidebarTitle: OutputFileSearchCallItem -description: OutputFileSearchCallItem type definition -seoTitle: OutputFileSearchCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfilesearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFileSearchCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItem%20-%20TypeScript%20SDK&description=OutputFileSearchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFileSearchCallItem } from "@openrouter/sdk/models"; - -let value: OutputFileSearchCallItem = { - id: "fs-abc123", - queries: [ - "search term", - ], - status: "completed", - type: "file_search_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `queries` | *string*[] | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](/client-sdks/typescript/api-reference/models/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchCallItemType](/client-sdks/typescript/api-reference/models/outputfilesearchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfilesearchcallitemtype.mdx b/client-sdks/typescript/api-reference/models/outputfilesearchcallitemtype.mdx deleted file mode 100644 index 4007bcfa..00000000 --- a/client-sdks/typescript/api-reference/models/outputfilesearchcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFileSearchCallItemType - TypeScript SDK -sidebarTitle: OutputFileSearchCallItemType -description: OutputFileSearchCallItemType type definition -seoTitle: OutputFileSearchCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfilesearchcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFileSearchCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchCallItemType%20-%20TypeScript%20SDK&description=OutputFileSearchCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFileSearchCallItemType } from "@openrouter/sdk/models"; - -let value: OutputFileSearchCallItemType = "file_search_call"; -``` - -## Values - -```typescript lines -"file_search_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitem.mdx deleted file mode 100644 index 2d30f4e4..00000000 --- a/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitem.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputFileSearchServerToolItem - TypeScript SDK -sidebarTitle: OutputFileSearchServerToolItem -description: OutputFileSearchServerToolItem type definition -seoTitle: OutputFileSearchServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfilesearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFileSearchServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItem%20-%20TypeScript%20SDK&description=OutputFileSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:file_search server tool output item - -## Example Usage - -```typescript lines -import { OutputFileSearchServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputFileSearchServerToolItem = { - status: "completed", - type: "openrouter:file_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `queries` | *string*[] | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchServerToolItemType](/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitemtype.mdx deleted file mode 100644 index d975df07..00000000 --- a/client-sdks/typescript/api-reference/models/outputfilesearchservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFileSearchServerToolItemType - TypeScript SDK -sidebarTitle: OutputFileSearchServerToolItemType -description: OutputFileSearchServerToolItemType type definition -seoTitle: OutputFileSearchServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfilesearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFileSearchServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFileSearchServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFileSearchServerToolItemType%20-%20TypeScript%20SDK&description=OutputFileSearchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFileSearchServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputFileSearchServerToolItemType = "openrouter:file_search"; -``` - -## Values - -```typescript lines -"openrouter:file_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputformat.mdx b/client-sdks/typescript/api-reference/models/outputformat.mdx deleted file mode 100644 index d35ce4f5..00000000 --- a/client-sdks/typescript/api-reference/models/outputformat.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputFormat - TypeScript SDK -sidebarTitle: OutputFormat -description: OutputFormat type definition -seoTitle: OutputFormat Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputformat' -'og:site_name': OpenRouter Documentation -'og:title': OutputFormat Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFormat type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFormat%20-%20TypeScript%20SDK&description=OutputFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFormat } from "@openrouter/sdk/models"; - -let value: OutputFormat = "png"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"png" | "webp" | "jpeg" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitem.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitem.mdx deleted file mode 100644 index 697323a4..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitem.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OutputFunctionCallItem - TypeScript SDK -sidebarTitle: OutputFunctionCallItem -description: OutputFunctionCallItem type definition -seoTitle: OutputFunctionCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItem%20-%20TypeScript%20SDK&description=OutputFunctionCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFunctionCallItem } from "@openrouter/sdk/models"; - -let value: OutputFunctionCallItem = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | -| `status` | *models.OutputFunctionCallItemStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | [models.OutputFunctionCallItemType](/client-sdks/typescript/api-reference/models/outputfunctioncallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatuscompleted.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatuscompleted.mdx deleted file mode 100644 index 0f9c699a..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFunctionCallItemStatusCompleted - TypeScript SDK -sidebarTitle: OutputFunctionCallItemStatusCompleted -description: OutputFunctionCallItemStatusCompleted type definition -seoTitle: OutputFunctionCallItemStatusCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItemStatusCompleted type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusCompleted%20-%20TypeScript%20SDK&description=OutputFunctionCallItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFunctionCallItemStatusCompleted } from "@openrouter/sdk/models"; - -let value: OutputFunctionCallItemStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusincomplete.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusincomplete.mdx deleted file mode 100644 index e8a6b53b..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFunctionCallItemStatusIncomplete - TypeScript SDK -sidebarTitle: OutputFunctionCallItemStatusIncomplete -description: OutputFunctionCallItemStatusIncomplete type definition -seoTitle: OutputFunctionCallItemStatusIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItemStatusIncomplete type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusIncomplete%20-%20TypeScript%20SDK&description=OutputFunctionCallItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFunctionCallItemStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OutputFunctionCallItemStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusinprogress.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusinprogress.mdx deleted file mode 100644 index 4380b0f0..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFunctionCallItemStatusInProgress - TypeScript SDK -sidebarTitle: OutputFunctionCallItemStatusInProgress -description: OutputFunctionCallItemStatusInProgress type definition -seoTitle: OutputFunctionCallItemStatusInProgress Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusInProgress Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItemStatusInProgress type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusInProgress%20-%20TypeScript%20SDK&description=OutputFunctionCallItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFunctionCallItemStatusInProgress } from "@openrouter/sdk/models"; - -let value: OutputFunctionCallItemStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusunion.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusunion.mdx deleted file mode 100644 index b0015006..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputFunctionCallItemStatusUnion - TypeScript SDK -sidebarTitle: OutputFunctionCallItemStatusUnion -description: OutputFunctionCallItemStatusUnion type definition -seoTitle: OutputFunctionCallItemStatusUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemStatusUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItemStatusUnion type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemStatusUnion%20-%20TypeScript%20SDK&description=OutputFunctionCallItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputFunctionCallItemStatusCompleted` - -```typescript lines -const value: models.OutputFunctionCallItemStatusCompleted = "completed"; -``` - -### `models.OutputFunctionCallItemStatusIncomplete` - -```typescript lines -const value: models.OutputFunctionCallItemStatusIncomplete = "incomplete"; -``` - -### `models.OutputFunctionCallItemStatusInProgress` - -```typescript lines -const value: models.OutputFunctionCallItemStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfunctioncallitemtype.mdx b/client-sdks/typescript/api-reference/models/outputfunctioncallitemtype.mdx deleted file mode 100644 index 2b3aaf6b..00000000 --- a/client-sdks/typescript/api-reference/models/outputfunctioncallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputFunctionCallItemType - TypeScript SDK -sidebarTitle: OutputFunctionCallItemType -description: OutputFunctionCallItemType type definition -seoTitle: OutputFunctionCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfunctioncallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputFunctionCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFunctionCallItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFunctionCallItemType%20-%20TypeScript%20SDK&description=OutputFunctionCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputFunctionCallItemType } from "@openrouter/sdk/models"; - -let value: OutputFunctionCallItemType = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputfusionservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputfusionservertoolitem.mdx deleted file mode 100644 index 120e2f9f..00000000 --- a/client-sdks/typescript/api-reference/models/outputfusionservertoolitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputFusionServerToolItem - TypeScript SDK -sidebarTitle: OutputFusionServerToolItem -description: OutputFusionServerToolItem type definition -seoTitle: OutputFusionServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputfusionservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputFusionServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputFusionServerToolItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputFusionServerToolItem%20-%20TypeScript%20SDK&description=OutputFusionServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:fusion server tool output item - -## Example Usage - -```typescript lines -import { OutputFusionServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputFusionServerToolItem = { - status: "completed", - type: "openrouter:fusion", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [models.Analysis](/client-sdks/typescript/api-reference/models/analysis) | :heavy_minus_sign: | Structured analysis produced by the fusion judge model. | | -| `error` | *string* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `failedModels` | [models.FailedModel](/client-sdks/typescript/api-reference/models/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. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `responses` | [models.ResponseT](/client-sdks/typescript/api-reference/models/responset)[] | :heavy_minus_sign: | Slugs of the analysis models that produced a response in this fusion run. | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | *"openrouter:fusion"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputimage.mdx b/client-sdks/typescript/api-reference/models/outputimage.mdx deleted file mode 100644 index dceac29e..00000000 --- a/client-sdks/typescript/api-reference/models/outputimage.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OutputImage - TypeScript SDK -sidebarTitle: OutputImage -description: OutputImage type definition -seoTitle: OutputImage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputimage' -'og:site_name': OpenRouter Documentation -'og:title': OutputImage Type | OpenRouter TypeScript SDK -'og:description': >- - OutputImage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImage%20-%20TypeScript%20SDK&description=OutputImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputImage } from "@openrouter/sdk/models"; - -let value: OutputImage = { - type: "image", - url: "https://circular-epic.info/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"image"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputimagegenerationcallitem.mdx b/client-sdks/typescript/api-reference/models/outputimagegenerationcallitem.mdx deleted file mode 100644 index 8ec4f614..00000000 --- a/client-sdks/typescript/api-reference/models/outputimagegenerationcallitem.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OutputImageGenerationCallItem - TypeScript SDK -sidebarTitle: OutputImageGenerationCallItem -description: OutputImageGenerationCallItem type definition -seoTitle: OutputImageGenerationCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputimagegenerationcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputImageGenerationCallItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItem%20-%20TypeScript%20SDK&description=OutputImageGenerationCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputImageGenerationCallItem } from "@openrouter/sdk/models"; - -let value: OutputImageGenerationCallItem = { - id: "img-abc123", - status: "completed", - type: "image_generation_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](/client-sdks/typescript/api-reference/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationCallItemType](/client-sdks/typescript/api-reference/models/outputimagegenerationcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputimagegenerationcallitemtype.mdx b/client-sdks/typescript/api-reference/models/outputimagegenerationcallitemtype.mdx deleted file mode 100644 index 4462b9f1..00000000 --- a/client-sdks/typescript/api-reference/models/outputimagegenerationcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputImageGenerationCallItemType - TypeScript SDK -sidebarTitle: OutputImageGenerationCallItemType -description: OutputImageGenerationCallItemType type definition -seoTitle: OutputImageGenerationCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputimagegenerationcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputImageGenerationCallItemType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationCallItemType%20-%20TypeScript%20SDK&description=OutputImageGenerationCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputImageGenerationCallItemType } from "@openrouter/sdk/models"; - -let value: OutputImageGenerationCallItemType = "image_generation_call"; -``` - -## Values - -```typescript lines -"image_generation_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitem.mdx deleted file mode 100644 index d76a13b9..00000000 --- a/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitem.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OutputImageGenerationServerToolItem - TypeScript SDK -sidebarTitle: OutputImageGenerationServerToolItem -description: OutputImageGenerationServerToolItem type definition -seoTitle: OutputImageGenerationServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputimagegenerationservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputImageGenerationServerToolItem type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItem%20-%20TypeScript%20SDK&description=OutputImageGenerationServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:image_generation server tool output item - -## Example Usage - -```typescript lines -import { OutputImageGenerationServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputImageGenerationServerToolItem = { - status: "completed", - type: "openrouter:image_generation", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `imageB64` | *string* | :heavy_minus_sign: | N/A | | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | | -| `result` | *string* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `revisedPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationServerToolItemType](/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitemtype.mdx deleted file mode 100644 index 0ed35615..00000000 --- a/client-sdks/typescript/api-reference/models/outputimagegenerationservertoolitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputImageGenerationServerToolItemType - TypeScript SDK -sidebarTitle: OutputImageGenerationServerToolItemType -description: OutputImageGenerationServerToolItemType type definition -seoTitle: OutputImageGenerationServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputimagegenerationservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputImageGenerationServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputImageGenerationServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputImageGenerationServerToolItemType%20-%20TypeScript%20SDK&description=OutputImageGenerationServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputImageGenerationServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputImageGenerationServerToolItemType = - "openrouter:image_generation"; -``` - -## Values - -```typescript lines -"openrouter:image_generation" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputitemimagegenerationcall.mdx b/client-sdks/typescript/api-reference/models/outputitemimagegenerationcall.mdx deleted file mode 100644 index 8855df02..00000000 --- a/client-sdks/typescript/api-reference/models/outputitemimagegenerationcall.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputItemImageGenerationCall - TypeScript SDK -sidebarTitle: OutputItemImageGenerationCall -description: OutputItemImageGenerationCall type definition -seoTitle: OutputItemImageGenerationCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputitemimagegenerationcall -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCall Type | OpenRouter TypeScript SDK -'og:description': >- - OutputItemImageGenerationCall type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCall%20-%20TypeScript%20SDK&description=OutputItemImageGenerationCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputItemImageGenerationCall } from "@openrouter/sdk/models"; - -let value: OutputItemImageGenerationCall = { - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", - type: "image_generation_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](/client-sdks/typescript/api-reference/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputItemImageGenerationCallType](/client-sdks/typescript/api-reference/models/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputitemimagegenerationcalltype.mdx b/client-sdks/typescript/api-reference/models/outputitemimagegenerationcalltype.mdx deleted file mode 100644 index 78015be6..00000000 --- a/client-sdks/typescript/api-reference/models/outputitemimagegenerationcalltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputItemImageGenerationCallType - TypeScript SDK -sidebarTitle: OutputItemImageGenerationCallType -description: OutputItemImageGenerationCallType type definition -seoTitle: OutputItemImageGenerationCallType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputitemimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCallType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputItemImageGenerationCallType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCallType%20-%20TypeScript%20SDK&description=OutputItemImageGenerationCallType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputItemImageGenerationCallType } from "@openrouter/sdk/models"; - -let value: OutputItemImageGenerationCallType = "image_generation_call"; -``` - -## Values - -```typescript lines -"image_generation_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputitems.mdx b/client-sdks/typescript/api-reference/models/outputitems.mdx deleted file mode 100644 index 7e42c1bf..00000000 --- a/client-sdks/typescript/api-reference/models/outputitems.mdx +++ /dev/null @@ -1,304 +0,0 @@ ---- -title: OutputItems - TypeScript SDK -sidebarTitle: OutputItems -description: OutputItems type definition -seoTitle: OutputItems Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputitems' -'og:site_name': OpenRouter Documentation -'og:title': OutputItems Type | OpenRouter TypeScript SDK -'og:description': >- - OutputItems type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItems%20-%20TypeScript%20SDK&description=OutputItems%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output item from the response - -## Supported Types - -### `models.OutputApplyPatchCallItem` - -```typescript lines -const value: models.OutputApplyPatchCallItem = { - callId: "", - id: "msg-abc123", - operation: { - diff: "@@ function main() {\n+ console.log(\"hi\");\n }", - path: "/src/main.ts", - type: "update_file", - }, - status: "completed", - type: "apply_patch_call", -}; -``` - -### `models.OutputCodeInterpreterCallItem` - -```typescript lines -const value: models.OutputCodeInterpreterCallItem = { - code: "print(\"hello\")", - containerId: "ctr-xyz789", - id: "ci-abc123", - outputs: [ - { - logs: "hello\n", - type: "logs", - }, - ], - status: "completed", - type: "code_interpreter_call", -}; -``` - -### `models.OutputComputerCallItem` - -```typescript lines -const value: models.OutputComputerCallItem = { - callId: "call-abc123", - pendingSafetyChecks: [], - status: "completed", - type: "computer_call", -}; -``` - -### `models.OutputCustomToolCallItem` - -```typescript lines -const value: models.OutputCustomToolCallItem = { - callId: "call-abc123", - input: "*** Begin Patch\n*** End Patch", - name: "apply_patch", - type: "custom_tool_call", -}; -``` - -### `models.OutputFileSearchCallItem` - -```typescript lines -const value: models.OutputFileSearchCallItem = { - id: "fs-abc123", - queries: [ - "search term", - ], - status: "completed", - type: "file_search_call", -}; -``` - -### `models.OutputFunctionCallItem` - -```typescript lines -const value: models.OutputFunctionCallItem = { - arguments: "{\"location\":\"San Francisco\"}", - callId: "call-abc123", - name: "get_weather", - type: "function_call", -}; -``` - -### `models.OutputImageGenerationCallItem` - -```typescript lines -const value: models.OutputImageGenerationCallItem = { - id: "img-abc123", - status: "completed", - type: "image_generation_call", -}; -``` - -### `models.OutputMessageItem` - -```typescript lines -const value: models.OutputMessageItem = { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", -}; -``` - -### `models.OutputApplyPatchServerToolItem` - -```typescript lines -const value: models.OutputApplyPatchServerToolItem = { - status: "completed", - type: "openrouter:apply_patch", -}; -``` - -### `models.OutputBashServerToolItem` - -```typescript lines -const value: models.OutputBashServerToolItem = { - status: "completed", - type: "openrouter:bash", -}; -``` - -### `models.OutputBrowserUseServerToolItem` - -```typescript lines -const value: models.OutputBrowserUseServerToolItem = { - status: "completed", - type: "openrouter:browser_use", -}; -``` - -### `models.OutputCodeInterpreterServerToolItem` - -```typescript lines -const value: models.OutputCodeInterpreterServerToolItem = { - status: "completed", - type: "openrouter:code_interpreter", -}; -``` - -### `models.OutputDatetimeItem` - -```typescript lines -const value: models.OutputDatetimeItem = { - datetime: "2026-03-12T14:30:00.000Z", - status: "completed", - timezone: "UTC", - type: "openrouter:datetime", -}; -``` - -### `models.OutputSearchModelsServerToolItem` - -```typescript lines -const value: models.OutputSearchModelsServerToolItem = { - status: "completed", - type: "openrouter:experimental__search_models", -}; -``` - -### `models.OutputFileSearchServerToolItem` - -```typescript lines -const value: models.OutputFileSearchServerToolItem = { - status: "completed", - type: "openrouter:file_search", -}; -``` - -### `models.OutputFusionServerToolItem` - -```typescript lines -const value: models.OutputFusionServerToolItem = { - status: "completed", - type: "openrouter:fusion", -}; -``` - -### `models.OutputImageGenerationServerToolItem` - -```typescript lines -const value: models.OutputImageGenerationServerToolItem = { - status: "completed", - type: "openrouter:image_generation", -}; -``` - -### `models.OutputMcpServerToolItem` - -```typescript lines -const value: models.OutputMcpServerToolItem = { - status: "completed", - type: "openrouter:mcp", -}; -``` - -### `models.OutputMemoryServerToolItem` - -```typescript lines -const value: models.OutputMemoryServerToolItem = { - status: "completed", - type: "openrouter:memory", -}; -``` - -### `models.OutputTextEditorServerToolItem` - -```typescript lines -const value: models.OutputTextEditorServerToolItem = { - status: "completed", - type: "openrouter:text_editor", -}; -``` - -### `models.OutputToolSearchServerToolItem` - -```typescript lines -const value: models.OutputToolSearchServerToolItem = { - status: "completed", - type: "openrouter:tool_search", -}; -``` - -### `models.OutputWebFetchServerToolItem` - -```typescript lines -const value: models.OutputWebFetchServerToolItem = { - status: "completed", - type: "openrouter:web_fetch", -}; -``` - -### `models.OutputWebSearchServerToolItem` - -```typescript lines -const value: models.OutputWebSearchServerToolItem = { - status: "completed", - type: "openrouter:web_search", -}; -``` - -### `models.OutputReasoningItem` - -```typescript lines -const value: models.OutputReasoningItem = { - id: "msg-abc123", - summary: [ - { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -### `models.OutputWebSearchCallItem` - -```typescript lines -const value: models.OutputWebSearchCallItem = { - action: { - pattern: "", - type: "find_in_page", - url: "https://tragic-requirement.com/", - }, - id: "ws-abc123", - status: "completed", - type: "web_search_call", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputlogs.mdx b/client-sdks/typescript/api-reference/models/outputlogs.mdx deleted file mode 100644 index 6a62f93a..00000000 --- a/client-sdks/typescript/api-reference/models/outputlogs.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OutputLogs - TypeScript SDK -sidebarTitle: OutputLogs -description: OutputLogs type definition -seoTitle: OutputLogs Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputlogs' -'og:site_name': OpenRouter Documentation -'og:title': OutputLogs Type | OpenRouter TypeScript SDK -'og:description': >- - OutputLogs type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputLogs%20-%20TypeScript%20SDK&description=OutputLogs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputLogs } from "@openrouter/sdk/models"; - -let value: OutputLogs = { - logs: "", - type: "logs", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `logs` | *string* | :heavy_check_mark: | N/A | -| `type` | *"logs"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmcpservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputmcpservertoolitem.mdx deleted file mode 100644 index 481ae697..00000000 --- a/client-sdks/typescript/api-reference/models/outputmcpservertoolitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputMcpServerToolItem - TypeScript SDK -sidebarTitle: OutputMcpServerToolItem -description: OutputMcpServerToolItem type definition -seoTitle: OutputMcpServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmcpservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMcpServerToolItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItem%20-%20TypeScript%20SDK&description=OutputMcpServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:mcp server tool output item - -## Example Usage - -```typescript lines -import { OutputMcpServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputMcpServerToolItem = { - status: "completed", - type: "openrouter:mcp", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `serverLabel` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `toolName` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputMcpServerToolItemType](/client-sdks/typescript/api-reference/models/outputmcpservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmcpservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputmcpservertoolitemtype.mdx deleted file mode 100644 index 6afa775a..00000000 --- a/client-sdks/typescript/api-reference/models/outputmcpservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMcpServerToolItemType - TypeScript SDK -sidebarTitle: OutputMcpServerToolItemType -description: OutputMcpServerToolItemType type definition -seoTitle: OutputMcpServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmcpservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMcpServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMcpServerToolItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMcpServerToolItemType%20-%20TypeScript%20SDK&description=OutputMcpServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMcpServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputMcpServerToolItemType = "openrouter:mcp"; -``` - -## Values - -```typescript lines -"openrouter:mcp" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmemoryservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputmemoryservertoolitem.mdx deleted file mode 100644 index 7695f9f1..00000000 --- a/client-sdks/typescript/api-reference/models/outputmemoryservertoolitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OutputMemoryServerToolItem - TypeScript SDK -sidebarTitle: OutputMemoryServerToolItem -description: OutputMemoryServerToolItem type definition -seoTitle: OutputMemoryServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmemoryservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMemoryServerToolItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItem%20-%20TypeScript%20SDK&description=OutputMemoryServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:memory server tool output item - -## Example Usage - -```typescript lines -import { OutputMemoryServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputMemoryServerToolItem = { - status: "completed", - type: "openrouter:memory", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `action` | [models.ActionEnum](/client-sdks/typescript/api-reference/models/actionenum) | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `key` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputMemoryServerToolItemType](/client-sdks/typescript/api-reference/models/outputmemoryservertoolitemtype) | :heavy_check_mark: | N/A | | -| `value` | *any* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmemoryservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputmemoryservertoolitemtype.mdx deleted file mode 100644 index 1f9ac06a..00000000 --- a/client-sdks/typescript/api-reference/models/outputmemoryservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMemoryServerToolItemType - TypeScript SDK -sidebarTitle: OutputMemoryServerToolItemType -description: OutputMemoryServerToolItemType type definition -seoTitle: OutputMemoryServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmemoryservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputMemoryServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMemoryServerToolItemType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMemoryServerToolItemType%20-%20TypeScript%20SDK&description=OutputMemoryServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMemoryServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputMemoryServerToolItemType = "openrouter:memory"; -``` - -## Values - -```typescript lines -"openrouter:memory" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessage.mdx b/client-sdks/typescript/api-reference/models/outputmessage.mdx deleted file mode 100644 index a3f77c89..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessage.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OutputMessage - TypeScript SDK -sidebarTitle: OutputMessage -description: OutputMessage type definition -seoTitle: OutputMessage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputmessage' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessage Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessage%20-%20TypeScript%20SDK&description=OutputMessage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessage } from "@openrouter/sdk/models"; - -let value: OutputMessage = { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.OutputMessageContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.OutputMessagePhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.OutputMessageRole](/client-sdks/typescript/api-reference/models/outputmessagerole) | :heavy_check_mark: | N/A | -| `status` | *models.OutputMessageStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | [models.OutputMessageType](/client-sdks/typescript/api-reference/models/outputmessagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagecontent.mdx b/client-sdks/typescript/api-reference/models/outputmessagecontent.mdx deleted file mode 100644 index ba4103c1..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagecontent.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageContent - TypeScript SDK -sidebarTitle: OutputMessageContent -description: OutputMessageContent type definition -seoTitle: OutputMessageContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageContent Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageContent%20-%20TypeScript%20SDK&description=OutputMessageContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitem.mdx b/client-sdks/typescript/api-reference/models/outputmessageitem.mdx deleted file mode 100644 index ecb1c120..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitem.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OutputMessageItem - TypeScript SDK -sidebarTitle: OutputMessageItem -description: OutputMessageItem type definition -seoTitle: OutputMessageItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItem%20-%20TypeScript%20SDK&description=OutputMessageItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output message item - -## Example Usage - -```typescript lines -import { OutputMessageItem } from "@openrouter/sdk/models"; - -let value: OutputMessageItem = { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.OutputMessageItemContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.OutputMessageItemPhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.OutputMessageItemRole](/client-sdks/typescript/api-reference/models/outputmessageitemrole) | :heavy_check_mark: | N/A | -| `status` | *models.OutputMessageItemStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | *"message"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemcontent.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemcontent.mdx deleted file mode 100644 index afac1e7c..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemcontent.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageItemContent - TypeScript SDK -sidebarTitle: OutputMessageItemContent -description: OutputMessageItemContent type definition -seoTitle: OutputMessageItemContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemcontent -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemContent Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemContent%20-%20TypeScript%20SDK&description=OutputMessageItemContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - refusal: "I'm sorry, I cannot assist with that request", - type: "refusal", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemphasecommentary.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemphasecommentary.mdx deleted file mode 100644 index b3535534..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemphasecommentary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemPhaseCommentary - TypeScript SDK -sidebarTitle: OutputMessageItemPhaseCommentary -description: OutputMessageItemPhaseCommentary type definition -seoTitle: OutputMessageItemPhaseCommentary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemphasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseCommentary Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemPhaseCommentary type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseCommentary%20-%20TypeScript%20SDK&description=OutputMessageItemPhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemPhaseCommentary } from "@openrouter/sdk/models"; - -let value: OutputMessageItemPhaseCommentary = "commentary"; -``` - -## Values - -```typescript lines -"commentary" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemphasefinalanswer.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemphasefinalanswer.mdx deleted file mode 100644 index e0037075..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemphasefinalanswer.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemPhaseFinalAnswer - TypeScript SDK -sidebarTitle: OutputMessageItemPhaseFinalAnswer -description: OutputMessageItemPhaseFinalAnswer type definition -seoTitle: OutputMessageItemPhaseFinalAnswer Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemphasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseFinalAnswer Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemPhaseFinalAnswer type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseFinalAnswer%20-%20TypeScript%20SDK&description=OutputMessageItemPhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemPhaseFinalAnswer } from "@openrouter/sdk/models"; - -let value: OutputMessageItemPhaseFinalAnswer = "final_answer"; -``` - -## Values - -```typescript lines -"final_answer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemphaseunion.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemphaseunion.mdx deleted file mode 100644 index 845910e9..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemphaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputMessageItemPhaseUnion - TypeScript SDK -sidebarTitle: OutputMessageItemPhaseUnion -description: OutputMessageItemPhaseUnion type definition -seoTitle: OutputMessageItemPhaseUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemphaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemPhaseUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemPhaseUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemPhaseUnion%20-%20TypeScript%20SDK&description=OutputMessageItemPhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `models.OutputMessageItemPhaseCommentary` - -```typescript lines -const value: models.OutputMessageItemPhaseCommentary = "commentary"; -``` - -### `models.OutputMessageItemPhaseFinalAnswer` - -```typescript lines -const value: models.OutputMessageItemPhaseFinalAnswer = "final_answer"; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemrole.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemrole.mdx deleted file mode 100644 index 1c4f3e42..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemrole.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemRole - TypeScript SDK -sidebarTitle: OutputMessageItemRole -description: OutputMessageItemRole type definition -seoTitle: OutputMessageItemRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemrole -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemRole Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemRole type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemRole%20-%20TypeScript%20SDK&description=OutputMessageItemRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemRole } from "@openrouter/sdk/models"; - -let value: OutputMessageItemRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemstatuscompleted.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemstatuscompleted.mdx deleted file mode 100644 index 5b2ae7f7..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemStatusCompleted - TypeScript SDK -sidebarTitle: OutputMessageItemStatusCompleted -description: OutputMessageItemStatusCompleted type definition -seoTitle: OutputMessageItemStatusCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemStatusCompleted type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusCompleted%20-%20TypeScript%20SDK&description=OutputMessageItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemStatusCompleted } from "@openrouter/sdk/models"; - -let value: OutputMessageItemStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemstatusincomplete.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemstatusincomplete.mdx deleted file mode 100644 index 61cc672c..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemStatusIncomplete - TypeScript SDK -sidebarTitle: OutputMessageItemStatusIncomplete -description: OutputMessageItemStatusIncomplete type definition -seoTitle: OutputMessageItemStatusIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemStatusIncomplete type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusIncomplete%20-%20TypeScript%20SDK&description=OutputMessageItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OutputMessageItemStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemstatusinprogress.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemstatusinprogress.mdx deleted file mode 100644 index 38e9c23d..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageItemStatusInProgress - TypeScript SDK -sidebarTitle: OutputMessageItemStatusInProgress -description: OutputMessageItemStatusInProgress type definition -seoTitle: OutputMessageItemStatusInProgress Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusInProgress Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemStatusInProgress type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusInProgress%20-%20TypeScript%20SDK&description=OutputMessageItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageItemStatusInProgress } from "@openrouter/sdk/models"; - -let value: OutputMessageItemStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessageitemstatusunion.mdx b/client-sdks/typescript/api-reference/models/outputmessageitemstatusunion.mdx deleted file mode 100644 index a8238275..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessageitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageItemStatusUnion - TypeScript SDK -sidebarTitle: OutputMessageItemStatusUnion -description: OutputMessageItemStatusUnion type definition -seoTitle: OutputMessageItemStatusUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessageitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageItemStatusUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageItemStatusUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageItemStatusUnion%20-%20TypeScript%20SDK&description=OutputMessageItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputMessageItemStatusCompleted` - -```typescript lines -const value: models.OutputMessageItemStatusCompleted = "completed"; -``` - -### `models.OutputMessageItemStatusIncomplete` - -```typescript lines -const value: models.OutputMessageItemStatusIncomplete = "incomplete"; -``` - -### `models.OutputMessageItemStatusInProgress` - -```typescript lines -const value: models.OutputMessageItemStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagephasecommentary.mdx b/client-sdks/typescript/api-reference/models/outputmessagephasecommentary.mdx deleted file mode 100644 index 7863bc08..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagephasecommentary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessagePhaseCommentary - TypeScript SDK -sidebarTitle: OutputMessagePhaseCommentary -description: OutputMessagePhaseCommentary type definition -seoTitle: OutputMessagePhaseCommentary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagephasecommentary -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseCommentary Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessagePhaseCommentary type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseCommentary%20-%20TypeScript%20SDK&description=OutputMessagePhaseCommentary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessagePhaseCommentary } from "@openrouter/sdk/models"; - -let value: OutputMessagePhaseCommentary = "commentary"; -``` - -## Values - -```typescript lines -"commentary" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagephasefinalanswer.mdx b/client-sdks/typescript/api-reference/models/outputmessagephasefinalanswer.mdx deleted file mode 100644 index 2e47ea4b..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagephasefinalanswer.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessagePhaseFinalAnswer - TypeScript SDK -sidebarTitle: OutputMessagePhaseFinalAnswer -description: OutputMessagePhaseFinalAnswer type definition -seoTitle: OutputMessagePhaseFinalAnswer Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagephasefinalanswer -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseFinalAnswer Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessagePhaseFinalAnswer type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseFinalAnswer%20-%20TypeScript%20SDK&description=OutputMessagePhaseFinalAnswer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessagePhaseFinalAnswer } from "@openrouter/sdk/models"; - -let value: OutputMessagePhaseFinalAnswer = "final_answer"; -``` - -## Values - -```typescript lines -"final_answer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagephaseunion.mdx b/client-sdks/typescript/api-reference/models/outputmessagephaseunion.mdx deleted file mode 100644 index 20cf9e89..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagephaseunion.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputMessagePhaseUnion - TypeScript SDK -sidebarTitle: OutputMessagePhaseUnion -description: OutputMessagePhaseUnion type definition -seoTitle: OutputMessagePhaseUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagephaseunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessagePhaseUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessagePhaseUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessagePhaseUnion%20-%20TypeScript%20SDK&description=OutputMessagePhaseUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `models.OutputMessagePhaseCommentary` - -```typescript lines -const value: models.OutputMessagePhaseCommentary = "commentary"; -``` - -### `models.OutputMessagePhaseFinalAnswer` - -```typescript lines -const value: models.OutputMessagePhaseFinalAnswer = "final_answer"; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagerole.mdx b/client-sdks/typescript/api-reference/models/outputmessagerole.mdx deleted file mode 100644 index f12a6a2c..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagerole.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageRole - TypeScript SDK -sidebarTitle: OutputMessageRole -description: OutputMessageRole type definition -seoTitle: OutputMessageRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagerole -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageRole Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageRole type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageRole%20-%20TypeScript%20SDK&description=OutputMessageRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageRole } from "@openrouter/sdk/models"; - -let value: OutputMessageRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagestatuscompleted.mdx b/client-sdks/typescript/api-reference/models/outputmessagestatuscompleted.mdx deleted file mode 100644 index 903f9ac0..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagestatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageStatusCompleted - TypeScript SDK -sidebarTitle: OutputMessageStatusCompleted -description: OutputMessageStatusCompleted type definition -seoTitle: OutputMessageStatusCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagestatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusCompleted type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusCompleted%20-%20TypeScript%20SDK&description=OutputMessageStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusCompleted } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagestatusincomplete.mdx b/client-sdks/typescript/api-reference/models/outputmessagestatusincomplete.mdx deleted file mode 100644 index 56f8229f..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagestatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageStatusIncomplete - TypeScript SDK -sidebarTitle: OutputMessageStatusIncomplete -description: OutputMessageStatusIncomplete type definition -seoTitle: OutputMessageStatusIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusIncomplete type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusIncomplete%20-%20TypeScript%20SDK&description=OutputMessageStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagestatusinprogress.mdx b/client-sdks/typescript/api-reference/models/outputmessagestatusinprogress.mdx deleted file mode 100644 index b1691379..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagestatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageStatusInProgress - TypeScript SDK -sidebarTitle: OutputMessageStatusInProgress -description: OutputMessageStatusInProgress type definition -seoTitle: OutputMessageStatusInProgress Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusInProgress Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusInProgress type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusInProgress%20-%20TypeScript%20SDK&description=OutputMessageStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusInProgress } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagestatusunion.mdx b/client-sdks/typescript/api-reference/models/outputmessagestatusunion.mdx deleted file mode 100644 index 52fa3352..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagestatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputMessageStatusUnion - TypeScript SDK -sidebarTitle: OutputMessageStatusUnion -description: OutputMessageStatusUnion type definition -seoTitle: OutputMessageStatusUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagestatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusUnion%20-%20TypeScript%20SDK&description=OutputMessageStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputMessageStatusCompleted` - -```typescript lines -const value: models.OutputMessageStatusCompleted = "completed"; -``` - -### `models.OutputMessageStatusIncomplete` - -```typescript lines -const value: models.OutputMessageStatusIncomplete = "incomplete"; -``` - -### `models.OutputMessageStatusInProgress` - -```typescript lines -const value: models.OutputMessageStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmessagetype.mdx b/client-sdks/typescript/api-reference/models/outputmessagetype.mdx deleted file mode 100644 index a0f738b7..00000000 --- a/client-sdks/typescript/api-reference/models/outputmessagetype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputMessageType - TypeScript SDK -sidebarTitle: OutputMessageType -description: OutputMessageType type definition -seoTitle: OutputMessageType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmessagetype -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageType%20-%20TypeScript%20SDK&description=OutputMessageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageType } from "@openrouter/sdk/models"; - -let value: OutputMessageType = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmodality.mdx b/client-sdks/typescript/api-reference/models/outputmodality.mdx deleted file mode 100644 index e4f54242..00000000 --- a/client-sdks/typescript/api-reference/models/outputmodality.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputModality - TypeScript SDK -sidebarTitle: OutputModality -description: OutputModality type definition -seoTitle: OutputModality Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/outputmodality' -'og:site_name': OpenRouter Documentation -'og:title': OutputModality Type | OpenRouter TypeScript SDK -'og:description': >- - OutputModality type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModality%20-%20TypeScript%20SDK&description=OutputModality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputModality } from "@openrouter/sdk/models"; - -let value: OutputModality = "text"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"text" | "image" | "embeddings" | "audio" | "video" | "rerank" | "speech" | "transcription" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputmodalityenum.mdx b/client-sdks/typescript/api-reference/models/outputmodalityenum.mdx deleted file mode 100644 index eb62a7ee..00000000 --- a/client-sdks/typescript/api-reference/models/outputmodalityenum.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputModalityEnum - TypeScript SDK -sidebarTitle: OutputModalityEnum -description: OutputModalityEnum type definition -seoTitle: OutputModalityEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputmodalityenum -'og:site_name': OpenRouter Documentation -'og:title': OutputModalityEnum Type | OpenRouter TypeScript SDK -'og:description': >- - OutputModalityEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModalityEnum%20-%20TypeScript%20SDK&description=OutputModalityEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputModalityEnum } from "@openrouter/sdk/models"; - -let value: OutputModalityEnum = "text"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"text" | "image" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputreasoningitem.mdx b/client-sdks/typescript/api-reference/models/outputreasoningitem.mdx deleted file mode 100644 index 72765bef..00000000 --- a/client-sdks/typescript/api-reference/models/outputreasoningitem.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: OutputReasoningItem - TypeScript SDK -sidebarTitle: OutputReasoningItem -description: OutputReasoningItem type definition -seoTitle: OutputReasoningItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputreasoningitem -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputReasoningItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItem%20-%20TypeScript%20SDK&description=OutputReasoningItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Example Usage - -```typescript lines -import { OutputReasoningItem } from "@openrouter/sdk/models"; - -let value: OutputReasoningItem = { - id: "msg-abc123", - summary: [ - { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](/client-sdks/typescript/api-reference/models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.OutputReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](/client-sdks/typescript/api-reference/models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | -| `type` | *"reasoning"* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputreasoningitemstatuscompleted.mdx b/client-sdks/typescript/api-reference/models/outputreasoningitemstatuscompleted.mdx deleted file mode 100644 index 68f809e5..00000000 --- a/client-sdks/typescript/api-reference/models/outputreasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputReasoningItemStatusCompleted - TypeScript SDK -sidebarTitle: OutputReasoningItemStatusCompleted -description: OutputReasoningItemStatusCompleted type definition -seoTitle: OutputReasoningItemStatusCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputreasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - OutputReasoningItemStatusCompleted type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusCompleted%20-%20TypeScript%20SDK&description=OutputReasoningItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputReasoningItemStatusCompleted } from "@openrouter/sdk/models"; - -let value: OutputReasoningItemStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusincomplete.mdx b/client-sdks/typescript/api-reference/models/outputreasoningitemstatusincomplete.mdx deleted file mode 100644 index a02901ce..00000000 --- a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputReasoningItemStatusIncomplete - TypeScript SDK -sidebarTitle: OutputReasoningItemStatusIncomplete -description: OutputReasoningItemStatusIncomplete type definition -seoTitle: OutputReasoningItemStatusIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputreasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - OutputReasoningItemStatusIncomplete type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusIncomplete%20-%20TypeScript%20SDK&description=OutputReasoningItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputReasoningItemStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OutputReasoningItemStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusinprogress.mdx b/client-sdks/typescript/api-reference/models/outputreasoningitemstatusinprogress.mdx deleted file mode 100644 index 1ddd16a6..00000000 --- a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputReasoningItemStatusInProgress - TypeScript SDK -sidebarTitle: OutputReasoningItemStatusInProgress -description: OutputReasoningItemStatusInProgress type definition -seoTitle: OutputReasoningItemStatusInProgress Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputreasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusInProgress Type | OpenRouter TypeScript SDK -'og:description': >- - OutputReasoningItemStatusInProgress type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusInProgress%20-%20TypeScript%20SDK&description=OutputReasoningItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputReasoningItemStatusInProgress } from "@openrouter/sdk/models"; - -let value: OutputReasoningItemStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusunion.mdx b/client-sdks/typescript/api-reference/models/outputreasoningitemstatusunion.mdx deleted file mode 100644 index 273143e0..00000000 --- a/client-sdks/typescript/api-reference/models/outputreasoningitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputReasoningItemStatusUnion - TypeScript SDK -sidebarTitle: OutputReasoningItemStatusUnion -description: OutputReasoningItemStatusUnion type definition -seoTitle: OutputReasoningItemStatusUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputreasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OutputReasoningItemStatusUnion Type | OpenRouter TypeScript SDK -'og:description': >- - OutputReasoningItemStatusUnion type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputReasoningItemStatusUnion%20-%20TypeScript%20SDK&description=OutputReasoningItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputReasoningItemStatusCompleted` - -```typescript lines -const value: models.OutputReasoningItemStatusCompleted = "completed"; -``` - -### `models.OutputReasoningItemStatusIncomplete` - -```typescript lines -const value: models.OutputReasoningItemStatusIncomplete = "incomplete"; -``` - -### `models.OutputReasoningItemStatusInProgress` - -```typescript lines -const value: models.OutputReasoningItemStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitem.mdx deleted file mode 100644 index 4efc676e..00000000 --- a/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputSearchModelsServerToolItem - TypeScript SDK -sidebarTitle: OutputSearchModelsServerToolItem -description: OutputSearchModelsServerToolItem type definition -seoTitle: OutputSearchModelsServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputsearchmodelsservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputSearchModelsServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItem%20-%20TypeScript%20SDK&description=OutputSearchModelsServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:experimental__search_models server tool output item - -## Example Usage - -```typescript lines -import { OutputSearchModelsServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputSearchModelsServerToolItem = { - status: "completed", - type: "openrouter:experimental__search_models", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `arguments` | *string* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. `{"query":"Claude"}`) | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputSearchModelsServerToolItemType](/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitemtype.mdx deleted file mode 100644 index a2207002..00000000 --- a/client-sdks/typescript/api-reference/models/outputsearchmodelsservertoolitemtype.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OutputSearchModelsServerToolItemType - TypeScript SDK -sidebarTitle: OutputSearchModelsServerToolItemType -description: OutputSearchModelsServerToolItemType type definition -seoTitle: OutputSearchModelsServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputsearchmodelsservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputSearchModelsServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputSearchModelsServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputSearchModelsServerToolItemType%20-%20TypeScript%20SDK&description=OutputSearchModelsServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputSearchModelsServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputSearchModelsServerToolItemType = - "openrouter:experimental__search_models"; -``` - -## Values - -```typescript lines -"openrouter:experimental__search_models" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitem.mdx deleted file mode 100644 index 3f0f206c..00000000 --- a/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitem.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OutputTextEditorServerToolItem - TypeScript SDK -sidebarTitle: OutputTextEditorServerToolItem -description: OutputTextEditorServerToolItem type definition -seoTitle: OutputTextEditorServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputtexteditorservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputTextEditorServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItem%20-%20TypeScript%20SDK&description=OutputTextEditorServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:text_editor server tool output item - -## Example Usage - -```typescript lines -import { OutputTextEditorServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputTextEditorServerToolItem = { - status: "completed", - type: "openrouter:text_editor", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `command` | [models.Command](/client-sdks/typescript/api-reference/models/command) | :heavy_minus_sign: | N/A | | -| `filePath` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputTextEditorServerToolItemType](/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitemtype.mdx deleted file mode 100644 index 018c9d86..00000000 --- a/client-sdks/typescript/api-reference/models/outputtexteditorservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputTextEditorServerToolItemType - TypeScript SDK -sidebarTitle: OutputTextEditorServerToolItemType -description: OutputTextEditorServerToolItemType type definition -seoTitle: OutputTextEditorServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputtexteditorservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputTextEditorServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputTextEditorServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTextEditorServerToolItemType%20-%20TypeScript%20SDK&description=OutputTextEditorServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputTextEditorServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputTextEditorServerToolItemType = "openrouter:text_editor"; -``` - -## Values - -```typescript lines -"openrouter:text_editor" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputtokensdetails.mdx b/client-sdks/typescript/api-reference/models/outputtokensdetails.mdx deleted file mode 100644 index fa41c46e..00000000 --- a/client-sdks/typescript/api-reference/models/outputtokensdetails.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: OutputTokensDetails - TypeScript SDK -sidebarTitle: OutputTokensDetails -description: OutputTokensDetails type definition -seoTitle: OutputTokensDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputtokensdetails -'og:site_name': OpenRouter Documentation -'og:title': OutputTokensDetails Type | OpenRouter TypeScript SDK -'og:description': >- - OutputTokensDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTokensDetails%20-%20TypeScript%20SDK&description=OutputTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputTokensDetails } from "@openrouter/sdk/models"; - -let value: OutputTokensDetails = { - reasoningTokens: 478527, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoningTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitem.mdx deleted file mode 100644 index 7429aea7..00000000 --- a/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitem.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputToolSearchServerToolItem - TypeScript SDK -sidebarTitle: OutputToolSearchServerToolItem -description: OutputToolSearchServerToolItem type definition -seoTitle: OutputToolSearchServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputtoolsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputToolSearchServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItem%20-%20TypeScript%20SDK&description=OutputToolSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:tool_search server tool output item - -## Example Usage - -```typescript lines -import { OutputToolSearchServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputToolSearchServerToolItem = { - status: "completed", - type: "openrouter:tool_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputToolSearchServerToolItemType](/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitemtype.mdx deleted file mode 100644 index fa9c405c..00000000 --- a/client-sdks/typescript/api-reference/models/outputtoolsearchservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputToolSearchServerToolItemType - TypeScript SDK -sidebarTitle: OutputToolSearchServerToolItemType -description: OutputToolSearchServerToolItemType type definition -seoTitle: OutputToolSearchServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputtoolsearchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputToolSearchServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputToolSearchServerToolItemType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputToolSearchServerToolItemType%20-%20TypeScript%20SDK&description=OutputToolSearchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputToolSearchServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputToolSearchServerToolItemType = "openrouter:tool_search"; -``` - -## Values - -```typescript lines -"openrouter:tool_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitem.mdx deleted file mode 100644 index 64d98248..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputWebFetchServerToolItem - TypeScript SDK -sidebarTitle: OutputWebFetchServerToolItem -description: OutputWebFetchServerToolItem type definition -seoTitle: OutputWebFetchServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebfetchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebFetchServerToolItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItem%20-%20TypeScript%20SDK&description=OutputWebFetchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:web_fetch server tool output item - -## Example Usage - -```typescript lines -import { OutputWebFetchServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputWebFetchServerToolItem = { - status: "completed", - type: "openrouter:web_fetch", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content` | *string* | :heavy_minus_sign: | N/A | | -| `error` | *string* | :heavy_minus_sign: | The error message if the fetch failed. | | -| `httpStatus` | *number* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `title` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputWebFetchServerToolItemType](/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitemtype) | :heavy_check_mark: | N/A | | -| `url` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitemtype.mdx b/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitemtype.mdx deleted file mode 100644 index 6c89f20c..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebfetchservertoolitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputWebFetchServerToolItemType - TypeScript SDK -sidebarTitle: OutputWebFetchServerToolItemType -description: OutputWebFetchServerToolItemType type definition -seoTitle: OutputWebFetchServerToolItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebfetchservertoolitemtype -'og:site_name': OpenRouter Documentation -'og:title': OutputWebFetchServerToolItemType Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebFetchServerToolItemType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebFetchServerToolItemType%20-%20TypeScript%20SDK&description=OutputWebFetchServerToolItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebFetchServerToolItemType } from "@openrouter/sdk/models"; - -let value: OutputWebFetchServerToolItemType = "openrouter:web_fetch"; -``` - -## Values - -```typescript lines -"openrouter:web_fetch" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchcallitem.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchcallitem.mdx deleted file mode 100644 index 5205a95d..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchcallitem.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputWebSearchCallItem - TypeScript SDK -sidebarTitle: OutputWebSearchCallItem -description: OutputWebSearchCallItem type definition -seoTitle: OutputWebSearchCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchcallitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchCallItem type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItem%20-%20TypeScript%20SDK&description=OutputWebSearchCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchCallItem } from "@openrouter/sdk/models"; - -let value: OutputWebSearchCallItem = { - action: { - pattern: "", - type: "find_in_page", - url: "https://faraway-deduction.net", - }, - id: "ws-abc123", - status: "completed", - type: "web_search_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `action` | *models.Action* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](/client-sdks/typescript/api-reference/models/websearchstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeWebSearchCall](/client-sdks/typescript/api-reference/models/typewebsearchcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchcallitemactionsearch.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchcallitemactionsearch.mdx deleted file mode 100644 index 43e5ed1f..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchcallitemactionsearch.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OutputWebSearchCallItemActionSearch - TypeScript SDK -sidebarTitle: OutputWebSearchCallItemActionSearch -description: OutputWebSearchCallItemActionSearch type definition -seoTitle: OutputWebSearchCallItemActionSearch Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchcallitemactionsearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchCallItemActionSearch Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchCallItemActionSearch type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchCallItemActionSearch%20-%20TypeScript%20SDK&description=OutputWebSearchCallItemActionSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchCallItemActionSearch } from "@openrouter/sdk/models"; - -let value: OutputWebSearchCallItemActionSearch = { - query: "", - type: "search", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `queries` | *string*[] | :heavy_minus_sign: | N/A | -| `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.WebSearchSource](/client-sdks/typescript/api-reference/models/websearchsource)[] | :heavy_minus_sign: | N/A | -| `type` | *"search"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitem.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitem.mdx deleted file mode 100644 index 8a4f90d5..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitem.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputWebSearchServerToolItem - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItem -description: OutputWebSearchServerToolItem type definition -seoTitle: OutputWebSearchServerToolItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitem -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItem Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItem type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItem%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An openrouter:web_search server tool output item - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItem } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItem = { - status: "completed", - type: "openrouter:web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [models.OutputWebSearchServerToolItemAction](/client-sdks/typescript/api-reference/models/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` | [models.ToolCallStatus](/client-sdks/typescript/api-reference/models/toolcallstatus) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemaction.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemaction.mdx deleted file mode 100644 index d629b008..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemaction.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OutputWebSearchServerToolItemAction - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItemAction -description: OutputWebSearchServerToolItemAction type definition -seoTitle: OutputWebSearchServerToolItemAction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitemaction -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemAction Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItemAction type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemAction%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItemAction } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItemAction = { - query: "", - type: "search", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.OutputWebSearchServerToolItemSource](/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemsource)[] | :heavy_minus_sign: | N/A | -| `type` | [models.OutputWebSearchServerToolItemTypeSearch](/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemsource.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemsource.mdx deleted file mode 100644 index 89455900..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemsource.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OutputWebSearchServerToolItemSource - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItemSource -description: OutputWebSearchServerToolItemSource type definition -seoTitle: OutputWebSearchServerToolItemSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitemsource -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemSource Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItemSource type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemSource%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItemSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItemSource } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItemSource = { - type: "url", - url: "https://immense-vista.com/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.OutputWebSearchServerToolItemTypeURL](/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeurl) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx deleted file mode 100644 index 4000a6c7..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeOpenrouterWebSearch - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItemTypeOpenrouterWebSearch -description: OutputWebSearchServerToolItemTypeOpenrouterWebSearch type definition -seoTitle: >- - OutputWebSearchServerToolItemTypeOpenrouterWebSearch Type | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeopenrouterwebsearch -'og:site_name': OpenRouter Documentation -'og:title': >- - OutputWebSearchServerToolItemTypeOpenrouterWebSearch Type | OpenRouter - TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItemTypeOpenrouterWebSearch type reference for the - OpenRouter TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItemTypeOpenrouterWebSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItemTypeOpenrouterWebSearch } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItemTypeOpenrouterWebSearch = - "openrouter:web_search"; -``` - -## Values - -```typescript lines -"openrouter:web_search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx deleted file mode 100644 index 9a2e866a..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypesearch.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeSearch - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItemTypeSearch -description: OutputWebSearchServerToolItemTypeSearch type definition -seoTitle: OutputWebSearchServerToolItemTypeSearch Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypesearch -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeSearch Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItemTypeSearch type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeSearch%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItemTypeSearch%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItemTypeSearch } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItemTypeSearch = "search"; -``` - -## Values - -```typescript lines -"search" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx b/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx deleted file mode 100644 index f3fde8f6..00000000 --- a/client-sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeurl.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputWebSearchServerToolItemTypeURL - TypeScript SDK -sidebarTitle: OutputWebSearchServerToolItemTypeURL -description: OutputWebSearchServerToolItemTypeURL type definition -seoTitle: OutputWebSearchServerToolItemTypeURL Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/outputwebsearchservertoolitemtypeurl -'og:site_name': OpenRouter Documentation -'og:title': OutputWebSearchServerToolItemTypeURL Type | OpenRouter TypeScript SDK -'og:description': >- - OutputWebSearchServerToolItemTypeURL type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputWebSearchServerToolItemTypeURL%20-%20TypeScript%20SDK&description=OutputWebSearchServerToolItemTypeURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputWebSearchServerToolItemTypeURL } from "@openrouter/sdk/models"; - -let value: OutputWebSearchServerToolItemTypeURL = "url"; -``` - -## Values - -```typescript lines -"url" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/parameter.mdx b/client-sdks/typescript/api-reference/models/parameter.mdx deleted file mode 100644 index fbe9dd3f..00000000 --- a/client-sdks/typescript/api-reference/models/parameter.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Parameter - TypeScript SDK -sidebarTitle: Parameter -description: Parameter type definition -seoTitle: Parameter Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/parameter' -'og:site_name': OpenRouter Documentation -'og:title': Parameter Type | OpenRouter TypeScript SDK -'og:description': >- - Parameter type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Parameter%20-%20TypeScript%20SDK&description=Parameter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Parameter } from "@openrouter/sdk/models"; - -let value: Parameter = "temperature"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"temperature" | "top_p" | "top_k" | "min_p" | "top_a" | "frequency_penalty" | "presence_penalty" | "repetition_penalty" | "max_tokens" | "max_completion_tokens" | "logit_bias" | "logprobs" | "top_logprobs" | "seed" | "response_format" | "structured_outputs" | "stop" | "tools" | "tool_choice" | "parallel_tool_calls" | "include_reasoning" | "reasoning" | "reasoning_effort" | "web_search_options" | "verbosity" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/paretorouterplugin.mdx b/client-sdks/typescript/api-reference/models/paretorouterplugin.mdx deleted file mode 100644 index b0da2765..00000000 --- a/client-sdks/typescript/api-reference/models/paretorouterplugin.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ParetoRouterPlugin - TypeScript SDK -sidebarTitle: ParetoRouterPlugin -description: ParetoRouterPlugin type definition -seoTitle: ParetoRouterPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/paretorouterplugin -'og:site_name': OpenRouter Documentation -'og:title': ParetoRouterPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ParetoRouterPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ParetoRouterPlugin%20-%20TypeScript%20SDK&description=ParetoRouterPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ParetoRouterPlugin } from "@openrouter/sdk/models"; - -let value: ParetoRouterPlugin = { - id: "pareto-router", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `id` | *"pareto-router"* | :heavy_check_mark: | N/A | | -| `minCodingScore` | *number* | :heavy_minus_sign: | Minimum desired coding score between 0 and 1, where 1 is best. Higher values select from stronger coding models (sourced from Artificial Analysis coding percentiles). Maps internally to one of three tiers (low, medium, high). Omit to use the router default tier. | 0.8 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/partialcoverage.mdx b/client-sdks/typescript/api-reference/models/partialcoverage.mdx deleted file mode 100644 index 08b554ec..00000000 --- a/client-sdks/typescript/api-reference/models/partialcoverage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PartialCoverage - TypeScript SDK -sidebarTitle: PartialCoverage -description: PartialCoverage type definition -seoTitle: PartialCoverage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/partialcoverage -'og:site_name': OpenRouter Documentation -'og:title': PartialCoverage Type | OpenRouter TypeScript SDK -'og:description': >- - PartialCoverage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PartialCoverage%20-%20TypeScript%20SDK&description=PartialCoverage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PartialCoverage } from "@openrouter/sdk/models"; - -let value: PartialCoverage = { - models: [], - point: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `models` | *string*[] | :heavy_check_mark: | N/A | -| `point` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/partition.mdx b/client-sdks/typescript/api-reference/models/partition.mdx deleted file mode 100644 index dc041eb6..00000000 --- a/client-sdks/typescript/api-reference/models/partition.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Partition - TypeScript SDK -sidebarTitle: Partition -description: Partition type definition -seoTitle: Partition Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/partition' -'og:site_name': OpenRouter Documentation -'og:title': Partition Type | OpenRouter TypeScript SDK -'og:description': >- - Partition type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Partition%20-%20TypeScript%20SDK&description=Partition%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. - -## Example Usage - -```typescript lines -import { Partition } from "@openrouter/sdk/models"; - -let value: Partition = "model"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"model" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/payloadtoolargeresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/payloadtoolargeresponseerrordata.mdx deleted file mode 100644 index 06d0d850..00000000 --- a/client-sdks/typescript/api-reference/models/payloadtoolargeresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: PayloadTooLargeResponseErrorData - TypeScript SDK -sidebarTitle: PayloadTooLargeResponseErrorData -description: PayloadTooLargeResponseErrorData type definition -seoTitle: PayloadTooLargeResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/payloadtoolargeresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - PayloadTooLargeResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseErrorData%20-%20TypeScript%20SDK&description=PayloadTooLargeResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for PayloadTooLargeResponse - -## Example Usage - -```typescript lines -import { PayloadTooLargeResponseErrorData } from "@openrouter/sdk/models"; - -let value: PayloadTooLargeResponseErrorData = { - code: 413, - message: "Request payload too large", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/paymentrequiredresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/paymentrequiredresponseerrordata.mdx deleted file mode 100644 index a7413121..00000000 --- a/client-sdks/typescript/api-reference/models/paymentrequiredresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: PaymentRequiredResponseErrorData - TypeScript SDK -sidebarTitle: PaymentRequiredResponseErrorData -description: PaymentRequiredResponseErrorData type definition -seoTitle: PaymentRequiredResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/paymentrequiredresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - PaymentRequiredResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseErrorData%20-%20TypeScript%20SDK&description=PaymentRequiredResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for PaymentRequiredResponse - -## Example Usage - -```typescript lines -import { PaymentRequiredResponseErrorData } from "@openrouter/sdk/models"; - -let value: PaymentRequiredResponseErrorData = { - code: 402, - message: "Insufficient credits. Add more using https://openrouter.ai/credits", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pdfparserengine.mdx b/client-sdks/typescript/api-reference/models/pdfparserengine.mdx deleted file mode 100644 index be19ffe5..00000000 --- a/client-sdks/typescript/api-reference/models/pdfparserengine.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PDFParserEngine - TypeScript SDK -sidebarTitle: PDFParserEngine -description: PDFParserEngine type definition -seoTitle: PDFParserEngine Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pdfparserengine -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngine Type | OpenRouter TypeScript SDK -'og:description': >- - PDFParserEngine type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngine%20-%20TypeScript%20SDK&description=PDFParserEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". - -## Supported Types - -### `models.PDFParserEngineEnum` - -```typescript lines -const value: models.PDFParserEngineEnum = "cloudflare-ai"; -``` - -### `models.PDFParserEnginePDFText` - -```typescript lines -const value: models.PDFParserEnginePDFText = "pdf-text"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pdfparserengineenum.mdx b/client-sdks/typescript/api-reference/models/pdfparserengineenum.mdx deleted file mode 100644 index ec126e4f..00000000 --- a/client-sdks/typescript/api-reference/models/pdfparserengineenum.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PDFParserEngineEnum - TypeScript SDK -sidebarTitle: PDFParserEngineEnum -description: PDFParserEngineEnum type definition -seoTitle: PDFParserEngineEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pdfparserengineenum -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngineEnum Type | OpenRouter TypeScript SDK -'og:description': >- - PDFParserEngineEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngineEnum%20-%20TypeScript%20SDK&description=PDFParserEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PDFParserEngineEnum } from "@openrouter/sdk/models"; - -let value: PDFParserEngineEnum = "cloudflare-ai"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"mistral-ocr" | "native" | "cloudflare-ai" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pdfparserenginepdftext.mdx b/client-sdks/typescript/api-reference/models/pdfparserenginepdftext.mdx deleted file mode 100644 index 9e322306..00000000 --- a/client-sdks/typescript/api-reference/models/pdfparserenginepdftext.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PDFParserEnginePDFText - TypeScript SDK -sidebarTitle: PDFParserEnginePDFText -description: PDFParserEnginePDFText type definition -seoTitle: PDFParserEnginePDFText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pdfparserenginepdftext -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEnginePDFText Type | OpenRouter TypeScript SDK -'og:description': >- - PDFParserEnginePDFText type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEnginePDFText%20-%20TypeScript%20SDK&description=PDFParserEnginePDFText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PDFParserEnginePDFText } from "@openrouter/sdk/models"; - -let value: PDFParserEnginePDFText = "pdf-text"; -``` - -## Values - -```typescript lines -"pdf-text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pdfparseroptions.mdx b/client-sdks/typescript/api-reference/models/pdfparseroptions.mdx deleted file mode 100644 index 9d394bb6..00000000 --- a/client-sdks/typescript/api-reference/models/pdfparseroptions.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PDFParserOptions - TypeScript SDK -sidebarTitle: PDFParserOptions -description: PDFParserOptions type definition -seoTitle: PDFParserOptions Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pdfparseroptions -'og:site_name': OpenRouter Documentation -'og:title': PDFParserOptions Type | OpenRouter TypeScript SDK -'og:description': >- - PDFParserOptions type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserOptions%20-%20TypeScript%20SDK&description=PDFParserOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Options for PDF parsing. - -## Example Usage - -```typescript lines -import { PDFParserOptions } from "@openrouter/sdk/models"; - -let value: PDFParserOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `engine` | *models.PDFParserEngine* | :heavy_minus_sign: | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pendingsafetycheck.mdx b/client-sdks/typescript/api-reference/models/pendingsafetycheck.mdx deleted file mode 100644 index 36a93c2f..00000000 --- a/client-sdks/typescript/api-reference/models/pendingsafetycheck.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PendingSafetyCheck - TypeScript SDK -sidebarTitle: PendingSafetyCheck -description: PendingSafetyCheck type definition -seoTitle: PendingSafetyCheck Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pendingsafetycheck -'og:site_name': OpenRouter Documentation -'og:title': PendingSafetyCheck Type | OpenRouter TypeScript SDK -'og:description': >- - PendingSafetyCheck type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PendingSafetyCheck%20-%20TypeScript%20SDK&description=PendingSafetyCheck%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PendingSafetyCheck } from "@openrouter/sdk/models"; - -let value: PendingSafetyCheck = { - code: "", - id: "", - message: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/percentilelatencycutoffs.mdx b/client-sdks/typescript/api-reference/models/percentilelatencycutoffs.mdx deleted file mode 100644 index 9831cdaf..00000000 --- a/client-sdks/typescript/api-reference/models/percentilelatencycutoffs.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PercentileLatencyCutoffs - TypeScript SDK -sidebarTitle: PercentileLatencyCutoffs -description: PercentileLatencyCutoffs type definition -seoTitle: PercentileLatencyCutoffs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/percentilelatencycutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileLatencyCutoffs Type | OpenRouter TypeScript SDK -'og:description': >- - PercentileLatencyCutoffs type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileLatencyCutoffs%20-%20TypeScript%20SDK&description=PercentileLatencyCutoffs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Percentile-based latency cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Example Usage - -```typescript lines -import { PercentileLatencyCutoffs } from "@openrouter/sdk/models"; - -let value: PercentileLatencyCutoffs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *number* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *number* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *number* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/percentilestats.mdx b/client-sdks/typescript/api-reference/models/percentilestats.mdx deleted file mode 100644 index 9823e5f1..00000000 --- a/client-sdks/typescript/api-reference/models/percentilestats.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: PercentileStats - TypeScript SDK -sidebarTitle: PercentileStats -description: PercentileStats type definition -seoTitle: PercentileStats Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/percentilestats -'og:site_name': OpenRouter Documentation -'og:title': PercentileStats Type | OpenRouter TypeScript SDK -'og:description': >- - PercentileStats type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileStats%20-%20TypeScript%20SDK&description=PercentileStats%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { PercentileStats } from "@openrouter/sdk/models"; - -let value: PercentileStats = { - p50: 25.5, - p75: 35.2, - p90: 48.7, - p99: 85.3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `p50` | *number* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *number* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *number* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *number* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/percentilethroughputcutoffs.mdx b/client-sdks/typescript/api-reference/models/percentilethroughputcutoffs.mdx deleted file mode 100644 index 63618503..00000000 --- a/client-sdks/typescript/api-reference/models/percentilethroughputcutoffs.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PercentileThroughputCutoffs - TypeScript SDK -sidebarTitle: PercentileThroughputCutoffs -description: PercentileThroughputCutoffs type definition -seoTitle: PercentileThroughputCutoffs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/percentilethroughputcutoffs -'og:site_name': OpenRouter Documentation -'og:title': PercentileThroughputCutoffs Type | OpenRouter TypeScript SDK -'og:description': >- - PercentileThroughputCutoffs type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileThroughputCutoffs%20-%20TypeScript%20SDK&description=PercentileThroughputCutoffs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Percentile-based throughput cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Example Usage - -```typescript lines -import { PercentileThroughputCutoffs } from "@openrouter/sdk/models"; - -let value: PercentileThroughputCutoffs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *number* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *number* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *number* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/perrequestlimits.mdx b/client-sdks/typescript/api-reference/models/perrequestlimits.mdx deleted file mode 100644 index f51cbe41..00000000 --- a/client-sdks/typescript/api-reference/models/perrequestlimits.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PerRequestLimits - TypeScript SDK -sidebarTitle: PerRequestLimits -description: PerRequestLimits type definition -seoTitle: PerRequestLimits Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/perrequestlimits -'og:site_name': OpenRouter Documentation -'og:title': PerRequestLimits Type | OpenRouter TypeScript SDK -'og:description': >- - PerRequestLimits type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PerRequestLimits%20-%20TypeScript%20SDK&description=PerRequestLimits%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Per-request token limits - -## Example Usage - -```typescript lines -import { PerRequestLimits } from "@openrouter/sdk/models"; - -let value: PerRequestLimits = { - completionTokens: 1000, - promptTokens: 1000, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `promptTokens` | *number* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pipelinestage.mdx b/client-sdks/typescript/api-reference/models/pipelinestage.mdx deleted file mode 100644 index e80ea0ce..00000000 --- a/client-sdks/typescript/api-reference/models/pipelinestage.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PipelineStage - TypeScript SDK -sidebarTitle: PipelineStage -description: PipelineStage type definition -seoTitle: PipelineStage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/pipelinestage' -'og:site_name': OpenRouter Documentation -'og:title': PipelineStage Type | OpenRouter TypeScript SDK -'og:description': >- - PipelineStage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStage%20-%20TypeScript%20SDK&description=PipelineStage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PipelineStage } from "@openrouter/sdk/models"; - -let value: PipelineStage = { - name: "content-filter", - type: "guardrail", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `costUsd` | *number* | :heavy_minus_sign: | N/A | | -| `data` | `Record` | :heavy_minus_sign: | N/A | | -| `guardrailId` | *string* | :heavy_minus_sign: | N/A | | -| `guardrailScope` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `summary` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.PipelineStageType](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/pipelinestagetype.mdx b/client-sdks/typescript/api-reference/models/pipelinestagetype.mdx deleted file mode 100644 index f5dde664..00000000 --- a/client-sdks/typescript/api-reference/models/pipelinestagetype.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PipelineStageType - TypeScript SDK -sidebarTitle: PipelineStageType -description: PipelineStageType type definition -seoTitle: PipelineStageType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/pipelinestagetype -'og:site_name': OpenRouter Documentation -'og:title': PipelineStageType Type | OpenRouter TypeScript SDK -'og:description': >- - PipelineStageType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PipelineStageType%20-%20TypeScript%20SDK&description=PipelineStageType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { PipelineStageType } from "@openrouter/sdk/models"; - -let value: PipelineStageType = "guardrail"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"guardrail" | "plugin" | "server_tools" | "response_healing" | "context_compression" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/preferredmaxlatency.mdx b/client-sdks/typescript/api-reference/models/preferredmaxlatency.mdx deleted file mode 100644 index 5e913d59..00000000 --- a/client-sdks/typescript/api-reference/models/preferredmaxlatency.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PreferredMaxLatency - TypeScript SDK -sidebarTitle: PreferredMaxLatency -description: PreferredMaxLatency type definition -seoTitle: PreferredMaxLatency Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/preferredmaxlatency -'og:site_name': OpenRouter Documentation -'og:title': PreferredMaxLatency Type | OpenRouter TypeScript SDK -'og:description': >- - PreferredMaxLatency type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMaxLatency%20-%20TypeScript%20SDK&description=PreferredMaxLatency%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `number` - -```typescript lines -const value: number = 5; -``` - -### `models.PercentileLatencyCutoffs` - -```typescript lines -const value: models.PercentileLatencyCutoffs = {}; -``` - -### `any` - -```typescript lines -const value: any = 5; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/preferredminthroughput.mdx b/client-sdks/typescript/api-reference/models/preferredminthroughput.mdx deleted file mode 100644 index ed3c9537..00000000 --- a/client-sdks/typescript/api-reference/models/preferredminthroughput.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PreferredMinThroughput - TypeScript SDK -sidebarTitle: PreferredMinThroughput -description: PreferredMinThroughput type definition -seoTitle: PreferredMinThroughput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/preferredminthroughput -'og:site_name': OpenRouter Documentation -'og:title': PreferredMinThroughput Type | OpenRouter TypeScript SDK -'og:description': >- - PreferredMinThroughput type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMinThroughput%20-%20TypeScript%20SDK&description=PreferredMinThroughput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `number` - -```typescript lines -const value: number = 100; -``` - -### `models.PercentileThroughputCutoffs` - -```typescript lines -const value: models.PercentileThroughputCutoffs = {}; -``` - -### `any` - -```typescript lines -const value: any = 100; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/presetdesignatedversion.mdx b/client-sdks/typescript/api-reference/models/presetdesignatedversion.mdx deleted file mode 100644 index c92cd1f2..00000000 --- a/client-sdks/typescript/api-reference/models/presetdesignatedversion.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: PresetDesignatedVersion - TypeScript SDK -sidebarTitle: PresetDesignatedVersion -description: PresetDesignatedVersion type definition -seoTitle: PresetDesignatedVersion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/presetdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetDesignatedVersion Type | OpenRouter TypeScript SDK -'og:description': >- - PresetDesignatedVersion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetDesignatedVersion%20-%20TypeScript%20SDK&description=PresetDesignatedVersion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A specific version of a preset, containing config and optional system prompt. - -## Example Usage - -```typescript lines -import { PresetDesignatedVersion } from "@openrouter/sdk/models"; - -let value: PresetDesignatedVersion = { - config: { - "model": "openai/gpt-4o", - "temperature": 0.7, - }, - createdAt: "2026-04-20T10:00:00Z", - creatorId: "user_2dHFtVWx2n56w6HkM0000000000", - id: "550e8400-e29b-41d4-a716-446655440000", - presetId: "650e8400-e29b-41d4-a716-446655440001", - systemPrompt: "You are a helpful assistant.", - updatedAt: "2026-04-20T10:00:00Z", - version: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `config` | `Record` | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `creatorId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `presetId` | *string* | :heavy_check_mark: | N/A | -| `systemPrompt` | *string* | :heavy_check_mark: | N/A | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | -| `version` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/presetwithdesignatedversion.mdx b/client-sdks/typescript/api-reference/models/presetwithdesignatedversion.mdx deleted file mode 100644 index 9b8ef5e7..00000000 --- a/client-sdks/typescript/api-reference/models/presetwithdesignatedversion.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: PresetWithDesignatedVersion - TypeScript SDK -sidebarTitle: PresetWithDesignatedVersion -description: PresetWithDesignatedVersion type definition -seoTitle: PresetWithDesignatedVersion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/presetwithdesignatedversion -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersion Type | OpenRouter TypeScript SDK -'og:description': >- - PresetWithDesignatedVersion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersion%20-%20TypeScript%20SDK&description=PresetWithDesignatedVersion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A preset with its currently designated version. - -## Example Usage - -```typescript expandable lines -import { PresetWithDesignatedVersion } from "@openrouter/sdk/models"; - -let value: PresetWithDesignatedVersion = { - createdAt: "2026-04-20T10:00:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - description: null, - designatedVersion: { - config: { - "model": "openai/gpt-4o", - "temperature": 0.7, - }, - createdAt: "2026-04-20T10:00:00Z", - creatorId: "user_2dHFtVWx2n56w6HkM0000000000", - id: "550e8400-e29b-41d4-a716-446655440000", - presetId: "650e8400-e29b-41d4-a716-446655440001", - systemPrompt: "You are a helpful assistant.", - updatedAt: "2026-04-20T10:00:00Z", - version: 1, - }, - designatedVersionId: "550e8400-e29b-41d4-a716-446655440000", - id: "650e8400-e29b-41d4-a716-446655440001", - name: "my-preset", - slug: "my-preset", - status: "active", - statusUpdatedAt: null, - updatedAt: "2026-04-20T10:00:00Z", - workspaceId: "750e8400-e29b-41d4-a716-446655440002", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | -| `creatorUserId` | *string* | :heavy_check_mark: | N/A | | -| `description` | *string* | :heavy_check_mark: | N/A | | -| `designatedVersion` | [models.PresetDesignatedVersion](/client-sdks/typescript/api-reference/models/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
`\} | -| `designatedVersionId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `slug` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.PresetWithDesignatedVersionStatus](/client-sdks/typescript/api-reference/models/presetwithdesignatedversionstatus) | :heavy_check_mark: | N/A | | -| `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/client-sdks/typescript/api-reference/models/presetwithdesignatedversionstatus.mdx b/client-sdks/typescript/api-reference/models/presetwithdesignatedversionstatus.mdx deleted file mode 100644 index 3d8746f7..00000000 --- a/client-sdks/typescript/api-reference/models/presetwithdesignatedversionstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PresetWithDesignatedVersionStatus - TypeScript SDK -sidebarTitle: PresetWithDesignatedVersionStatus -description: PresetWithDesignatedVersionStatus type definition -seoTitle: PresetWithDesignatedVersionStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/presetwithdesignatedversionstatus -'og:site_name': OpenRouter Documentation -'og:title': PresetWithDesignatedVersionStatus Type | OpenRouter TypeScript SDK -'og:description': >- - PresetWithDesignatedVersionStatus type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PresetWithDesignatedVersionStatus%20-%20TypeScript%20SDK&description=PresetWithDesignatedVersionStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PresetWithDesignatedVersionStatus } from "@openrouter/sdk/models"; - -let value: PresetWithDesignatedVersionStatus = "disabled"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"active" | "disabled" | "archived" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/preview20250311websearchservertool.mdx b/client-sdks/typescript/api-reference/models/preview20250311websearchservertool.mdx deleted file mode 100644 index 2e75a46c..00000000 --- a/client-sdks/typescript/api-reference/models/preview20250311websearchservertool.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Preview20250311WebSearchServerTool - TypeScript SDK -sidebarTitle: Preview20250311WebSearchServerTool -description: Preview20250311WebSearchServerTool type definition -seoTitle: Preview20250311WebSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/preview20250311websearchservertool -'og:site_name': OpenRouter Documentation -'og:title': Preview20250311WebSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - Preview20250311WebSearchServerTool type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Preview20250311WebSearchServerTool%20-%20TypeScript%20SDK&description=Preview20250311WebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration (2025-03-11 version) - -## Example Usage - -```typescript lines -import { Preview20250311WebSearchServerTool } from "@openrouter/sdk/models"; - -let value: Preview20250311WebSearchServerTool = { - type: "web_search_preview_2025_03_11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `filters` | [models.WebSearchDomainFilter](/client-sdks/typescript/api-reference/models/websearchdomainfilter) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `searchContextSize` | [models.SearchContextSizeEnum](/client-sdks/typescript/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | *"web_search_preview_2025_03_11"* | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/previewwebsearchservertool.mdx b/client-sdks/typescript/api-reference/models/previewwebsearchservertool.mdx deleted file mode 100644 index dcb8929e..00000000 --- a/client-sdks/typescript/api-reference/models/previewwebsearchservertool.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: PreviewWebSearchServerTool - TypeScript SDK -sidebarTitle: PreviewWebSearchServerTool -description: PreviewWebSearchServerTool type definition -seoTitle: PreviewWebSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/previewwebsearchservertool -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - PreviewWebSearchServerTool type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchServerTool%20-%20TypeScript%20SDK&description=PreviewWebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration - -## Example Usage - -```typescript lines -import { PreviewWebSearchServerTool } from "@openrouter/sdk/models"; - -let value: PreviewWebSearchServerTool = { - type: "web_search_preview", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `filters` | [models.WebSearchDomainFilter](/client-sdks/typescript/api-reference/models/websearchdomainfilter) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `searchContextSize` | [models.SearchContextSizeEnum](/client-sdks/typescript/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | *"web_search_preview"* | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/previewwebsearchuserlocation.mdx b/client-sdks/typescript/api-reference/models/previewwebsearchuserlocation.mdx deleted file mode 100644 index c864a357..00000000 --- a/client-sdks/typescript/api-reference/models/previewwebsearchuserlocation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PreviewWebSearchUserLocation - TypeScript SDK -sidebarTitle: PreviewWebSearchUserLocation -description: PreviewWebSearchUserLocation type definition -seoTitle: PreviewWebSearchUserLocation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/previewwebsearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocation Type | OpenRouter TypeScript SDK -'og:description': >- - PreviewWebSearchUserLocation type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocation%20-%20TypeScript%20SDK&description=PreviewWebSearchUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PreviewWebSearchUserLocation } from "@openrouter/sdk/models"; - -let value: PreviewWebSearchUserLocation = { - type: "approximate", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.PreviewWebSearchUserLocationType](/client-sdks/typescript/api-reference/models/previewwebsearchuserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/previewwebsearchuserlocationtype.mdx b/client-sdks/typescript/api-reference/models/previewwebsearchuserlocationtype.mdx deleted file mode 100644 index b34f871c..00000000 --- a/client-sdks/typescript/api-reference/models/previewwebsearchuserlocationtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PreviewWebSearchUserLocationType - TypeScript SDK -sidebarTitle: PreviewWebSearchUserLocationType -description: PreviewWebSearchUserLocationType type definition -seoTitle: PreviewWebSearchUserLocationType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/previewwebsearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': PreviewWebSearchUserLocationType Type | OpenRouter TypeScript SDK -'og:description': >- - PreviewWebSearchUserLocationType type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreviewWebSearchUserLocationType%20-%20TypeScript%20SDK&description=PreviewWebSearchUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PreviewWebSearchUserLocationType } from "@openrouter/sdk/models"; - -let value: PreviewWebSearchUserLocationType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/pricing.mdx b/client-sdks/typescript/api-reference/models/pricing.mdx deleted file mode 100644 index c9179747..00000000 --- a/client-sdks/typescript/api-reference/models/pricing.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Pricing - TypeScript SDK -sidebarTitle: Pricing -description: Pricing type definition -seoTitle: Pricing Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/pricing' -'og:site_name': OpenRouter Documentation -'og:title': Pricing Type | OpenRouter TypeScript SDK -'og:description': >- - Pricing type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pricing%20-%20TypeScript%20SDK&description=Pricing%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Pricing } from "@openrouter/sdk/models"; - -let value: Pricing = { - completion: "1000", - prompt: "1000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `audio` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `audioOutput` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *string* | :heavy_check_mark: | N/A | 1000 | -| `discount` | *number* | :heavy_minus_sign: | N/A | | -| `image` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `imageOutput` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `imageToken` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputAudioCache` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputCacheRead` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `internalReasoning` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *string* | :heavy_check_mark: | N/A | 1000 | -| `request` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `webSearch` | *string* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/prompttokensdetails.mdx b/client-sdks/typescript/api-reference/models/prompttokensdetails.mdx deleted file mode 100644 index db88e6ef..00000000 --- a/client-sdks/typescript/api-reference/models/prompttokensdetails.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PromptTokensDetails - TypeScript SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails type definition -seoTitle: PromptTokensDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/prompttokensdetails -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails Type | OpenRouter TypeScript SDK -'og:description': >- - PromptTokensDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20TypeScript%20SDK&description=PromptTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Detailed prompt token usage - -## Example Usage - -```typescript lines -import { PromptTokensDetails } from "@openrouter/sdk/models"; - -let value: PromptTokensDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Audio input tokens | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Cached prompt tokens | -| `videoTokens` | *number* | :heavy_minus_sign: | Video input tokens | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providername.mdx b/client-sdks/typescript/api-reference/models/providername.mdx deleted file mode 100644 index b79de553..00000000 --- a/client-sdks/typescript/api-reference/models/providername.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ProviderName - TypeScript SDK -sidebarTitle: ProviderName -description: ProviderName type definition -seoTitle: ProviderName Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/providername' -'og:site_name': OpenRouter Documentation -'og:title': ProviderName Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderName type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderName%20-%20TypeScript%20SDK&description=ProviderName%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderName } from "@openrouter/sdk/models"; - -let value: ProviderName = "OpenAI"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"AkashML" | "AI21" | "AionLabs" | "Alibaba" | "Ambient" | "Baidu" | "Amazon Bedrock" | "Amazon Nova" | "Anthropic" | "Arcee AI" | "AtlasCloud" | "Avian" | "Azure" | "BaseTen" | "BytePlus" | "Black Forest Labs" | "Cerebras" | "Chutes" | "Cirrascale" | "Clarifai" | "Cloudflare" | "Cohere" | "Crucible" | "Crusoe" | "Darkbloom" | "DeepInfra" | "DeepSeek" | "DekaLLM" | "DigitalOcean" | "Featherless" | "Fireworks" | "Friendli" | "GMICloud" | "Google" | "Google AI Studio" | "Groq" | "Hyperbolic" | "Inception" | "Inceptron" | "InferenceNet" | "Ionstream" | "Infermatic" | "Io Net" | "Inflection" | "Liquid" | "Mara" | "Mancer 2" | "Minimax" | "ModelRun" | "Mistral" | "Modular" | "Moonshot AI" | "Morph" | "NCompass" | "Nebius" | "Nex AGI" | "NextBit" | "Novita" | "Nvidia" | "OpenAI" | "OpenInference" | "Parasail" | "Poolside" | "Perceptron" | "Perplexity" | "Phala" | "Recraft" | "Reka" | "Relace" | "SambaNova" | "Seed" | "SiliconFlow" | "Sourceful" | "StepFun" | "Stealth" | "StreamLake" | "Switchpoint" | "Together" | "Upstage" | "Venice" | "WandB" | "Xiaomi" | "xAI" | "Z.AI" | "FakeProvider" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/provideroptions.mdx b/client-sdks/typescript/api-reference/models/provideroptions.mdx deleted file mode 100644 index 2dc5d249..00000000 --- a/client-sdks/typescript/api-reference/models/provideroptions.mdx +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: ProviderOptions - TypeScript SDK -sidebarTitle: ProviderOptions -description: ProviderOptions type definition -seoTitle: ProviderOptions Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/provideroptions -'og:site_name': OpenRouter Documentation -'og:title': ProviderOptions Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderOptions type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOptions%20-%20TypeScript%20SDK&description=ProviderOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. - -## Example Usage - -```typescript lines -import { ProviderOptions } from "@openrouter/sdk/models"; - -let value: ProviderOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `oneai` | `Record` | :heavy_minus_sign: | N/A | -| `ai21` | `Record` | :heavy_minus_sign: | N/A | -| `aionLabs` | `Record` | :heavy_minus_sign: | N/A | -| `akashml` | `Record` | :heavy_minus_sign: | N/A | -| `alibaba` | `Record` | :heavy_minus_sign: | N/A | -| `amazonBedrock` | `Record` | :heavy_minus_sign: | N/A | -| `amazonNova` | `Record` | :heavy_minus_sign: | N/A | -| `ambient` | `Record` | :heavy_minus_sign: | N/A | -| `anthropic` | `Record` | :heavy_minus_sign: | N/A | -| `anyscale` | `Record` | :heavy_minus_sign: | N/A | -| `arceeAi` | `Record` | :heavy_minus_sign: | N/A | -| `atlasCloud` | `Record` | :heavy_minus_sign: | N/A | -| `atoma` | `Record` | :heavy_minus_sign: | N/A | -| `avian` | `Record` | :heavy_minus_sign: | N/A | -| `azure` | `Record` | :heavy_minus_sign: | N/A | -| `baidu` | `Record` | :heavy_minus_sign: | N/A | -| `baseten` | `Record` | :heavy_minus_sign: | N/A | -| `blackForestLabs` | `Record` | :heavy_minus_sign: | N/A | -| `byteplus` | `Record` | :heavy_minus_sign: | N/A | -| `centml` | `Record` | :heavy_minus_sign: | N/A | -| `cerebras` | `Record` | :heavy_minus_sign: | N/A | -| `chutes` | `Record` | :heavy_minus_sign: | N/A | -| `cirrascale` | `Record` | :heavy_minus_sign: | N/A | -| `clarifai` | `Record` | :heavy_minus_sign: | N/A | -| `cloudflare` | `Record` | :heavy_minus_sign: | N/A | -| `cohere` | `Record` | :heavy_minus_sign: | N/A | -| `crofai` | `Record` | :heavy_minus_sign: | N/A | -| `crucible` | `Record` | :heavy_minus_sign: | N/A | -| `crusoe` | `Record` | :heavy_minus_sign: | N/A | -| `darkbloom` | `Record` | :heavy_minus_sign: | N/A | -| `deepinfra` | `Record` | :heavy_minus_sign: | N/A | -| `deepseek` | `Record` | :heavy_minus_sign: | N/A | -| `dekallm` | `Record` | :heavy_minus_sign: | N/A | -| `digitalocean` | `Record` | :heavy_minus_sign: | N/A | -| `enfer` | `Record` | :heavy_minus_sign: | N/A | -| `fakeProvider` | `Record` | :heavy_minus_sign: | N/A | -| `featherless` | `Record` | :heavy_minus_sign: | N/A | -| `fireworks` | `Record` | :heavy_minus_sign: | N/A | -| `friendli` | `Record` | :heavy_minus_sign: | N/A | -| `gmicloud` | `Record` | :heavy_minus_sign: | N/A | -| `googleAiStudio` | `Record` | :heavy_minus_sign: | N/A | -| `googleVertex` | `Record` | :heavy_minus_sign: | N/A | -| `gopomelo` | `Record` | :heavy_minus_sign: | N/A | -| `groq` | `Record` | :heavy_minus_sign: | N/A | -| `huggingface` | `Record` | :heavy_minus_sign: | N/A | -| `hyperbolic` | `Record` | :heavy_minus_sign: | N/A | -| `hyperbolicQuantized` | `Record` | :heavy_minus_sign: | N/A | -| `inception` | `Record` | :heavy_minus_sign: | N/A | -| `inceptron` | `Record` | :heavy_minus_sign: | N/A | -| `inferenceNet` | `Record` | :heavy_minus_sign: | N/A | -| `infermatic` | `Record` | :heavy_minus_sign: | N/A | -| `inflection` | `Record` | :heavy_minus_sign: | N/A | -| `inocloud` | `Record` | :heavy_minus_sign: | N/A | -| `ioNet` | `Record` | :heavy_minus_sign: | N/A | -| `ionstream` | `Record` | :heavy_minus_sign: | N/A | -| `klusterai` | `Record` | :heavy_minus_sign: | N/A | -| `lambda` | `Record` | :heavy_minus_sign: | N/A | -| `lepton` | `Record` | :heavy_minus_sign: | N/A | -| `liquid` | `Record` | :heavy_minus_sign: | N/A | -| `lynn` | `Record` | :heavy_minus_sign: | N/A | -| `lynnPrivate` | `Record` | :heavy_minus_sign: | N/A | -| `mancer` | `Record` | :heavy_minus_sign: | N/A | -| `mancerOld` | `Record` | :heavy_minus_sign: | N/A | -| `mara` | `Record` | :heavy_minus_sign: | N/A | -| `meta` | `Record` | :heavy_minus_sign: | N/A | -| `minimax` | `Record` | :heavy_minus_sign: | N/A | -| `mistral` | `Record` | :heavy_minus_sign: | N/A | -| `modal` | `Record` | :heavy_minus_sign: | N/A | -| `modelrun` | `Record` | :heavy_minus_sign: | N/A | -| `modular` | `Record` | :heavy_minus_sign: | N/A | -| `moonshotai` | `Record` | :heavy_minus_sign: | N/A | -| `morph` | `Record` | :heavy_minus_sign: | N/A | -| `ncompass` | `Record` | :heavy_minus_sign: | N/A | -| `nebius` | `Record` | :heavy_minus_sign: | N/A | -| `nexAgi` | `Record` | :heavy_minus_sign: | N/A | -| `nextbit` | `Record` | :heavy_minus_sign: | N/A | -| `nineteen` | `Record` | :heavy_minus_sign: | N/A | -| `novita` | `Record` | :heavy_minus_sign: | N/A | -| `nvidia` | `Record` | :heavy_minus_sign: | N/A | -| `octoai` | `Record` | :heavy_minus_sign: | N/A | -| `openInference` | `Record` | :heavy_minus_sign: | N/A | -| `openai` | `Record` | :heavy_minus_sign: | N/A | -| `parasail` | `Record` | :heavy_minus_sign: | N/A | -| `perceptron` | `Record` | :heavy_minus_sign: | N/A | -| `perplexity` | `Record` | :heavy_minus_sign: | N/A | -| `phala` | `Record` | :heavy_minus_sign: | N/A | -| `poolside` | `Record` | :heavy_minus_sign: | N/A | -| `recraft` | `Record` | :heavy_minus_sign: | N/A | -| `recursal` | `Record` | :heavy_minus_sign: | N/A | -| `reflection` | `Record` | :heavy_minus_sign: | N/A | -| `reka` | `Record` | :heavy_minus_sign: | N/A | -| `relace` | `Record` | :heavy_minus_sign: | N/A | -| `replicate` | `Record` | :heavy_minus_sign: | N/A | -| `sambanova` | `Record` | :heavy_minus_sign: | N/A | -| `sambanovaCloaked` | `Record` | :heavy_minus_sign: | N/A | -| `seed` | `Record` | :heavy_minus_sign: | N/A | -| `sfCompute` | `Record` | :heavy_minus_sign: | N/A | -| `siliconflow` | `Record` | :heavy_minus_sign: | N/A | -| `sourceful` | `Record` | :heavy_minus_sign: | N/A | -| `stealth` | `Record` | :heavy_minus_sign: | N/A | -| `stepfun` | `Record` | :heavy_minus_sign: | N/A | -| `streamlake` | `Record` | :heavy_minus_sign: | N/A | -| `switchpoint` | `Record` | :heavy_minus_sign: | N/A | -| `targon` | `Record` | :heavy_minus_sign: | N/A | -| `together` | `Record` | :heavy_minus_sign: | N/A | -| `togetherLite` | `Record` | :heavy_minus_sign: | N/A | -| `ubicloud` | `Record` | :heavy_minus_sign: | N/A | -| `upstage` | `Record` | :heavy_minus_sign: | N/A | -| `venice` | `Record` | :heavy_minus_sign: | N/A | -| `wandb` | `Record` | :heavy_minus_sign: | N/A | -| `xai` | `Record` | :heavy_minus_sign: | N/A | -| `xiaomi` | `Record` | :heavy_minus_sign: | N/A | -| `zAi` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/provideroverloadedresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/provideroverloadedresponseerrordata.mdx deleted file mode 100644 index 51feb99c..00000000 --- a/client-sdks/typescript/api-reference/models/provideroverloadedresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ProviderOverloadedResponseErrorData - TypeScript SDK -sidebarTitle: ProviderOverloadedResponseErrorData -description: ProviderOverloadedResponseErrorData type definition -seoTitle: ProviderOverloadedResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/provideroverloadedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderOverloadedResponseErrorData type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseErrorData%20-%20TypeScript%20SDK&description=ProviderOverloadedResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ProviderOverloadedResponse - -## Example Usage - -```typescript lines -import { ProviderOverloadedResponseErrorData } from "@openrouter/sdk/models"; - -let value: ProviderOverloadedResponseErrorData = { - code: 529, - message: "Provider returned error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providerpreferences.mdx b/client-sdks/typescript/api-reference/models/providerpreferences.mdx deleted file mode 100644 index dcd808f0..00000000 --- a/client-sdks/typescript/api-reference/models/providerpreferences.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ProviderPreferences - TypeScript SDK -sidebarTitle: ProviderPreferences -description: ProviderPreferences type definition -seoTitle: ProviderPreferences Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/providerpreferences -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferences Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferences type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferences%20-%20TypeScript%20SDK&description=ProviderPreferences%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -When multiple model providers are available, optionally indicate your routing preference. - -## Example Usage - -```typescript lines -import { ProviderPreferences } from "@openrouter/sdk/models"; - -let value: ProviderPreferences = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve `requests
`- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `dataCollection` | [models.DataCollection](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `ignore` | *models.Ignore*[] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `maxPrice` | [models.MaxPrice](/client-sdks/typescript/api-reference/models/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` | *models.Only*[] | :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` | *models.Order*[] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `preferredMaxLatency` | *models.PreferredMaxLatency* | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | -| `preferredMinThroughput` | *models.PreferredMinThroughput* | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `quantizations` | [models.Quantization](/client-sdks/typescript/api-reference/models/quantization)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `requireParameters` | *boolean* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `sort` | *models.Sort* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providerresponse.mdx b/client-sdks/typescript/api-reference/models/providerresponse.mdx deleted file mode 100644 index 8950f84e..00000000 --- a/client-sdks/typescript/api-reference/models/providerresponse.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ProviderResponse - TypeScript SDK -sidebarTitle: ProviderResponse -description: ProviderResponse type definition -seoTitle: ProviderResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/providerresponse -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponse%20-%20TypeScript%20SDK&description=ProviderResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Details of a provider response for a generation attempt - -## Example Usage - -```typescript lines -import { ProviderResponse } from "@openrouter/sdk/models"; - -let value: ProviderResponse = { - status: 200, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `endpointId` | *string* | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `id` | *string* | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | -| `latency` | *number* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | -| `modelPermaslug` | *string* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `providerName` | [models.ProviderResponseProviderName](/client-sdks/typescript/api-reference/models/providerresponseprovidername) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `status` | *number* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providerresponseprovidername.mdx b/client-sdks/typescript/api-reference/models/providerresponseprovidername.mdx deleted file mode 100644 index 940ad461..00000000 --- a/client-sdks/typescript/api-reference/models/providerresponseprovidername.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ProviderResponseProviderName - TypeScript SDK -sidebarTitle: ProviderResponseProviderName -description: ProviderResponseProviderName type definition -seoTitle: ProviderResponseProviderName Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/providerresponseprovidername -'og:site_name': OpenRouter Documentation -'og:title': ProviderResponseProviderName Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderResponseProviderName type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderResponseProviderName%20-%20TypeScript%20SDK&description=ProviderResponseProviderName%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Name of the provider - -## Example Usage - -```typescript lines -import { ProviderResponseProviderName } from "@openrouter/sdk/models"; - -let value: ProviderResponseProviderName = "OpenAI"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"AnyScale" | "Atoma" | "Cent-ML" | "CrofAI" | "Enfer" | "GoPomelo" | "HuggingFace" | "Hyperbolic 2" | "InoCloud" | "Kluster" | "Lambda" | "Lepton" | "Lynn 2" | "Lynn" | "Mancer" | "Meta" | "Modal" | "Nineteen" | "OctoAI" | "Recursal" | "Reflection" | "Replicate" | "SambaNova 2" | "SF Compute" | "Targon" | "Together 2" | "Ubicloud" | "01.AI" | "AkashML" | "AI21" | "AionLabs" | "Alibaba" | "Ambient" | "Baidu" | "Amazon Bedrock" | "Amazon Nova" | "Anthropic" | "Arcee AI" | "AtlasCloud" | "Avian" | "Azure" | "BaseTen" | "BytePlus" | "Black Forest Labs" | "Cerebras" | "Chutes" | "Cirrascale" | "Clarifai" | "Cloudflare" | "Cohere" | "Crucible" | "Crusoe" | "Darkbloom" | "DeepInfra" | "DeepSeek" | "DekaLLM" | "DigitalOcean" | "Featherless" | "Fireworks" | "Friendli" | "GMICloud" | "Google" | "Google AI Studio" | "Groq" | "Hyperbolic" | "Inception" | "Inceptron" | "InferenceNet" | "Ionstream" | "Infermatic" | "Io Net" | "Inflection" | "Liquid" | "Mara" | "Mancer 2" | "Minimax" | "ModelRun" | "Mistral" | "Modular" | "Moonshot AI" | "Morph" | "NCompass" | "Nebius" | "Nex AGI" | "NextBit" | "Novita" | "Nvidia" | "OpenAI" | "OpenInference" | "Parasail" | "Poolside" | "Perceptron" | "Perplexity" | "Phala" | "Recraft" | "Reka" | "Relace" | "SambaNova" | "Seed" | "SiliconFlow" | "Sourceful" | "StepFun" | "Stealth" | "StreamLake" | "Switchpoint" | "Together" | "Upstage" | "Venice" | "WandB" | "Xiaomi" | "xAI" | "Z.AI" | "FakeProvider" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providersort.mdx b/client-sdks/typescript/api-reference/models/providersort.mdx deleted file mode 100644 index feb29f76..00000000 --- a/client-sdks/typescript/api-reference/models/providersort.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ProviderSort - TypeScript SDK -sidebarTitle: ProviderSort -description: ProviderSort type definition -seoTitle: ProviderSort Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/providersort' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSort Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderSort type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSort%20-%20TypeScript%20SDK&description=ProviderSort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Example Usage - -```typescript lines -import { ProviderSort } from "@openrouter/sdk/models"; - -let value: ProviderSort = "price"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"price" | "throughput" | "latency" | "exacto" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/providersortconfig.mdx b/client-sdks/typescript/api-reference/models/providersortconfig.mdx deleted file mode 100644 index 3da91315..00000000 --- a/client-sdks/typescript/api-reference/models/providersortconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ProviderSortConfig - TypeScript SDK -sidebarTitle: ProviderSortConfig -description: ProviderSortConfig type definition -seoTitle: ProviderSortConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/providersortconfig -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ProviderSortConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfig%20-%20TypeScript%20SDK&description=ProviderSortConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The provider sorting strategy (price, throughput, latency) - -## Example Usage - -```typescript lines -import { ProviderSortConfig } from "@openrouter/sdk/models"; - -let value: ProviderSortConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [models.By](/client-sdks/typescript/api-reference/models/by) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [models.Partition](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/publicendpoint.mdx b/client-sdks/typescript/api-reference/models/publicendpoint.mdx deleted file mode 100644 index f380b71a..00000000 --- a/client-sdks/typescript/api-reference/models/publicendpoint.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: PublicEndpoint - TypeScript SDK -sidebarTitle: PublicEndpoint -description: PublicEndpoint type definition -seoTitle: PublicEndpoint Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/publicendpoint' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpoint Type | OpenRouter TypeScript SDK -'og:description': >- - PublicEndpoint type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpoint%20-%20TypeScript%20SDK&description=PublicEndpoint%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about a specific model endpoint - -## Example Usage - -```typescript expandable lines -import { PublicEndpoint } from "@openrouter/sdk/models"; - -let value: PublicEndpoint = { - contextLength: 8192, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - modelId: "openai/gpt-4", - modelName: "GPT-4", - name: "OpenAI: GPT-4", - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - providerName: "OpenAI", - quantization: "fp16", - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - supportsImplicitCaching: true, - tag: "openai", - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - uptimeLast1d: 99.8, - uptimeLast30m: 99.5, - uptimeLast5m: 100, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contextLength` | *number* | :heavy_check_mark: | N/A | | -| `latencyLast30m` | [models.PercentileStats](/client-sdks/typescript/api-reference/models/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` | *number* | :heavy_check_mark: | N/A | | -| `maxPromptTokens` | *number* | :heavy_check_mark: | N/A | | -| `modelId` | *string* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `modelName` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `pricing` | [models.Pricing](/client-sdks/typescript/api-reference/models/pricing) | :heavy_check_mark: | N/A | | -| `providerName` | [models.ProviderName](/client-sdks/typescript/api-reference/models/providername) | :heavy_check_mark: | N/A | OpenAI | -| `quantization` | [models.PublicEndpointQuantization](/client-sdks/typescript/api-reference/models/publicendpointquantization) | :heavy_check_mark: | N/A | fp16 | -| `status` | [models.EndpointStatus](/client-sdks/typescript/api-reference/models/endpointstatus) | :heavy_minus_sign: | N/A | 0 | -| `supportedParameters` | [models.Parameter](/client-sdks/typescript/api-reference/models/parameter)[] | :heavy_check_mark: | N/A | | -| `supportsImplicitCaching` | *boolean* | :heavy_check_mark: | N/A | | -| `tag` | *string* | :heavy_check_mark: | N/A | | -| `throughputLast30m` | [models.PercentileStats](/client-sdks/typescript/api-reference/models/percentilestats) | :heavy_check_mark: | N/A | `{"p50": 25.5,"p75": 35.2,"p90": 48.7,"p99": 85.3}` | -| `uptimeLast1d` | *number* | :heavy_check_mark: | Uptime percentage over the last 1 day, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | -| `uptimeLast30m` | *number* | :heavy_check_mark: | N/A | | -| `uptimeLast5m` | *number* | :heavy_check_mark: | Uptime percentage over the last 5 minutes, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/publicendpointquantization.mdx b/client-sdks/typescript/api-reference/models/publicendpointquantization.mdx deleted file mode 100644 index 50b80c86..00000000 --- a/client-sdks/typescript/api-reference/models/publicendpointquantization.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PublicEndpointQuantization - TypeScript SDK -sidebarTitle: PublicEndpointQuantization -description: PublicEndpointQuantization type definition -seoTitle: PublicEndpointQuantization Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/publicendpointquantization -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpointQuantization Type | OpenRouter TypeScript SDK -'og:description': >- - PublicEndpointQuantization type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpointQuantization%20-%20TypeScript%20SDK&description=PublicEndpointQuantization%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PublicEndpointQuantization } from "@openrouter/sdk/models"; - -let value: PublicEndpointQuantization = "fp16"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/publicpricing.mdx b/client-sdks/typescript/api-reference/models/publicpricing.mdx deleted file mode 100644 index 27c94ea5..00000000 --- a/client-sdks/typescript/api-reference/models/publicpricing.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: PublicPricing - TypeScript SDK -sidebarTitle: PublicPricing -description: PublicPricing type definition -seoTitle: PublicPricing Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/publicpricing' -'og:site_name': OpenRouter Documentation -'og:title': PublicPricing Type | OpenRouter TypeScript SDK -'og:description': >- - PublicPricing type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicPricing%20-%20TypeScript%20SDK&description=PublicPricing%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Pricing information for the model - -## Example Usage - -```typescript lines -import { PublicPricing } from "@openrouter/sdk/models"; - -let value: PublicPricing = { - completion: "0.00006", - prompt: "0.00003", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | -| `audio` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `audioOutput` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `completion` | *string* | :heavy_check_mark: | N/A | 1000 | -| `discount` | *number* | :heavy_minus_sign: | N/A | | -| `image` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `imageOutput` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `imageToken` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputAudioCache` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputCacheRead` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `internalReasoning` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `prompt` | *string* | :heavy_check_mark: | N/A | 1000 | -| `request` | *string* | :heavy_minus_sign: | N/A | 1000 | -| `webSearch` | *string* | :heavy_minus_sign: | N/A | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/quality.mdx b/client-sdks/typescript/api-reference/models/quality.mdx deleted file mode 100644 index 4c4606f4..00000000 --- a/client-sdks/typescript/api-reference/models/quality.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Quality - TypeScript SDK -sidebarTitle: Quality -description: Quality type definition -seoTitle: Quality Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/quality' -'og:site_name': OpenRouter Documentation -'og:title': Quality Type | OpenRouter TypeScript SDK -'og:description': >- - Quality type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quality%20-%20TypeScript%20SDK&description=Quality%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Quality } from "@openrouter/sdk/models"; - -let value: Quality = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"low" | "medium" | "high" | "auto" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/quantization.mdx b/client-sdks/typescript/api-reference/models/quantization.mdx deleted file mode 100644 index a979698f..00000000 --- a/client-sdks/typescript/api-reference/models/quantization.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Quantization - TypeScript SDK -sidebarTitle: Quantization -description: Quantization type definition -seoTitle: Quantization Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/quantization' -'og:site_name': OpenRouter Documentation -'og:title': Quantization Type | OpenRouter TypeScript SDK -'og:description': >- - Quantization type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantization%20-%20TypeScript%20SDK&description=Quantization%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Quantization } from "@openrouter/sdk/models"; - -let value: Quantization = "fp16"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/ranker.mdx b/client-sdks/typescript/api-reference/models/ranker.mdx deleted file mode 100644 index 71a5a2e2..00000000 --- a/client-sdks/typescript/api-reference/models/ranker.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Ranker - TypeScript SDK -sidebarTitle: Ranker -description: Ranker type definition -seoTitle: Ranker Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/ranker' -'og:site_name': OpenRouter Documentation -'og:title': Ranker Type | OpenRouter TypeScript SDK -'og:description': >- - Ranker type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ranker%20-%20TypeScript%20SDK&description=Ranker%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Ranker } from "@openrouter/sdk/models"; - -let value: Ranker = "default-2024-11-15"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "default-2024-11-15" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/rankingoptions.mdx b/client-sdks/typescript/api-reference/models/rankingoptions.mdx deleted file mode 100644 index 3a9b067b..00000000 --- a/client-sdks/typescript/api-reference/models/rankingoptions.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: RankingOptions - TypeScript SDK -sidebarTitle: RankingOptions -description: RankingOptions type definition -seoTitle: RankingOptions Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/rankingoptions' -'og:site_name': OpenRouter Documentation -'og:title': RankingOptions Type | OpenRouter TypeScript SDK -'og:description': >- - RankingOptions type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingOptions%20-%20TypeScript%20SDK&description=RankingOptions%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RankingOptions } from "@openrouter/sdk/models"; - -let value: RankingOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ranker` | [models.Ranker](/client-sdks/typescript/api-reference/models/ranker) | :heavy_minus_sign: | N/A | -| `scoreThreshold` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/rankingsdailyitem.mdx b/client-sdks/typescript/api-reference/models/rankingsdailyitem.mdx deleted file mode 100644 index 801bdca9..00000000 --- a/client-sdks/typescript/api-reference/models/rankingsdailyitem.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: RankingsDailyItem - TypeScript SDK -sidebarTitle: RankingsDailyItem -description: RankingsDailyItem type definition -seoTitle: RankingsDailyItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/rankingsdailyitem -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyItem Type | OpenRouter TypeScript SDK -'og:description': >- - RankingsDailyItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyItem%20-%20TypeScript%20SDK&description=RankingsDailyItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RankingsDailyItem } from "@openrouter/sdk/models"; - -let value: RankingsDailyItem = { - date: "2026-05-11", - modelPermaslug: "openai/gpt-4o-2024-05-13", - totalTokens: "12345678", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date` | *string* | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `totalTokens` | *string* | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/rankingsdailymeta.mdx b/client-sdks/typescript/api-reference/models/rankingsdailymeta.mdx deleted file mode 100644 index 1c650f91..00000000 --- a/client-sdks/typescript/api-reference/models/rankingsdailymeta.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: RankingsDailyMeta - TypeScript SDK -sidebarTitle: RankingsDailyMeta -description: RankingsDailyMeta type definition -seoTitle: RankingsDailyMeta Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/rankingsdailymeta -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyMeta Type | OpenRouter TypeScript SDK -'og:description': >- - RankingsDailyMeta type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyMeta%20-%20TypeScript%20SDK&description=RankingsDailyMeta%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RankingsDailyMeta } from "@openrouter/sdk/models"; - -let value: RankingsDailyMeta = { - asOf: "2026-05-12T02:00:00Z", - endDate: "2026-05-11", - startDate: "2026-04-12", - version: "v1", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00: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` | [models.Version](/client-sdks/typescript/api-reference/models/version) | :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/client-sdks/typescript/api-reference/models/rankingsdailyresponse.mdx b/client-sdks/typescript/api-reference/models/rankingsdailyresponse.mdx deleted file mode 100644 index fb9c8204..00000000 --- a/client-sdks/typescript/api-reference/models/rankingsdailyresponse.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: RankingsDailyResponse - TypeScript SDK -sidebarTitle: RankingsDailyResponse -description: RankingsDailyResponse type definition -seoTitle: RankingsDailyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/rankingsdailyresponse -'og:site_name': OpenRouter Documentation -'og:title': RankingsDailyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - RankingsDailyResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RankingsDailyResponse%20-%20TypeScript%20SDK&description=RankingsDailyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { RankingsDailyResponse } from "@openrouter/sdk/models"; - -let value: RankingsDailyResponse = { - data: [ - { - date: "2026-05-11", - modelPermaslug: "openai/gpt-4o-2024-05-13", - totalTokens: "12345678", - }, - { - date: "2026-05-11", - modelPermaslug: "anthropic/claude-3.5-sonnet-20241022", - totalTokens: "9876543", - }, - ], - meta: { - asOf: "2026-05-12T02:00:00Z", - endDate: "2026-05-11", - startDate: "2026-04-12", - version: "v1", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.RankingsDailyItem](/client-sdks/typescript/api-reference/models/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` | [models.RankingsDailyMeta](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/reason.mdx b/client-sdks/typescript/api-reference/models/reason.mdx deleted file mode 100644 index 2bca5a89..00000000 --- a/client-sdks/typescript/api-reference/models/reason.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Reason - TypeScript SDK -sidebarTitle: Reason -description: Reason type definition -seoTitle: Reason Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/reason' -'og:site_name': OpenRouter Documentation -'og:title': Reason Type | OpenRouter TypeScript SDK -'og:description': >- - Reason type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reason%20-%20TypeScript%20SDK&description=Reason%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Reason } from "@openrouter/sdk/models"; - -let value: Reason = "content_filter"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"max_output_tokens" | "content_filter" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningconfig.mdx b/client-sdks/typescript/api-reference/models/reasoningconfig.mdx deleted file mode 100644 index 5a11c657..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningconfig.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ReasoningConfig - TypeScript SDK -sidebarTitle: ReasoningConfig -description: ReasoningConfig type definition -seoTitle: ReasoningConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': ReasoningConfig Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningConfig%20-%20TypeScript%20SDK&description=ReasoningConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for reasoning mode in the response - -## Example Usage - -```typescript lines -import { ReasoningConfig } from "@openrouter/sdk/models"; - -let value: ReasoningConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `effort` | [models.ReasoningEffort](/client-sdks/typescript/api-reference/models/reasoningeffort) | :heavy_minus_sign: | N/A | medium | -| `summary` | [models.ReasoningSummaryVerbosity](/client-sdks/typescript/api-reference/models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | auto | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdeltaevent.mdx b/client-sdks/typescript/api-reference/models/reasoningdeltaevent.mdx deleted file mode 100644 index aef37576..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdeltaevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ReasoningDeltaEvent - TypeScript SDK -sidebarTitle: ReasoningDeltaEvent -description: ReasoningDeltaEvent type definition -seoTitle: ReasoningDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDeltaEvent type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDeltaEvent%20-%20TypeScript%20SDK&description=ReasoningDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text delta is streamed - -## Example Usage - -```typescript lines -import { ReasoningDeltaEvent } from "@openrouter/sdk/models"; - -let value: ReasoningDeltaEvent = { - contentIndex: 744455, - delta: "", - itemId: "", - outputIndex: 904446, - sequenceNumber: 0, - type: "response.reasoning_text.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdetailencrypted.mdx b/client-sdks/typescript/api-reference/models/reasoningdetailencrypted.mdx deleted file mode 100644 index 6a1730be..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdetailencrypted.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ReasoningDetailEncrypted - TypeScript SDK -sidebarTitle: ReasoningDetailEncrypted -description: ReasoningDetailEncrypted type definition -seoTitle: ReasoningDetailEncrypted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdetailencrypted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailEncrypted Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDetailEncrypted type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailEncrypted%20-%20TypeScript%20SDK&description=ReasoningDetailEncrypted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning detail encrypted schema - -## Example Usage - -```typescript lines -import { ReasoningDetailEncrypted } from "@openrouter/sdk/models"; - -let value: ReasoningDetailEncrypted = { - data: "", - type: "reasoning.encrypted", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `type` | *"reasoning.encrypted"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdetailsummary.mdx b/client-sdks/typescript/api-reference/models/reasoningdetailsummary.mdx deleted file mode 100644 index 5608ed69..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdetailsummary.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ReasoningDetailSummary - TypeScript SDK -sidebarTitle: ReasoningDetailSummary -description: ReasoningDetailSummary type definition -seoTitle: ReasoningDetailSummary Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdetailsummary -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailSummary Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDetailSummary type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailSummary%20-%20TypeScript%20SDK&description=ReasoningDetailSummary%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning detail summary schema - -## Example Usage - -```typescript lines -import { ReasoningDetailSummary } from "@openrouter/sdk/models"; - -let value: ReasoningDetailSummary = { - summary: - "The model analyzed the problem by first identifying key constraints, then evaluating possible solutions...", - type: "reasoning.summary", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `summary` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"reasoning.summary"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdetailtext.mdx b/client-sdks/typescript/api-reference/models/reasoningdetailtext.mdx deleted file mode 100644 index 1c04035a..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdetailtext.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ReasoningDetailText - TypeScript SDK -sidebarTitle: ReasoningDetailText -description: ReasoningDetailText type definition -seoTitle: ReasoningDetailText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdetailtext -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailText Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDetailText type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailText%20-%20TypeScript%20SDK&description=ReasoningDetailText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning detail text schema - -## Example Usage - -```typescript lines -import { ReasoningDetailText } from "@openrouter/sdk/models"; - -let value: ReasoningDetailText = { - type: "reasoning.text", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | N/A | | -| `text` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *"reasoning.text"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdetailunion.mdx b/client-sdks/typescript/api-reference/models/reasoningdetailunion.mdx deleted file mode 100644 index e86489b3..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdetailunion.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ReasoningDetailUnion - TypeScript SDK -sidebarTitle: ReasoningDetailUnion -description: ReasoningDetailUnion type definition -seoTitle: ReasoningDetailUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdetailunion -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDetailUnion Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDetailUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDetailUnion%20-%20TypeScript%20SDK&description=ReasoningDetailUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning detail union schema - -## Supported Types - -### `models.ReasoningDetailEncrypted` - -```typescript lines -const value: models.ReasoningDetailEncrypted = { - data: "", - type: "reasoning.encrypted", -}; -``` - -### `models.ReasoningDetailSummary` - -```typescript lines -const value: models.ReasoningDetailSummary = { - summary: - "The model analyzed the problem by first identifying key constraints, then evaluating possible solutions...", - type: "reasoning.summary", -}; -``` - -### `models.ReasoningDetailText` - -```typescript lines -const value: models.ReasoningDetailText = { - type: "reasoning.text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningdoneevent.mdx b/client-sdks/typescript/api-reference/models/reasoningdoneevent.mdx deleted file mode 100644 index 886464b2..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningdoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ReasoningDoneEvent - TypeScript SDK -sidebarTitle: ReasoningDoneEvent -description: ReasoningDoneEvent type definition -seoTitle: ReasoningDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningDoneEvent type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningDoneEvent%20-%20TypeScript%20SDK&description=ReasoningDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text streaming is complete - -## Example Usage - -```typescript lines -import { ReasoningDoneEvent } from "@openrouter/sdk/models"; - -let value: ReasoningDoneEvent = { - contentIndex: 789397, - itemId: "", - outputIndex: 602802, - sequenceNumber: 0, - text: "", - type: "response.reasoning_text.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningeffort.mdx b/client-sdks/typescript/api-reference/models/reasoningeffort.mdx deleted file mode 100644 index 42026e9f..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningeffort.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningEffort - TypeScript SDK -sidebarTitle: ReasoningEffort -description: ReasoningEffort type definition -seoTitle: ReasoningEffort Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningeffort -'og:site_name': OpenRouter Documentation -'og:title': ReasoningEffort Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningEffort type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningEffort%20-%20TypeScript%20SDK&description=ReasoningEffort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningEffort } from "@openrouter/sdk/models"; - -let value: ReasoningEffort = "medium"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"xhigh" | "high" | "medium" | "low" | "minimal" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningformat.mdx b/client-sdks/typescript/api-reference/models/reasoningformat.mdx deleted file mode 100644 index ed1002f5..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningformat.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningFormat - TypeScript SDK -sidebarTitle: ReasoningFormat -description: ReasoningFormat type definition -seoTitle: ReasoningFormat Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningformat -'og:site_name': OpenRouter Documentation -'og:title': ReasoningFormat Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningFormat type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningFormat%20-%20TypeScript%20SDK&description=ReasoningFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningFormat } from "@openrouter/sdk/models"; - -let value: ReasoningFormat = "unknown"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"unknown" | "openai-responses-v1" | "azure-openai-responses-v1" | "xai-responses-v1" | "anthropic-claude-v1" | "google-gemini-v1" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitem.mdx b/client-sdks/typescript/api-reference/models/reasoningitem.mdx deleted file mode 100644 index d421bb3b..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitem.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ReasoningItem - TypeScript SDK -sidebarTitle: ReasoningItem -description: ReasoningItem type definition -seoTitle: ReasoningItem Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/reasoningitem' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItem Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItem type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItem%20-%20TypeScript%20SDK&description=ReasoningItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning output item with signature and format extensions - -## Example Usage - -```typescript lines -import { ReasoningItem } from "@openrouter/sdk/models"; - -let value: ReasoningItem = { - id: "reasoning-abc123", - summary: [ - { - text: "Step by step analysis", - type: "summary_text", - }, - ], - type: "reasoning", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](/client-sdks/typescript/api-reference/models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.ReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](/client-sdks/typescript/api-reference/models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | -| `type` | [models.ReasoningItemType](/client-sdks/typescript/api-reference/models/reasoningitemtype) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](/client-sdks/typescript/api-reference/models/reasoningformat) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitemstatuscompleted.mdx b/client-sdks/typescript/api-reference/models/reasoningitemstatuscompleted.mdx deleted file mode 100644 index e1e73a65..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitemstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItemStatusCompleted - TypeScript SDK -sidebarTitle: ReasoningItemStatusCompleted -description: ReasoningItemStatusCompleted type definition -seoTitle: ReasoningItemStatusCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningitemstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItemStatusCompleted type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusCompleted%20-%20TypeScript%20SDK&description=ReasoningItemStatusCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningItemStatusCompleted } from "@openrouter/sdk/models"; - -let value: ReasoningItemStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitemstatusincomplete.mdx b/client-sdks/typescript/api-reference/models/reasoningitemstatusincomplete.mdx deleted file mode 100644 index 3c409a69..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitemstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItemStatusIncomplete - TypeScript SDK -sidebarTitle: ReasoningItemStatusIncomplete -description: ReasoningItemStatusIncomplete type definition -seoTitle: ReasoningItemStatusIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningitemstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItemStatusIncomplete type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusIncomplete%20-%20TypeScript%20SDK&description=ReasoningItemStatusIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningItemStatusIncomplete } from "@openrouter/sdk/models"; - -let value: ReasoningItemStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitemstatusinprogress.mdx b/client-sdks/typescript/api-reference/models/reasoningitemstatusinprogress.mdx deleted file mode 100644 index 91393a5a..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitemstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItemStatusInProgress - TypeScript SDK -sidebarTitle: ReasoningItemStatusInProgress -description: ReasoningItemStatusInProgress type definition -seoTitle: ReasoningItemStatusInProgress Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningitemstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusInProgress Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItemStatusInProgress type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusInProgress%20-%20TypeScript%20SDK&description=ReasoningItemStatusInProgress%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningItemStatusInProgress } from "@openrouter/sdk/models"; - -let value: ReasoningItemStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitemstatusunion.mdx b/client-sdks/typescript/api-reference/models/reasoningitemstatusunion.mdx deleted file mode 100644 index 14fb9a59..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitemstatusunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ReasoningItemStatusUnion - TypeScript SDK -sidebarTitle: ReasoningItemStatusUnion -description: ReasoningItemStatusUnion type definition -seoTitle: ReasoningItemStatusUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningitemstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemStatusUnion Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItemStatusUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemStatusUnion%20-%20TypeScript%20SDK&description=ReasoningItemStatusUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ReasoningItemStatusCompleted` - -```typescript lines -const value: models.ReasoningItemStatusCompleted = "completed"; -``` - -### `models.ReasoningItemStatusIncomplete` - -```typescript lines -const value: models.ReasoningItemStatusIncomplete = "incomplete"; -``` - -### `models.ReasoningItemStatusInProgress` - -```typescript lines -const value: models.ReasoningItemStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningitemtype.mdx b/client-sdks/typescript/api-reference/models/reasoningitemtype.mdx deleted file mode 100644 index 6ce506f4..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningItemType - TypeScript SDK -sidebarTitle: ReasoningItemType -description: ReasoningItemType type definition -seoTitle: ReasoningItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningitemtype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningItemType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningItemType%20-%20TypeScript%20SDK&description=ReasoningItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningItemType } from "@openrouter/sdk/models"; - -let value: ReasoningItemType = "reasoning"; -``` - -## Values - -```typescript lines -"reasoning" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarypartaddedevent.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarypartaddedevent.mdx deleted file mode 100644 index 26bfaf47..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarypartaddedevent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ReasoningSummaryPartAddedEvent - TypeScript SDK -sidebarTitle: ReasoningSummaryPartAddedEvent -description: ReasoningSummaryPartAddedEvent type definition -seoTitle: ReasoningSummaryPartAddedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarypartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartAddedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryPartAddedEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartAddedEvent%20-%20TypeScript%20SDK&description=ReasoningSummaryPartAddedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is added - -## Example Usage - -```typescript lines -import { ReasoningSummaryPartAddedEvent } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryPartAddedEvent = { - itemId: "", - outputIndex: 648271, - part: { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - sequenceNumber: 0, - summaryIndex: 773896, - type: "response.reasoning_summary_part.added", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](/client-sdks/typescript/api-reference/models/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"text": "Analyzed the problem using first principles","type": "summary_text"}` | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.reasoning_summary_part.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarypartdoneevent.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarypartdoneevent.mdx deleted file mode 100644 index f7ad8df6..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarypartdoneevent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ReasoningSummaryPartDoneEvent - TypeScript SDK -sidebarTitle: ReasoningSummaryPartDoneEvent -description: ReasoningSummaryPartDoneEvent type definition -seoTitle: ReasoningSummaryPartDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarypartdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryPartDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryPartDoneEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryPartDoneEvent%20-%20TypeScript%20SDK&description=ReasoningSummaryPartDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is complete - -## Example Usage - -```typescript lines -import { ReasoningSummaryPartDoneEvent } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryPartDoneEvent = { - itemId: "", - outputIndex: 686718, - part: { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - sequenceNumber: 0, - summaryIndex: 477332, - type: "response.reasoning_summary_part.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](/client-sdks/typescript/api-reference/models/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"text": "Analyzed the problem using first principles","type": "summary_text"}` | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.reasoning_summary_part.done"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarytext.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarytext.mdx deleted file mode 100644 index 9eab1c70..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarytext.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ReasoningSummaryText - TypeScript SDK -sidebarTitle: ReasoningSummaryText -description: ReasoningSummaryText type definition -seoTitle: ReasoningSummaryText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarytext -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryText Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryText type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryText%20-%20TypeScript%20SDK&description=ReasoningSummaryText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryText } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryText = { - text: "Analyzed the problem using first principles", - type: "summary_text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningSummaryTextType](/client-sdks/typescript/api-reference/models/reasoningsummarytexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarytextdeltaevent.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarytextdeltaevent.mdx deleted file mode 100644 index 93663d17..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarytextdeltaevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ReasoningSummaryTextDeltaEvent - TypeScript SDK -sidebarTitle: ReasoningSummaryTextDeltaEvent -description: ReasoningSummaryTextDeltaEvent type definition -seoTitle: ReasoningSummaryTextDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarytextdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryTextDeltaEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDeltaEvent%20-%20TypeScript%20SDK&description=ReasoningSummaryTextDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text delta is streamed - -## Example Usage - -```typescript lines -import { ReasoningSummaryTextDeltaEvent } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryTextDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 326373, - sequenceNumber: 0, - summaryIndex: 214954, - type: "response.reasoning_summary_text.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_summary_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarytextdoneevent.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarytextdoneevent.mdx deleted file mode 100644 index b2d3931a..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarytextdoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ReasoningSummaryTextDoneEvent - TypeScript SDK -sidebarTitle: ReasoningSummaryTextDoneEvent -description: ReasoningSummaryTextDoneEvent type definition -seoTitle: ReasoningSummaryTextDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarytextdoneevent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryTextDoneEvent type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextDoneEvent%20-%20TypeScript%20SDK&description=ReasoningSummaryTextDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text streaming is complete - -## Example Usage - -```typescript lines -import { ReasoningSummaryTextDoneEvent } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryTextDoneEvent = { - itemId: "", - outputIndex: 239944, - sequenceNumber: 0, - summaryIndex: 543197, - text: "", - type: "response.reasoning_summary_text.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_summary_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummarytexttype.mdx b/client-sdks/typescript/api-reference/models/reasoningsummarytexttype.mdx deleted file mode 100644 index f5bbc5a9..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummarytexttype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningSummaryTextType - TypeScript SDK -sidebarTitle: ReasoningSummaryTextType -description: ReasoningSummaryTextType type definition -seoTitle: ReasoningSummaryTextType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummarytexttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextType Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryTextType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextType%20-%20TypeScript%20SDK&description=ReasoningSummaryTextType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryTextType } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryTextType = "summary_text"; -``` - -## Values - -```typescript lines -"summary_text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningsummaryverbosity.mdx b/client-sdks/typescript/api-reference/models/reasoningsummaryverbosity.mdx deleted file mode 100644 index ceac8829..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningsummaryverbosity.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryVerbosity - TypeScript SDK -sidebarTitle: ReasoningSummaryVerbosity -description: ReasoningSummaryVerbosity type definition -seoTitle: ReasoningSummaryVerbosity Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningsummaryverbosity -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryVerbosity Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryVerbosity type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryVerbosity%20-%20TypeScript%20SDK&description=ReasoningSummaryVerbosity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryVerbosity } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryVerbosity = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "concise" | "detailed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningtextcontent.mdx b/client-sdks/typescript/api-reference/models/reasoningtextcontent.mdx deleted file mode 100644 index 831261e3..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningtextcontent.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ReasoningTextContent - TypeScript SDK -sidebarTitle: ReasoningTextContent -description: ReasoningTextContent type definition -seoTitle: ReasoningTextContent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningtextcontent -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContent Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningTextContent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContent%20-%20TypeScript%20SDK&description=ReasoningTextContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningTextContent } from "@openrouter/sdk/models"; - -let value: ReasoningTextContent = { - text: "Let me think step by step about this problem...", - type: "reasoning_text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningTextContentType](/client-sdks/typescript/api-reference/models/reasoningtextcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/reasoningtextcontenttype.mdx b/client-sdks/typescript/api-reference/models/reasoningtextcontenttype.mdx deleted file mode 100644 index ea6f8090..00000000 --- a/client-sdks/typescript/api-reference/models/reasoningtextcontenttype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningTextContentType - TypeScript SDK -sidebarTitle: ReasoningTextContentType -description: ReasoningTextContentType type definition -seoTitle: ReasoningTextContentType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/reasoningtextcontenttype -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContentType Type | OpenRouter TypeScript SDK -'og:description': >- - ReasoningTextContentType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContentType%20-%20TypeScript%20SDK&description=ReasoningTextContentType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningTextContentType } from "@openrouter/sdk/models"; - -let value: ReasoningTextContentType = "reasoning_text"; -``` - -## Values - -```typescript lines -"reasoning_text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/refusaldeltaevent.mdx b/client-sdks/typescript/api-reference/models/refusaldeltaevent.mdx deleted file mode 100644 index 6f86bd8c..00000000 --- a/client-sdks/typescript/api-reference/models/refusaldeltaevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: RefusalDeltaEvent - TypeScript SDK -sidebarTitle: RefusalDeltaEvent -description: RefusalDeltaEvent type definition -seoTitle: RefusalDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/refusaldeltaevent -'og:site_name': OpenRouter Documentation -'og:title': RefusalDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - RefusalDeltaEvent type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDeltaEvent%20-%20TypeScript%20SDK&description=RefusalDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a refusal delta is streamed - -## Example Usage - -```typescript lines -import { RefusalDeltaEvent } from "@openrouter/sdk/models"; - -let value: RefusalDeltaEvent = { - contentIndex: 217319, - delta: "", - itemId: "", - outputIndex: 604749, - sequenceNumber: 0, - type: "response.refusal.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.refusal.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/refusaldoneevent.mdx b/client-sdks/typescript/api-reference/models/refusaldoneevent.mdx deleted file mode 100644 index 32c4de14..00000000 --- a/client-sdks/typescript/api-reference/models/refusaldoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: RefusalDoneEvent - TypeScript SDK -sidebarTitle: RefusalDoneEvent -description: RefusalDoneEvent type definition -seoTitle: RefusalDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/refusaldoneevent -'og:site_name': OpenRouter Documentation -'og:title': RefusalDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - RefusalDoneEvent type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RefusalDoneEvent%20-%20TypeScript%20SDK&description=RefusalDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when refusal streaming is complete - -## Example Usage - -```typescript lines -import { RefusalDoneEvent } from "@openrouter/sdk/models"; - -let value: RefusalDoneEvent = { - contentIndex: 882616, - itemId: "", - outputIndex: 641081, - refusal: "", - sequenceNumber: 0, - type: "response.refusal.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.refusal.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/region.mdx b/client-sdks/typescript/api-reference/models/region.mdx deleted file mode 100644 index 67b4537f..00000000 --- a/client-sdks/typescript/api-reference/models/region.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Region - TypeScript SDK -sidebarTitle: Region -description: Region type definition -seoTitle: Region Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/region' -'og:site_name': OpenRouter Documentation -'og:title': Region Type | OpenRouter TypeScript SDK -'og:description': >- - Region type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Region%20-%20TypeScript%20SDK&description=Region%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Region } from "@openrouter/sdk/models"; - -let value: Region = "us"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"us" | "eu" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/requesttimeoutresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/requesttimeoutresponseerrordata.mdx deleted file mode 100644 index 8327edab..00000000 --- a/client-sdks/typescript/api-reference/models/requesttimeoutresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: RequestTimeoutResponseErrorData - TypeScript SDK -sidebarTitle: RequestTimeoutResponseErrorData -description: RequestTimeoutResponseErrorData type definition -seoTitle: RequestTimeoutResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/requesttimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - RequestTimeoutResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseErrorData%20-%20TypeScript%20SDK&description=RequestTimeoutResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for RequestTimeoutResponse - -## Example Usage - -```typescript lines -import { RequestTimeoutResponseErrorData } from "@openrouter/sdk/models"; - -let value: RequestTimeoutResponseErrorData = { - code: 408, - message: "Operation timed out. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/requireapproval.mdx b/client-sdks/typescript/api-reference/models/requireapproval.mdx deleted file mode 100644 index 418e235b..00000000 --- a/client-sdks/typescript/api-reference/models/requireapproval.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RequireApproval - TypeScript SDK -sidebarTitle: RequireApproval -description: RequireApproval type definition -seoTitle: RequireApproval Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/requireapproval -'og:site_name': OpenRouter Documentation -'og:title': RequireApproval Type | OpenRouter TypeScript SDK -'og:description': >- - RequireApproval type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApproval%20-%20TypeScript%20SDK&description=RequireApproval%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RequireApproval } from "@openrouter/sdk/models"; - -let value: RequireApproval = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `always` | [models.Always](/client-sdks/typescript/api-reference/models/always) | :heavy_minus_sign: | N/A | -| `never` | [models.Never](/client-sdks/typescript/api-reference/models/never) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/requireapprovalalways.mdx b/client-sdks/typescript/api-reference/models/requireapprovalalways.mdx deleted file mode 100644 index ca9f19a5..00000000 --- a/client-sdks/typescript/api-reference/models/requireapprovalalways.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: RequireApprovalAlways - TypeScript SDK -sidebarTitle: RequireApprovalAlways -description: RequireApprovalAlways type definition -seoTitle: RequireApprovalAlways Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/requireapprovalalways -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalAlways Type | OpenRouter TypeScript SDK -'og:description': >- - RequireApprovalAlways type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalAlways%20-%20TypeScript%20SDK&description=RequireApprovalAlways%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RequireApprovalAlways } from "@openrouter/sdk/models"; - -let value: RequireApprovalAlways = "always"; -``` - -## Values - -```typescript lines -"always" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/requireapprovalnever.mdx b/client-sdks/typescript/api-reference/models/requireapprovalnever.mdx deleted file mode 100644 index bc0d00ca..00000000 --- a/client-sdks/typescript/api-reference/models/requireapprovalnever.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: RequireApprovalNever - TypeScript SDK -sidebarTitle: RequireApprovalNever -description: RequireApprovalNever type definition -seoTitle: RequireApprovalNever Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/requireapprovalnever -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalNever Type | OpenRouter TypeScript SDK -'og:description': >- - RequireApprovalNever type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalNever%20-%20TypeScript%20SDK&description=RequireApprovalNever%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RequireApprovalNever } from "@openrouter/sdk/models"; - -let value: RequireApprovalNever = "never"; -``` - -## Values - -```typescript lines -"never" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/requireapprovalunion.mdx b/client-sdks/typescript/api-reference/models/requireapprovalunion.mdx deleted file mode 100644 index 4c1ec475..00000000 --- a/client-sdks/typescript/api-reference/models/requireapprovalunion.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: RequireApprovalUnion - TypeScript SDK -sidebarTitle: RequireApprovalUnion -description: RequireApprovalUnion type definition -seoTitle: RequireApprovalUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/requireapprovalunion -'og:site_name': OpenRouter Documentation -'og:title': RequireApprovalUnion Type | OpenRouter TypeScript SDK -'og:description': >- - RequireApprovalUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequireApprovalUnion%20-%20TypeScript%20SDK&description=RequireApprovalUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.RequireApproval` - -```typescript lines -const value: models.RequireApproval = {}; -``` - -### `models.RequireApprovalAlways` - -```typescript lines -const value: models.RequireApprovalAlways = "always"; -``` - -### `models.RequireApprovalNever` - -```typescript lines -const value: models.RequireApprovalNever = "never"; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/resolution.mdx b/client-sdks/typescript/api-reference/models/resolution.mdx deleted file mode 100644 index 585f1f7f..00000000 --- a/client-sdks/typescript/api-reference/models/resolution.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Resolution - TypeScript SDK -sidebarTitle: Resolution -description: Resolution type definition -seoTitle: Resolution Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/resolution' -'og:site_name': OpenRouter Documentation -'og:title': Resolution Type | OpenRouter TypeScript SDK -'og:description': >- - Resolution type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Resolution%20-%20TypeScript%20SDK&description=Resolution%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Resolution of the generated video - -## Example Usage - -```typescript lines -import { Resolution } from "@openrouter/sdk/models"; - -let value: Resolution = "720p"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"480p" | "720p" | "1080p" | "1K" | "2K" | "4K" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseformat.mdx b/client-sdks/typescript/api-reference/models/responseformat.mdx deleted file mode 100644 index 81e33449..00000000 --- a/client-sdks/typescript/api-reference/models/responseformat.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: ResponseFormat - TypeScript SDK -sidebarTitle: ResponseFormat -description: ResponseFormat type definition -seoTitle: ResponseFormat Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/responseformat' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormat Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseFormat type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormat%20-%20TypeScript%20SDK&description=ResponseFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Response format configuration - -## Supported Types - -### `models.ChatFormatGrammarConfig` - -```typescript lines -const value: models.ChatFormatGrammarConfig = { - grammar: "root ::= \"yes\" | \"no\"", - type: "grammar", -}; -``` - -### `models.FormatJsonObjectConfig` - -```typescript lines -const value: models.FormatJsonObjectConfig = { - type: "json_object", -}; -``` - -### `models.ChatFormatJsonSchemaConfig` - -```typescript lines -const value: models.ChatFormatJsonSchemaConfig = { - jsonSchema: { - name: "math_response", - }, - type: "json_schema", -}; -``` - -### `models.ChatFormatPythonConfig` - -```typescript lines -const value: models.ChatFormatPythonConfig = { - type: "python", -}; -``` - -### `models.ChatFormatTextConfig` - -```typescript lines -const value: models.ChatFormatTextConfig = { - type: "text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseformatenum.mdx b/client-sdks/typescript/api-reference/models/responseformatenum.mdx deleted file mode 100644 index ca60d155..00000000 --- a/client-sdks/typescript/api-reference/models/responseformatenum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponseFormatEnum - TypeScript SDK -sidebarTitle: ResponseFormatEnum -description: ResponseFormatEnum type definition -seoTitle: ResponseFormatEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responseformatenum -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseFormatEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatEnum%20-%20TypeScript%20SDK&description=ResponseFormatEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Audio output format - -## Example Usage - -```typescript lines -import { ResponseFormatEnum } from "@openrouter/sdk/models"; - -let value: ResponseFormatEnum = "pcm"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"mp3" | "pcm" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsehealingplugin.mdx b/client-sdks/typescript/api-reference/models/responsehealingplugin.mdx deleted file mode 100644 index 1814e54a..00000000 --- a/client-sdks/typescript/api-reference/models/responsehealingplugin.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ResponseHealingPlugin - TypeScript SDK -sidebarTitle: ResponseHealingPlugin -description: ResponseHealingPlugin type definition -seoTitle: ResponseHealingPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsehealingplugin -'og:site_name': OpenRouter Documentation -'og:title': ResponseHealingPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseHealingPlugin type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseHealingPlugin%20-%20TypeScript%20SDK&description=ResponseHealingPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseHealingPlugin } from "@openrouter/sdk/models"; - -let value: ResponseHealingPlugin = { - id: "response-healing", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `id` | *"response-healing"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseincludesenum.mdx b/client-sdks/typescript/api-reference/models/responseincludesenum.mdx deleted file mode 100644 index dab66679..00000000 --- a/client-sdks/typescript/api-reference/models/responseincludesenum.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponseIncludesEnum - TypeScript SDK -sidebarTitle: ResponseIncludesEnum -description: ResponseIncludesEnum type definition -seoTitle: ResponseIncludesEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responseincludesenum -'og:site_name': OpenRouter Documentation -'og:title': ResponseIncludesEnum Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseIncludesEnum type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseIncludesEnum%20-%20TypeScript%20SDK&description=ResponseIncludesEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseIncludesEnum } from "@openrouter/sdk/models"; - -let value: ResponseIncludesEnum = "file_search_call.results"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"file_search_call.results" | "message.input_image.image_url" | "computer_call_output.output.image_url" | "reasoning.encrypted_content" | "code_interpreter_call.outputs" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseoutputtext.mdx b/client-sdks/typescript/api-reference/models/responseoutputtext.mdx deleted file mode 100644 index 943a1d12..00000000 --- a/client-sdks/typescript/api-reference/models/responseoutputtext.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ResponseOutputText - TypeScript SDK -sidebarTitle: ResponseOutputText -description: ResponseOutputText type definition -seoTitle: ResponseOutputText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responseoutputtext -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputText Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseOutputText type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputText%20-%20TypeScript%20SDK&description=ResponseOutputText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseOutputText } from "@openrouter/sdk/models"; - -let value: ResponseOutputText = { - text: "The capital of France is Paris.", - type: "output_text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `annotations` | *models.OpenAIResponsesAnnotation*[] | :heavy_minus_sign: | N/A | -| `logprobs` | [models.Logprob](/client-sdks/typescript/api-reference/models/logprob)[] | :heavy_minus_sign: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"output_text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseoutputtexttoplogprob.mdx b/client-sdks/typescript/api-reference/models/responseoutputtexttoplogprob.mdx deleted file mode 100644 index 9bbd26cc..00000000 --- a/client-sdks/typescript/api-reference/models/responseoutputtexttoplogprob.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ResponseOutputTextTopLogprob - TypeScript SDK -sidebarTitle: ResponseOutputTextTopLogprob -description: ResponseOutputTextTopLogprob type definition -seoTitle: ResponseOutputTextTopLogprob Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responseoutputtexttoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextTopLogprob Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseOutputTextTopLogprob type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextTopLogprob%20-%20TypeScript%20SDK&description=ResponseOutputTextTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseOutputTextTopLogprob } from "@openrouter/sdk/models"; - -let value: ResponseOutputTextTopLogprob = { - bytes: [ - 303617, - 34414, - ], - logprob: 1976.4, - token: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responseserrorfield.mdx b/client-sdks/typescript/api-reference/models/responseserrorfield.mdx deleted file mode 100644 index 05751253..00000000 --- a/client-sdks/typescript/api-reference/models/responseserrorfield.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ResponsesErrorField - TypeScript SDK -sidebarTitle: ResponsesErrorField -description: ResponsesErrorField type definition -seoTitle: ResponsesErrorField Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responseserrorfield -'og:site_name': OpenRouter Documentation -'og:title': ResponsesErrorField Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesErrorField type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesErrorField%20-%20TypeScript%20SDK&description=ResponsesErrorField%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error information returned from the API - -## Example Usage - -```typescript lines -import { ResponsesErrorField } from "@openrouter/sdk/models"; - -let value: ResponsesErrorField = { - code: "rate_limit_exceeded", - message: "Rate limit exceeded. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `code` | [models.Code](/client-sdks/typescript/api-reference/models/code) | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsesrequest.mdx b/client-sdks/typescript/api-reference/models/responsesrequest.mdx deleted file mode 100644 index 04baa033..00000000 --- a/client-sdks/typescript/api-reference/models/responsesrequest.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: ResponsesRequest - TypeScript SDK -sidebarTitle: ResponsesRequest -description: ResponsesRequest type definition -seoTitle: ResponsesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesrequest -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequest%20-%20TypeScript%20SDK&description=ResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request schema for Responses endpoint - -## Example Usage - -```typescript lines -import { ResponsesRequest } from "@openrouter/sdk/models"; - -let value: ResponsesRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | | -| `imageConfig` | `Record` | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | `{"aspect_ratio": "16:9","quality": "high"}` | -| `include` | [models.ResponseIncludesEnum](/client-sdks/typescript/api-reference/models/responseincludesenum)[] | :heavy_minus_sign: | N/A | | -| `input` | *models.InputsUnion* | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
`{"content": "What is the weather today?","role": "user"}`
] | -| `instructions` | *string* | :heavy_minus_sign: | N/A | | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | -| `metadata` | `Record` | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | `{"session_id": "abc-def-ghi","user_id": "123"}` | -| `modalities` | [models.OutputModalityEnum](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_minus_sign: | N/A | | -| `plugins` | *models.ResponsesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | | -| `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | [models.StoredPromptTemplate](/client-sdks/typescript/api-reference/models/storedprompttemplate) | :heavy_minus_sign: | N/A | `{"id": "prompt-abc123","variables": {"name": "John"}`
\} | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/api-reference/models/providerpreferences) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | `{"allow_fallbacks": true}` | -| `reasoning` | [models.ReasoningConfig](/client-sdks/typescript/api-reference/models/reasoningconfig) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"enabled": true,"summary": "auto"}` | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | -| `serviceTier` | [models.ResponsesRequestServiceTier](/client-sdks/typescript/api-reference/models/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` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. | [
`{"step_count": 5,"type": "step_count_is"}`,
`{"max_cost_in_dollars": 0.5,"type": "max_cost"}`
] | -| `store` | *false* | :heavy_minus_sign: | N/A | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `text` | [models.TextExtendedConfig](/client-sdks/typescript/api-reference/models/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`
\} | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_minus_sign: | N/A | auto | -| `tools` | *models.ResponsesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | -| `topK` | *number* | :heavy_minus_sign: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](/client-sdks/typescript/api-reference/models/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` | [models.OpenAIResponsesTruncation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/responsesrequestplugin.mdx b/client-sdks/typescript/api-reference/models/responsesrequestplugin.mdx deleted file mode 100644 index d28fdfaf..00000000 --- a/client-sdks/typescript/api-reference/models/responsesrequestplugin.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: ResponsesRequestPlugin - TypeScript SDK -sidebarTitle: ResponsesRequestPlugin -description: ResponsesRequestPlugin type definition -seoTitle: ResponsesRequestPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesrequestplugin -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesRequestPlugin type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestPlugin%20-%20TypeScript%20SDK&description=ResponsesRequestPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AutoRouterPlugin` - -```typescript lines -const value: models.AutoRouterPlugin = { - id: "auto-router", -}; -``` - -### `models.ContextCompressionPlugin` - -```typescript lines -const value: models.ContextCompressionPlugin = { - id: "context-compression", -}; -``` - -### `models.FileParserPlugin` - -```typescript lines -const value: models.FileParserPlugin = { - id: "file-parser", -}; -``` - -### `models.FusionPlugin` - -```typescript lines -const value: models.FusionPlugin = { - id: "fusion", -}; -``` - -### `models.ModerationPlugin` - -```typescript lines -const value: models.ModerationPlugin = { - id: "moderation", -}; -``` - -### `models.ParetoRouterPlugin` - -```typescript lines -const value: models.ParetoRouterPlugin = { - id: "pareto-router", -}; -``` - -### `models.ResponseHealingPlugin` - -```typescript lines -const value: models.ResponseHealingPlugin = { - id: "response-healing", -}; -``` - -### `models.WebSearchPlugin` - -```typescript lines -const value: models.WebSearchPlugin = { - id: "web", -}; -``` - -### `models.WebFetchPlugin` - -```typescript lines -const value: models.WebFetchPlugin = { - id: "web-fetch", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsesrequestservicetier.mdx b/client-sdks/typescript/api-reference/models/responsesrequestservicetier.mdx deleted file mode 100644 index 7b71ede6..00000000 --- a/client-sdks/typescript/api-reference/models/responsesrequestservicetier.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponsesRequestServiceTier - TypeScript SDK -sidebarTitle: ResponsesRequestServiceTier -description: ResponsesRequestServiceTier type definition -seoTitle: ResponsesRequestServiceTier Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesrequestservicetier -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestServiceTier Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesRequestServiceTier type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestServiceTier%20-%20TypeScript%20SDK&description=ResponsesRequestServiceTier%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesRequestServiceTier } from "@openrouter/sdk/models"; - -let value: ResponsesRequestServiceTier = "scale"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "default" | "flex" | "priority" | "scale" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsesrequesttoolfunction.mdx b/client-sdks/typescript/api-reference/models/responsesrequesttoolfunction.mdx deleted file mode 100644 index 169d78ea..00000000 --- a/client-sdks/typescript/api-reference/models/responsesrequesttoolfunction.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: ResponsesRequestToolFunction - TypeScript SDK -sidebarTitle: ResponsesRequestToolFunction -description: ResponsesRequestToolFunction type definition -seoTitle: ResponsesRequestToolFunction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesrequesttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolFunction Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesRequestToolFunction type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolFunction%20-%20TypeScript%20SDK&description=ResponsesRequestToolFunction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Example Usage - -```typescript expandable lines -import { ResponsesRequestToolFunction } from "@openrouter/sdk/models"; - -let value: ResponsesRequestToolFunction = { - name: "get_weather", - parameters: { - "properties": { - "location": { - "description": "The city and state", - "type": "string", - }, - "unit": { - "enum": [ - "celsius", - "fahrenheit", - ], - "type": "string", - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - "type": "object", - }, - type: "function", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `parameters` | `Record` | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"function"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsesrequesttoolunion.mdx b/client-sdks/typescript/api-reference/models/responsesrequesttoolunion.mdx deleted file mode 100644 index 95b2f57b..00000000 --- a/client-sdks/typescript/api-reference/models/responsesrequesttoolunion.mdx +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: ResponsesRequestToolUnion - TypeScript SDK -sidebarTitle: ResponsesRequestToolUnion -description: ResponsesRequestToolUnion type definition -seoTitle: ResponsesRequestToolUnion Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesRequestToolUnion Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesRequestToolUnion type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesRequestToolUnion%20-%20TypeScript%20SDK&description=ResponsesRequestToolUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponsesRequestToolFunction` - -```typescript expandable lines -const value: models.ResponsesRequestToolFunction = { - name: "get_weather", - parameters: { - "properties": { - "location": { - "description": "The city and state", - "type": "string", - }, - "unit": { - "enum": [ - "celsius", - "fahrenheit", - ], - "type": "string", - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - "type": "object", - }, - type: "function", -}; -``` - -### `models.PreviewWebSearchServerTool` - -```typescript lines -const value: models.PreviewWebSearchServerTool = { - type: "web_search_preview", -}; -``` - -### `models.Preview20250311WebSearchServerTool` - -```typescript lines -const value: models.Preview20250311WebSearchServerTool = { - type: "web_search_preview_2025_03_11", -}; -``` - -### `models.LegacyWebSearchServerTool` - -```typescript lines -const value: models.LegacyWebSearchServerTool = { - type: "web_search", -}; -``` - -### `models.WebSearchServerTool` - -```typescript lines -const value: models.WebSearchServerTool = { - type: "web_search_2025_08_26", -}; -``` - -### `models.FileSearchServerTool` - -```typescript lines -const value: models.FileSearchServerTool = { - type: "file_search", - vectorStoreIds: [ - "vs_abc123", - ], -}; -``` - -### `models.ComputerUseServerTool` - -```typescript lines -const value: models.ComputerUseServerTool = { - displayHeight: 768, - displayWidth: 1024, - environment: "linux", - type: "computer_use_preview", -}; -``` - -### `models.CodeInterpreterServerTool` - -```typescript lines -const value: models.CodeInterpreterServerTool = { - container: "auto", - type: "code_interpreter", -}; -``` - -### `models.McpServerTool` - -```typescript lines -const value: models.McpServerTool = { - serverLabel: "my-server", - type: "mcp", -}; -``` - -### `models.ImageGenerationServerTool` - -```typescript lines -const value: models.ImageGenerationServerTool = { - type: "image_generation", -}; -``` - -### `models.CodexLocalShellTool` - -```typescript lines -const value: models.CodexLocalShellTool = { - type: "local_shell", -}; -``` - -### `models.ShellServerTool` - -```typescript lines -const value: models.ShellServerTool = { - type: "shell", -}; -``` - -### `models.ApplyPatchServerTool` - -```typescript lines -const value: models.ApplyPatchServerTool = { - type: "apply_patch", -}; -``` - -### `models.CustomTool` - -```typescript lines -const value: models.CustomTool = { - name: "my_tool", - type: "custom", -}; -``` - -### `models.DatetimeServerTool` - -```typescript lines -const value: models.DatetimeServerTool = { - type: "openrouter:datetime", -}; -``` - -### `models.FusionServerToolOpenRouter` - -```typescript lines -const value: models.FusionServerToolOpenRouter = { - type: "openrouter:fusion", -}; -``` - -### `models.ImageGenerationServerToolOpenRouter` - -```typescript lines -const value: models.ImageGenerationServerToolOpenRouter = { - type: "openrouter:image_generation", -}; -``` - -### `models.ChatSearchModelsServerTool` - -```typescript lines -const value: models.ChatSearchModelsServerTool = { - type: "openrouter:experimental__search_models", -}; -``` - -### `models.WebFetchServerTool` - -```typescript lines -const value: models.WebFetchServerTool = { - type: "openrouter:web_fetch", -}; -``` - -### `models.WebSearchServerToolOpenRouter` - -```typescript lines -const value: models.WebSearchServerToolOpenRouter = { - type: "openrouter:web_search", -}; -``` - -### `models.ApplyPatchServerToolOpenRouter` - -```typescript lines -const value: models.ApplyPatchServerToolOpenRouter = { - type: "openrouter:apply_patch", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/responsesstreamingresponse.mdx b/client-sdks/typescript/api-reference/models/responsesstreamingresponse.mdx deleted file mode 100644 index 6724c74c..00000000 --- a/client-sdks/typescript/api-reference/models/responsesstreamingresponse.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ResponsesStreamingResponse - TypeScript SDK -sidebarTitle: ResponsesStreamingResponse -description: ResponsesStreamingResponse type definition -seoTitle: ResponsesStreamingResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/responsesstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': ResponsesStreamingResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ResponsesStreamingResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesStreamingResponse%20-%20TypeScript%20SDK&description=ResponsesStreamingResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesStreamingResponse } from "@openrouter/sdk/models"; - -let value: ResponsesStreamingResponse = { - data: { - contentIndex: 844013, - delta: "Hello", - itemId: "", - logprobs: [ - { - logprob: -0.5, - token: "Hello", - }, - ], - outputIndex: 868033, - sequenceNumber: 359136, - type: "response.output_text.delta", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.StreamEvents* | :heavy_check_mark: | Union of all possible event types emitted during response streaming | `{"response": {"created_at": 1704067200,"error": 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,"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/client-sdks/typescript/api-reference/models/responset.mdx b/client-sdks/typescript/api-reference/models/responset.mdx deleted file mode 100644 index b8f788e6..00000000 --- a/client-sdks/typescript/api-reference/models/responset.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ResponseT - TypeScript SDK -sidebarTitle: ResponseT -description: ResponseT type definition -seoTitle: ResponseT Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/responset' -'og:site_name': OpenRouter Documentation -'og:title': ResponseT Type | OpenRouter TypeScript SDK -'og:description': >- - ResponseT type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseT%20-%20TypeScript%20SDK&description=ResponseT%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseT } from "@openrouter/sdk/models"; - -let value: ResponseT = { - model: "El Camino", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/routerattempt.mdx b/client-sdks/typescript/api-reference/models/routerattempt.mdx deleted file mode 100644 index 494481c9..00000000 --- a/client-sdks/typescript/api-reference/models/routerattempt.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: RouterAttempt - TypeScript SDK -sidebarTitle: RouterAttempt -description: RouterAttempt type definition -seoTitle: RouterAttempt Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/routerattempt' -'og:site_name': OpenRouter Documentation -'og:title': RouterAttempt Type | OpenRouter TypeScript SDK -'og:description': >- - RouterAttempt type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterAttempt%20-%20TypeScript%20SDK&description=RouterAttempt%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RouterAttempt } from "@openrouter/sdk/models"; - -let value: RouterAttempt = { - model: "openai/gpt-4o", - provider: "OpenAI", - status: 200, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_check_mark: | N/A | -| `status` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/routerparams.mdx b/client-sdks/typescript/api-reference/models/routerparams.mdx deleted file mode 100644 index d7b64574..00000000 --- a/client-sdks/typescript/api-reference/models/routerparams.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: RouterParams - TypeScript SDK -sidebarTitle: RouterParams -description: RouterParams type definition -seoTitle: RouterParams Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/routerparams' -'og:site_name': OpenRouter Documentation -'og:title': RouterParams Type | OpenRouter TypeScript SDK -'og:description': >- - RouterParams type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RouterParams%20-%20TypeScript%20SDK&description=RouterParams%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RouterParams } from "@openrouter/sdk/models"; - -let value: RouterParams = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `qualityFloor` | *number* | :heavy_minus_sign: | N/A | | -| `throughputFloor` | *number* | :heavy_minus_sign: | N/A | | -| `versionGroup` | *string* | :heavy_minus_sign: | N/A | | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | `{"version_group": "anthropic/claude-sonnet-4"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/routingstrategy.mdx b/client-sdks/typescript/api-reference/models/routingstrategy.mdx deleted file mode 100644 index b544cf7e..00000000 --- a/client-sdks/typescript/api-reference/models/routingstrategy.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: RoutingStrategy - TypeScript SDK -sidebarTitle: RoutingStrategy -description: RoutingStrategy type definition -seoTitle: RoutingStrategy Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/routingstrategy -'og:site_name': OpenRouter Documentation -'og:title': RoutingStrategy Type | OpenRouter TypeScript SDK -'og:description': >- - RoutingStrategy type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RoutingStrategy%20-%20TypeScript%20SDK&description=RoutingStrategy%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { RoutingStrategy } from "@openrouter/sdk/models"; - -let value: RoutingStrategy = "direct"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"direct" | "auto" | "free" | "latest" | "alias" | "fallback" | "pareto" | "bodybuilder" | "fusion" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/rule.mdx b/client-sdks/typescript/api-reference/models/rule.mdx deleted file mode 100644 index d0af8007..00000000 --- a/client-sdks/typescript/api-reference/models/rule.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Rule - TypeScript SDK -sidebarTitle: Rule -description: Rule type definition -seoTitle: Rule Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/rule' -'og:site_name': OpenRouter Documentation -'og:title': Rule Type | OpenRouter TypeScript SDK -'og:description': >- - Rule type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rule%20-%20TypeScript%20SDK&description=Rule%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Rule } from "@openrouter/sdk/models"; - -let value: Rule = { - field: "api_key_name", - operator: "not_contains", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `field` | [models.Field](/client-sdks/typescript/api-reference/models/field) | :heavy_check_mark: | N/A | -| `operator` | [models.Operator](/client-sdks/typescript/api-reference/models/operator) | :heavy_check_mark: | N/A | -| `value` | *models.ObservabilityFilterRulesConfigValue* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/searchcontextsizeenum.mdx b/client-sdks/typescript/api-reference/models/searchcontextsizeenum.mdx deleted file mode 100644 index 39343bcc..00000000 --- a/client-sdks/typescript/api-reference/models/searchcontextsizeenum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: SearchContextSizeEnum - TypeScript SDK -sidebarTitle: SearchContextSizeEnum -description: SearchContextSizeEnum type definition -seoTitle: SearchContextSizeEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/searchcontextsizeenum -'og:site_name': OpenRouter Documentation -'og:title': SearchContextSizeEnum Type | OpenRouter TypeScript SDK -'og:description': >- - SearchContextSizeEnum type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchContextSizeEnum%20-%20TypeScript%20SDK&description=SearchContextSizeEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Size of the search context for web search tools - -## Example Usage - -```typescript lines -import { SearchContextSizeEnum } from "@openrouter/sdk/models"; - -let value: SearchContextSizeEnum = "medium"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"low" | "medium" | "high" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/searchmodelsservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/searchmodelsservertoolconfig.mdx deleted file mode 100644 index 1941bad9..00000000 --- a/client-sdks/typescript/api-reference/models/searchmodelsservertoolconfig.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SearchModelsServerToolConfig - TypeScript SDK -sidebarTitle: SearchModelsServerToolConfig -description: SearchModelsServerToolConfig type definition -seoTitle: SearchModelsServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/searchmodelsservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': SearchModelsServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - SearchModelsServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchModelsServerToolConfig%20-%20TypeScript%20SDK&description=SearchModelsServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:experimental__search_models server tool - -## Example Usage - -```typescript lines -import { SearchModelsServerToolConfig } from "@openrouter/sdk/models"; - -let value: SearchModelsServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/searchqualitylevel.mdx b/client-sdks/typescript/api-reference/models/searchqualitylevel.mdx deleted file mode 100644 index 0d5f4379..00000000 --- a/client-sdks/typescript/api-reference/models/searchqualitylevel.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: SearchQualityLevel - TypeScript SDK -sidebarTitle: SearchQualityLevel -description: SearchQualityLevel type definition -seoTitle: SearchQualityLevel Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/searchqualitylevel -'og:site_name': OpenRouter Documentation -'og:title': SearchQualityLevel Type | OpenRouter TypeScript SDK -'og:description': >- - SearchQualityLevel type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SearchQualityLevel%20-%20TypeScript%20SDK&description=SearchQualityLevel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -How much context to retrieve per result. Applies to Exa and Parallel 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. - -## Example Usage - -```typescript lines -import { SearchQualityLevel } from "@openrouter/sdk/models"; - -let value: SearchQualityLevel = "medium"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"low" | "medium" | "high" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/security.mdx b/client-sdks/typescript/api-reference/models/security.mdx deleted file mode 100644 index 3e4fd494..00000000 --- a/client-sdks/typescript/api-reference/models/security.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Security - TypeScript SDK -sidebarTitle: Security -description: Security type definition -seoTitle: Security Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/security' -'og:site_name': OpenRouter Documentation -'og:title': Security Type | OpenRouter TypeScript SDK -'og:description': >- - Security type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Security%20-%20TypeScript%20SDK&description=Security%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Security } from "@openrouter/sdk/models"; - -let value: Security = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/serviceunavailableresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/serviceunavailableresponseerrordata.mdx deleted file mode 100644 index 79855b69..00000000 --- a/client-sdks/typescript/api-reference/models/serviceunavailableresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ServiceUnavailableResponseErrorData - TypeScript SDK -sidebarTitle: ServiceUnavailableResponseErrorData -description: ServiceUnavailableResponseErrorData type definition -seoTitle: ServiceUnavailableResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/serviceunavailableresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - ServiceUnavailableResponseErrorData type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseErrorData%20-%20TypeScript%20SDK&description=ServiceUnavailableResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ServiceUnavailableResponse - -## Example Usage - -```typescript lines -import { ServiceUnavailableResponseErrorData } from "@openrouter/sdk/models"; - -let value: ServiceUnavailableResponseErrorData = { - code: 503, - message: "Service temporarily unavailable", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcallitem.mdx b/client-sdks/typescript/api-reference/models/shellcallitem.mdx deleted file mode 100644 index e9516e78..00000000 --- a/client-sdks/typescript/api-reference/models/shellcallitem.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ShellCallItem - TypeScript SDK -sidebarTitle: ShellCallItem -description: ShellCallItem type definition -seoTitle: ShellCallItem Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/shellcallitem' -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItem Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallItem type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItem%20-%20TypeScript%20SDK&description=ShellCallItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A shell command execution call (newer variant) - -## Example Usage - -```typescript lines -import { ShellCallItem } from "@openrouter/sdk/models"; - -let value: ShellCallItem = { - action: { - commands: [ - "ls", - "-la", - ], - }, - callId: "call-abc123", - type: "shell_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `action` | [models.ShellCallItemAction](/client-sdks/typescript/api-reference/models/shellcallitemaction) | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `environment` | *any* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ShellCallItemStatus](/client-sdks/typescript/api-reference/models/shellcallitemstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallItemType](/client-sdks/typescript/api-reference/models/shellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcallitemaction.mdx b/client-sdks/typescript/api-reference/models/shellcallitemaction.mdx deleted file mode 100644 index cc7116bc..00000000 --- a/client-sdks/typescript/api-reference/models/shellcallitemaction.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ShellCallItemAction - TypeScript SDK -sidebarTitle: ShellCallItemAction -description: ShellCallItemAction type definition -seoTitle: ShellCallItemAction Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcallitemaction -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemAction Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallItemAction type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemAction%20-%20TypeScript%20SDK&description=ShellCallItemAction%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallItemAction } from "@openrouter/sdk/models"; - -let value: ShellCallItemAction = { - commands: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `commands` | *string*[] | :heavy_check_mark: | N/A | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | -| `timeoutMs` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcallitemstatus.mdx b/client-sdks/typescript/api-reference/models/shellcallitemstatus.mdx deleted file mode 100644 index 972f077b..00000000 --- a/client-sdks/typescript/api-reference/models/shellcallitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ShellCallItemStatus - TypeScript SDK -sidebarTitle: ShellCallItemStatus -description: ShellCallItemStatus type definition -seoTitle: ShellCallItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcallitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallItemStatus type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemStatus%20-%20TypeScript%20SDK&description=ShellCallItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallItemStatus } from "@openrouter/sdk/models"; - -let value: ShellCallItemStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcallitemtype.mdx b/client-sdks/typescript/api-reference/models/shellcallitemtype.mdx deleted file mode 100644 index 59186479..00000000 --- a/client-sdks/typescript/api-reference/models/shellcallitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ShellCallItemType - TypeScript SDK -sidebarTitle: ShellCallItemType -description: ShellCallItemType type definition -seoTitle: ShellCallItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcallitemtype -'og:site_name': OpenRouter Documentation -'og:title': ShellCallItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallItemType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallItemType%20-%20TypeScript%20SDK&description=ShellCallItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallItemType } from "@openrouter/sdk/models"; - -let value: ShellCallItemType = "shell_call"; -``` - -## Values - -```typescript lines -"shell_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcalloutputitem.mdx b/client-sdks/typescript/api-reference/models/shellcalloutputitem.mdx deleted file mode 100644 index 8172c323..00000000 --- a/client-sdks/typescript/api-reference/models/shellcalloutputitem.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: ShellCallOutputItem - TypeScript SDK -sidebarTitle: ShellCallOutputItem -description: ShellCallOutputItem type definition -seoTitle: ShellCallOutputItem Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcalloutputitem -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItem Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallOutputItem type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItem%20-%20TypeScript%20SDK&description=ShellCallOutputItem%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Output from a shell command execution (newer variant) - -## Example Usage - -```typescript lines -import { ShellCallOutputItem } from "@openrouter/sdk/models"; - -let value: ShellCallOutputItem = { - callId: "call-abc123", - output: [ - { - type: "stdout", - }, - ], - type: "shell_call_output", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | | -| `output` | [models.ShellCallOutputItemOutput](/client-sdks/typescript/api-reference/models/shellcalloutputitemoutput)[] | :heavy_check_mark: | N/A | | -| `status` | [models.ShellCallOutputItemStatus](/client-sdks/typescript/api-reference/models/shellcalloutputitemstatus) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallOutputItemType](/client-sdks/typescript/api-reference/models/shellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcalloutputitemoutput.mdx b/client-sdks/typescript/api-reference/models/shellcalloutputitemoutput.mdx deleted file mode 100644 index 9672af26..00000000 --- a/client-sdks/typescript/api-reference/models/shellcalloutputitemoutput.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ShellCallOutputItemOutput - TypeScript SDK -sidebarTitle: ShellCallOutputItemOutput -description: ShellCallOutputItemOutput type definition -seoTitle: ShellCallOutputItemOutput Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcalloutputitemoutput -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemOutput Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallOutputItemOutput type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemOutput%20-%20TypeScript%20SDK&description=ShellCallOutputItemOutput%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallOutputItemOutput } from "@openrouter/sdk/models"; - -let value: ShellCallOutputItemOutput = { - type: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `exitCode` | *number* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcalloutputitemstatus.mdx b/client-sdks/typescript/api-reference/models/shellcalloutputitemstatus.mdx deleted file mode 100644 index ba9aeda6..00000000 --- a/client-sdks/typescript/api-reference/models/shellcalloutputitemstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ShellCallOutputItemStatus - TypeScript SDK -sidebarTitle: ShellCallOutputItemStatus -description: ShellCallOutputItemStatus type definition -seoTitle: ShellCallOutputItemStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcalloutputitemstatus -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallOutputItemStatus type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemStatus%20-%20TypeScript%20SDK&description=ShellCallOutputItemStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallOutputItemStatus } from "@openrouter/sdk/models"; - -let value: ShellCallOutputItemStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellcalloutputitemtype.mdx b/client-sdks/typescript/api-reference/models/shellcalloutputitemtype.mdx deleted file mode 100644 index bace023e..00000000 --- a/client-sdks/typescript/api-reference/models/shellcalloutputitemtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ShellCallOutputItemType - TypeScript SDK -sidebarTitle: ShellCallOutputItemType -description: ShellCallOutputItemType type definition -seoTitle: ShellCallOutputItemType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellcalloutputitemtype -'og:site_name': OpenRouter Documentation -'og:title': ShellCallOutputItemType Type | OpenRouter TypeScript SDK -'og:description': >- - ShellCallOutputItemType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellCallOutputItemType%20-%20TypeScript%20SDK&description=ShellCallOutputItemType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ShellCallOutputItemType } from "@openrouter/sdk/models"; - -let value: ShellCallOutputItemType = "shell_call_output"; -``` - -## Values - -```typescript lines -"shell_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/shellservertool.mdx b/client-sdks/typescript/api-reference/models/shellservertool.mdx deleted file mode 100644 index 3f69e7cf..00000000 --- a/client-sdks/typescript/api-reference/models/shellservertool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ShellServerTool - TypeScript SDK -sidebarTitle: ShellServerTool -description: ShellServerTool type definition -seoTitle: ShellServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/shellservertool -'og:site_name': OpenRouter Documentation -'og:title': ShellServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - ShellServerTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ShellServerTool%20-%20TypeScript%20SDK&description=ShellServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Shell tool configuration - -## Example Usage - -```typescript lines -import { ShellServerTool } from "@openrouter/sdk/models"; - -let value: ShellServerTool = { - type: "shell", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"shell"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/size.mdx b/client-sdks/typescript/api-reference/models/size.mdx deleted file mode 100644 index 6caa053d..00000000 --- a/client-sdks/typescript/api-reference/models/size.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Size - TypeScript SDK -sidebarTitle: Size -description: Size type definition -seoTitle: Size Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/size' -'og:site_name': OpenRouter Documentation -'og:title': Size Type | OpenRouter TypeScript SDK -'og:description': >- - Size type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Size%20-%20TypeScript%20SDK&description=Size%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Size } from "@openrouter/sdk/models"; - -let value: Size = "1024x1024"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"1024x1024" | "1024x1536" | "1536x1024" | "auto" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sort.mdx b/client-sdks/typescript/api-reference/models/sort.mdx deleted file mode 100644 index 71b4ea56..00000000 --- a/client-sdks/typescript/api-reference/models/sort.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Sort - TypeScript SDK -sidebarTitle: Sort -description: Sort type definition -seoTitle: Sort Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sort' -'og:site_name': OpenRouter Documentation -'og:title': Sort Type | OpenRouter TypeScript SDK -'og:description': >- - Sort type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Sort%20-%20TypeScript%20SDK&description=Sort%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `models.ProviderSort` - -```typescript lines -const value: models.ProviderSort = "price"; -``` - -### `models.ProviderSortConfig` - -```typescript lines -const value: models.ProviderSortConfig = {}; -``` - -### `any` - -```typescript lines -const value: any = "price"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sourcecontent.mdx b/client-sdks/typescript/api-reference/models/sourcecontent.mdx deleted file mode 100644 index 504fa29f..00000000 --- a/client-sdks/typescript/api-reference/models/sourcecontent.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: SourceContent - TypeScript SDK -sidebarTitle: SourceContent -description: SourceContent type definition -seoTitle: SourceContent Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sourcecontent' -'og:site_name': OpenRouter Documentation -'og:title': SourceContent Type | OpenRouter TypeScript SDK -'og:description': >- - SourceContent type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SourceContent%20-%20TypeScript%20SDK&description=SourceContent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SourceContent } from "@openrouter/sdk/models"; - -let value: SourceContent = { - content: "", - type: "content", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `content` | *models.AnthropicDocumentBlockParamContent2* | :heavy_check_mark: | N/A | -| `type` | *"content"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/speechrequest.mdx b/client-sdks/typescript/api-reference/models/speechrequest.mdx deleted file mode 100644 index 78a0e4b8..00000000 --- a/client-sdks/typescript/api-reference/models/speechrequest.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: SpeechRequest - TypeScript SDK -sidebarTitle: SpeechRequest -description: SpeechRequest type definition -seoTitle: SpeechRequest Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/speechrequest' -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequest Type | OpenRouter TypeScript SDK -'og:description': >- - SpeechRequest type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequest%20-%20TypeScript%20SDK&description=SpeechRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text-to-speech request input - -## Example Usage - -```typescript lines -import { SpeechRequest } from "@openrouter/sdk/models"; - -let value: SpeechRequest = { - input: "Hello world", - model: "elevenlabs/eleven-turbo-v2", - voice: "alloy", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `input` | *string* | :heavy_check_mark: | Text to synthesize | Hello world | -| `model` | *string* | :heavy_check_mark: | TTS model identifier | elevenlabs/eleven-turbo-v2 | -| `provider` | [models.SpeechRequestProvider](/client-sdks/typescript/api-reference/models/speechrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `responseFormat` | [models.ResponseFormatEnum](/client-sdks/typescript/api-reference/models/responseformatenum) | :heavy_minus_sign: | Audio output format | pcm | -| `speed` | *number* | :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). | alloy | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/speechrequestprovider.mdx b/client-sdks/typescript/api-reference/models/speechrequestprovider.mdx deleted file mode 100644 index 9f3f8df8..00000000 --- a/client-sdks/typescript/api-reference/models/speechrequestprovider.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SpeechRequestProvider - TypeScript SDK -sidebarTitle: SpeechRequestProvider -description: SpeechRequestProvider type definition -seoTitle: SpeechRequestProvider Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/speechrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': SpeechRequestProvider Type | OpenRouter TypeScript SDK -'og:description': >- - SpeechRequestProvider type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SpeechRequestProvider%20-%20TypeScript%20SDK&description=SpeechRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Example Usage - -```typescript lines -import { SpeechRequestProvider } from "@openrouter/sdk/models"; - -let value: SpeechRequestProvider = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [models.ProviderOptions](/client-sdks/typescript/api-reference/models/provideroptions) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/speed.mdx b/client-sdks/typescript/api-reference/models/speed.mdx deleted file mode 100644 index 1df98bb2..00000000 --- a/client-sdks/typescript/api-reference/models/speed.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Speed - TypeScript SDK -sidebarTitle: Speed -description: Speed type definition -seoTitle: Speed Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/speed' -'og:site_name': OpenRouter Documentation -'og:title': Speed Type | OpenRouter TypeScript SDK -'og:description': >- - Speed type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speed%20-%20TypeScript%20SDK&description=Speed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Controls output generation speed. When set to `fast`, uses a higher-speed inference configuration at premium pricing. Defaults to `standard` when omitted. - -## Example Usage - -```typescript lines -import { Speed } from "@openrouter/sdk/models"; - -let value: Speed = "fast"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"fast" | "standard" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stance.mdx b/client-sdks/typescript/api-reference/models/stance.mdx deleted file mode 100644 index ca72b63d..00000000 --- a/client-sdks/typescript/api-reference/models/stance.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Stance - TypeScript SDK -sidebarTitle: Stance -description: Stance type definition -seoTitle: Stance Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/stance' -'og:site_name': OpenRouter Documentation -'og:title': Stance Type | OpenRouter TypeScript SDK -'og:description': >- - Stance type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stance%20-%20TypeScript%20SDK&description=Stance%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Stance } from "@openrouter/sdk/models"; - -let value: Stance = { - model: "Wrangler", - stance: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `stance` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stop.mdx b/client-sdks/typescript/api-reference/models/stop.mdx deleted file mode 100644 index 44b73fe9..00000000 --- a/client-sdks/typescript/api-reference/models/stop.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Stop - TypeScript SDK -sidebarTitle: Stop -description: Stop type definition -seoTitle: Stop Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/stop' -'og:site_name': OpenRouter Documentation -'og:title': Stop Type | OpenRouter TypeScript SDK -'og:description': >- - Stop type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Stop%20-%20TypeScript%20SDK&description=Stop%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop sequences (up to 4) - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", -]; -``` - -### `any` - -```typescript lines -const value: any = [ - "", -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhencondition.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhencondition.mdx deleted file mode 100644 index f16c0332..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhencondition.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: StopServerToolsWhenCondition - TypeScript SDK -sidebarTitle: StopServerToolsWhenCondition -description: StopServerToolsWhenCondition type definition -seoTitle: StopServerToolsWhenCondition Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhencondition -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenCondition Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenCondition type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenCondition%20-%20TypeScript%20SDK&description=StopServerToolsWhenCondition%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A single condition that, when met, halts the server-tool agent loop. - -## Supported Types - -### `models.StopServerToolsWhenFinishReasonIs` - -```typescript lines -const value: models.StopServerToolsWhenFinishReasonIs = { - reason: "", - type: "finish_reason_is", -}; -``` - -### `models.StopServerToolsWhenHasToolCall` - -```typescript lines -const value: models.StopServerToolsWhenHasToolCall = { - toolName: "", - type: "has_tool_call", -}; -``` - -### `models.StopServerToolsWhenMaxCost` - -```typescript lines -const value: models.StopServerToolsWhenMaxCost = { - maxCostInDollars: 1543.31, - type: "max_cost", -}; -``` - -### `models.StopServerToolsWhenMaxTokensUsed` - -```typescript lines -const value: models.StopServerToolsWhenMaxTokensUsed = { - maxTokens: 577706, - type: "max_tokens_used", -}; -``` - -### `models.StopServerToolsWhenStepCountIs` - -```typescript lines -const value: models.StopServerToolsWhenStepCountIs = { - stepCount: 5, - type: "step_count_is", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhenfinishreasonis.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhenfinishreasonis.mdx deleted file mode 100644 index f8fa0ecb..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhenfinishreasonis.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StopServerToolsWhenFinishReasonIs - TypeScript SDK -sidebarTitle: StopServerToolsWhenFinishReasonIs -description: StopServerToolsWhenFinishReasonIs type definition -seoTitle: StopServerToolsWhenFinishReasonIs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhenfinishreasonis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenFinishReasonIs Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenFinishReasonIs type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenFinishReasonIs%20-%20TypeScript%20SDK&description=StopServerToolsWhenFinishReasonIs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop when the upstream model emits this finish reason (e.g. `length`). - -## Example Usage - -```typescript lines -import { StopServerToolsWhenFinishReasonIs } from "@openrouter/sdk/models"; - -let value: StopServerToolsWhenFinishReasonIs = { - reason: "", - type: "finish_reason_is", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `reason` | *string* | :heavy_check_mark: | N/A | -| `type` | *"finish_reason_is"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhenhastoolcall.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhenhastoolcall.mdx deleted file mode 100644 index 3c5f66bb..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhenhastoolcall.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StopServerToolsWhenHasToolCall - TypeScript SDK -sidebarTitle: StopServerToolsWhenHasToolCall -description: StopServerToolsWhenHasToolCall type definition -seoTitle: StopServerToolsWhenHasToolCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhenhastoolcall -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenHasToolCall Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenHasToolCall type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenHasToolCall%20-%20TypeScript%20SDK&description=StopServerToolsWhenHasToolCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop after a tool with this name has been called. - -## Example Usage - -```typescript lines -import { StopServerToolsWhenHasToolCall } from "@openrouter/sdk/models"; - -let value: StopServerToolsWhenHasToolCall = { - toolName: "", - type: "has_tool_call", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `toolName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"has_tool_call"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxcost.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxcost.mdx deleted file mode 100644 index a38b8f88..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxcost.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StopServerToolsWhenMaxCost - TypeScript SDK -sidebarTitle: StopServerToolsWhenMaxCost -description: StopServerToolsWhenMaxCost type definition -seoTitle: StopServerToolsWhenMaxCost Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhenmaxcost -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxCost Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenMaxCost type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxCost%20-%20TypeScript%20SDK&description=StopServerToolsWhenMaxCost%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop once cumulative cost across the loop exceeds this dollar threshold. - -## Example Usage - -```typescript lines -import { StopServerToolsWhenMaxCost } from "@openrouter/sdk/models"; - -let value: StopServerToolsWhenMaxCost = { - maxCostInDollars: 7287.97, - type: "max_cost", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `maxCostInDollars` | *number* | :heavy_check_mark: | N/A | -| `type` | *"max_cost"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxtokensused.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxtokensused.mdx deleted file mode 100644 index 6889c4c8..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhenmaxtokensused.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StopServerToolsWhenMaxTokensUsed - TypeScript SDK -sidebarTitle: StopServerToolsWhenMaxTokensUsed -description: StopServerToolsWhenMaxTokensUsed type definition -seoTitle: StopServerToolsWhenMaxTokensUsed Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhenmaxtokensused -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenMaxTokensUsed Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenMaxTokensUsed type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenMaxTokensUsed%20-%20TypeScript%20SDK&description=StopServerToolsWhenMaxTokensUsed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop once cumulative token usage across the loop exceeds this threshold. - -## Example Usage - -```typescript lines -import { StopServerToolsWhenMaxTokensUsed } from "@openrouter/sdk/models"; - -let value: StopServerToolsWhenMaxTokensUsed = { - maxTokens: 945221, - type: "max_tokens_used", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `maxTokens` | *number* | :heavy_check_mark: | N/A | -| `type` | *"max_tokens_used"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/stopservertoolswhenstepcountis.mdx b/client-sdks/typescript/api-reference/models/stopservertoolswhenstepcountis.mdx deleted file mode 100644 index 76ead37e..00000000 --- a/client-sdks/typescript/api-reference/models/stopservertoolswhenstepcountis.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StopServerToolsWhenStepCountIs - TypeScript SDK -sidebarTitle: StopServerToolsWhenStepCountIs -description: StopServerToolsWhenStepCountIs type definition -seoTitle: StopServerToolsWhenStepCountIs Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/stopservertoolswhenstepcountis -'og:site_name': OpenRouter Documentation -'og:title': StopServerToolsWhenStepCountIs Type | OpenRouter TypeScript SDK -'og:description': >- - StopServerToolsWhenStepCountIs type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StopServerToolsWhenStepCountIs%20-%20TypeScript%20SDK&description=StopServerToolsWhenStepCountIs%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Stop after the agent loop has executed this many steps. - -## Example Usage - -```typescript lines -import { StopServerToolsWhenStepCountIs } from "@openrouter/sdk/models"; - -let value: StopServerToolsWhenStepCountIs = { - stepCount: 5, - type: "step_count_is", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `stepCount` | *number* | :heavy_check_mark: | N/A | -| `type` | *"step_count_is"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/storedprompttemplate.mdx b/client-sdks/typescript/api-reference/models/storedprompttemplate.mdx deleted file mode 100644 index 150dcd10..00000000 --- a/client-sdks/typescript/api-reference/models/storedprompttemplate.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: StoredPromptTemplate - TypeScript SDK -sidebarTitle: StoredPromptTemplate -description: StoredPromptTemplate type definition -seoTitle: StoredPromptTemplate Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/storedprompttemplate -'og:site_name': OpenRouter Documentation -'og:title': StoredPromptTemplate Type | OpenRouter TypeScript SDK -'og:description': >- - StoredPromptTemplate type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StoredPromptTemplate%20-%20TypeScript%20SDK&description=StoredPromptTemplate%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { StoredPromptTemplate } from "@openrouter/sdk/models"; - -let value: StoredPromptTemplate = { - id: "prompt-abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `variables` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streamevents.mdx b/client-sdks/typescript/api-reference/models/streamevents.mdx deleted file mode 100644 index 146904ed..00000000 --- a/client-sdks/typescript/api-reference/models/streamevents.mdx +++ /dev/null @@ -1,581 +0,0 @@ ---- -title: StreamEvents - TypeScript SDK -sidebarTitle: StreamEvents -description: StreamEvents type definition -seoTitle: StreamEvents Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/streamevents' -'og:site_name': OpenRouter Documentation -'og:title': StreamEvents Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEvents type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEvents%20-%20TypeScript%20SDK&description=StreamEvents%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Union of all possible event types emitted during response streaming - -## Supported Types - -### `models.ErrorEvent` - -```typescript lines -const value: models.ErrorEvent = { - code: null, - message: "", - param: null, - sequenceNumber: 0, - type: "error", -}; -``` - -### `models.ApplyPatchCallOperationDiffDeltaEvent` - -```typescript lines -const value: models.ApplyPatchCallOperationDiffDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 162755, - sequenceNumber: 0, - type: "response.apply_patch_call_operation_diff.delta", -}; -``` - -### `models.ApplyPatchCallOperationDiffDoneEvent` - -```typescript lines -const value: models.ApplyPatchCallOperationDiffDoneEvent = { - diff: "", - itemId: "", - outputIndex: 786722, - sequenceNumber: 0, - type: "response.apply_patch_call_operation_diff.done", -}; -``` - -### `models.StreamEventsResponseCompleted` - -```typescript expandable lines -const value: models.StreamEventsResponseCompleted = { - response: { - completedAt: 773930, - createdAt: 1704067200, - error: null, - frequencyPenalty: null, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 4244.7, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.completed", -}; -``` - -### `models.ContentPartAddedEvent` - -```typescript lines -const value: models.ContentPartAddedEvent = { - contentIndex: 899905, - itemId: "", - outputIndex: 34601, - part: { - text: "The capital of France is Paris.", - type: "output_text", - }, - sequenceNumber: 0, - type: "response.content_part.added", -}; -``` - -### `models.ContentPartDoneEvent` - -```typescript lines -const value: models.ContentPartDoneEvent = { - contentIndex: 112041, - itemId: "", - outputIndex: 546268, - part: { - text: "The capital of France is Paris.", - type: "output_text", - }, - sequenceNumber: 0, - type: "response.content_part.done", -}; -``` - -### `models.OpenResponsesCreatedEvent` - -```typescript expandable lines -const value: models.OpenResponsesCreatedEvent = { - response: { - completedAt: null, - createdAt: 1704067200, - error: null, - frequencyPenalty: 864.34, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 9232.89, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.created", -}; -``` - -### `models.CustomToolCallInputDeltaEvent` - -```typescript lines -const value: models.CustomToolCallInputDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 98568, - sequenceNumber: 0, - type: "response.custom_tool_call_input.delta", -}; -``` - -### `models.CustomToolCallInputDoneEvent` - -```typescript lines -const value: models.CustomToolCallInputDoneEvent = { - input: "", - itemId: "", - outputIndex: 963378, - sequenceNumber: 0, - type: "response.custom_tool_call_input.done", -}; -``` - -### `models.StreamEventsResponseFailed` - -```typescript expandable lines -const value: models.StreamEventsResponseFailed = { - response: { - completedAt: 845103, - createdAt: 1704067200, - error: null, - frequencyPenalty: 4081.29, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: null, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.failed", -}; -``` - -### `models.FunctionCallArgsDeltaEvent` - -```typescript lines -const value: models.FunctionCallArgsDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 234869, - sequenceNumber: 0, - type: "response.function_call_arguments.delta", -}; -``` - -### `models.FunctionCallArgsDoneEvent` - -```typescript lines -const value: models.FunctionCallArgsDoneEvent = { - arguments: "", - itemId: "", - name: "", - outputIndex: 603359, - sequenceNumber: 0, - type: "response.function_call_arguments.done", -}; -``` - -### `models.ImageGenCallCompletedEvent` - -```typescript lines -const value: models.ImageGenCallCompletedEvent = { - itemId: "", - outputIndex: 165850, - sequenceNumber: 0, - type: "response.image_generation_call.completed", -}; -``` - -### `models.ImageGenCallGeneratingEvent` - -```typescript lines -const value: models.ImageGenCallGeneratingEvent = { - itemId: "", - outputIndex: 708731, - sequenceNumber: 0, - type: "response.image_generation_call.generating", -}; -``` - -### `models.ImageGenCallInProgressEvent` - -```typescript lines -const value: models.ImageGenCallInProgressEvent = { - itemId: "", - outputIndex: 788131, - sequenceNumber: 0, - type: "response.image_generation_call.in_progress", -}; -``` - -### `models.ImageGenCallPartialImageEvent` - -```typescript lines -const value: models.ImageGenCallPartialImageEvent = { - itemId: "", - outputIndex: 173614, - partialImageB64: "", - partialImageIndex: 192829, - sequenceNumber: 0, - type: "response.image_generation_call.partial_image", -}; -``` - -### `models.OpenResponsesInProgressEvent` - -```typescript expandable lines -const value: models.OpenResponsesInProgressEvent = { - response: { - completedAt: 434412, - createdAt: 1704067200, - error: null, - frequencyPenalty: 945.33, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 8737.38, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.in_progress", -}; -``` - -### `models.StreamEventsResponseIncomplete` - -```typescript expandable lines -const value: models.StreamEventsResponseIncomplete = { - response: { - completedAt: 797200, - createdAt: 1704067200, - error: null, - frequencyPenalty: 8861.33, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 3923.12, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.incomplete", -}; -``` - -### `models.StreamEventsResponseOutputItemAdded` - -```typescript lines -const value: models.StreamEventsResponseOutputItemAdded = { - item: { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - outputIndex: 415042, - sequenceNumber: 0, - type: "response.output_item.added", -}; -``` - -### `models.StreamEventsResponseOutputItemDone` - -```typescript lines -const value: models.StreamEventsResponseOutputItemDone = { - item: { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - outputIndex: 209831, - sequenceNumber: 0, - type: "response.output_item.done", -}; -``` - -### `models.AnnotationAddedEvent` - -```typescript lines -const value: models.AnnotationAddedEvent = { - annotation: { - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, - type: "file_citation", - }, - annotationIndex: 104354, - contentIndex: 252914, - itemId: "", - outputIndex: 214233, - sequenceNumber: 0, - type: "response.output_text.annotation.added", -}; -``` - -### `models.TextDeltaEvent` - -```typescript lines -const value: models.TextDeltaEvent = { - contentIndex: 699825, - delta: "", - itemId: "", - logprobs: [ - { - logprob: -0.5, - token: "Hello", - }, - ], - outputIndex: 810486, - sequenceNumber: 0, - type: "response.output_text.delta", -}; -``` - -### `models.TextDoneEvent` - -```typescript lines -const value: models.TextDoneEvent = { - contentIndex: 482041, - itemId: "", - logprobs: [ - { - logprob: -0.5, - token: "Hello", - }, - ], - outputIndex: 634062, - sequenceNumber: 0, - text: "", - type: "response.output_text.done", -}; -``` - -### `models.ReasoningSummaryPartAddedEvent` - -```typescript lines -const value: models.ReasoningSummaryPartAddedEvent = { - itemId: "", - outputIndex: 543957, - part: { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - sequenceNumber: 0, - summaryIndex: 279769, - type: "response.reasoning_summary_part.added", -}; -``` - -### `models.ReasoningSummaryPartDoneEvent` - -```typescript lines -const value: models.ReasoningSummaryPartDoneEvent = { - itemId: "", - outputIndex: 831078, - part: { - text: "Analyzed the problem using first principles", - type: "summary_text", - }, - sequenceNumber: 0, - summaryIndex: 817850, - type: "response.reasoning_summary_part.done", -}; -``` - -### `models.ReasoningSummaryTextDeltaEvent` - -```typescript lines -const value: models.ReasoningSummaryTextDeltaEvent = { - delta: "", - itemId: "", - outputIndex: 466359, - sequenceNumber: 0, - summaryIndex: 520709, - type: "response.reasoning_summary_text.delta", -}; -``` - -### `models.ReasoningSummaryTextDoneEvent` - -```typescript lines -const value: models.ReasoningSummaryTextDoneEvent = { - itemId: "", - outputIndex: 687012, - sequenceNumber: 0, - summaryIndex: 897970, - text: "", - type: "response.reasoning_summary_text.done", -}; -``` - -### `models.ReasoningDeltaEvent` - -```typescript lines -const value: models.ReasoningDeltaEvent = { - contentIndex: 55721, - delta: "", - itemId: "", - outputIndex: 143619, - sequenceNumber: 0, - type: "response.reasoning_text.delta", -}; -``` - -### `models.ReasoningDoneEvent` - -```typescript lines -const value: models.ReasoningDoneEvent = { - contentIndex: 469495, - itemId: "", - outputIndex: 408441, - sequenceNumber: 0, - text: "", - type: "response.reasoning_text.done", -}; -``` - -### `models.RefusalDeltaEvent` - -```typescript lines -const value: models.RefusalDeltaEvent = { - contentIndex: 185954, - delta: "", - itemId: "", - outputIndex: 725096, - sequenceNumber: 0, - type: "response.refusal.delta", -}; -``` - -### `models.RefusalDoneEvent` - -```typescript lines -const value: models.RefusalDoneEvent = { - contentIndex: 672921, - itemId: "", - outputIndex: 193829, - refusal: "", - sequenceNumber: 0, - type: "response.refusal.done", -}; -``` - -### `models.WebSearchCallCompletedEvent` - -```typescript lines -const value: models.WebSearchCallCompletedEvent = { - itemId: "", - outputIndex: 226042, - sequenceNumber: 0, - type: "response.web_search_call.completed", -}; -``` - -### `models.WebSearchCallInProgressEvent` - -```typescript lines -const value: models.WebSearchCallInProgressEvent = { - itemId: "", - outputIndex: 153527, - sequenceNumber: 0, - type: "response.web_search_call.in_progress", -}; -``` - -### `models.WebSearchCallSearchingEvent` - -```typescript lines -const value: models.WebSearchCallSearchingEvent = { - itemId: "", - outputIndex: 702452, - sequenceNumber: 0, - type: "response.web_search_call.searching", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streameventsresponsecompleted.mdx b/client-sdks/typescript/api-reference/models/streameventsresponsecompleted.mdx deleted file mode 100644 index e6df5b13..00000000 --- a/client-sdks/typescript/api-reference/models/streameventsresponsecompleted.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: StreamEventsResponseCompleted - TypeScript SDK -sidebarTitle: StreamEventsResponseCompleted -description: StreamEventsResponseCompleted type definition -seoTitle: StreamEventsResponseCompleted Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streameventsresponsecompleted -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseCompleted Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEventsResponseCompleted type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseCompleted%20-%20TypeScript%20SDK&description=StreamEventsResponseCompleted%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has completed successfully - -## Example Usage - -```typescript expandable lines -import { StreamEventsResponseCompleted } from "@openrouter/sdk/models"; - -let value: StreamEventsResponseCompleted = { - response: { - completedAt: null, - createdAt: 1704067200, - error: null, - frequencyPenalty: 1785.15, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 4270.15, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](/client-sdks/typescript/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": `{"input_tokens": 10,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 25,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `35
`\}
\} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.completed"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streameventsresponsefailed.mdx b/client-sdks/typescript/api-reference/models/streameventsresponsefailed.mdx deleted file mode 100644 index 1beb71a7..00000000 --- a/client-sdks/typescript/api-reference/models/streameventsresponsefailed.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: StreamEventsResponseFailed - TypeScript SDK -sidebarTitle: StreamEventsResponseFailed -description: StreamEventsResponseFailed type definition -seoTitle: StreamEventsResponseFailed Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streameventsresponsefailed -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseFailed Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEventsResponseFailed type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseFailed%20-%20TypeScript%20SDK&description=StreamEventsResponseFailed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has failed - -## Example Usage - -```typescript expandable lines -import { StreamEventsResponseFailed } from "@openrouter/sdk/models"; - -let value: StreamEventsResponseFailed = { - response: { - completedAt: 671654, - createdAt: 1704067200, - error: null, - frequencyPenalty: 7790.29, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: null, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.failed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](/client-sdks/typescript/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": `{"input_tokens": 10,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 25,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `35
`\}
\} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.failed"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streameventsresponseincomplete.mdx b/client-sdks/typescript/api-reference/models/streameventsresponseincomplete.mdx deleted file mode 100644 index 66d369ed..00000000 --- a/client-sdks/typescript/api-reference/models/streameventsresponseincomplete.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: StreamEventsResponseIncomplete - TypeScript SDK -sidebarTitle: StreamEventsResponseIncomplete -description: StreamEventsResponseIncomplete type definition -seoTitle: StreamEventsResponseIncomplete Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streameventsresponseincomplete -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseIncomplete Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEventsResponseIncomplete type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseIncomplete%20-%20TypeScript%20SDK&description=StreamEventsResponseIncomplete%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is incomplete - -## Example Usage - -```typescript expandable lines -import { StreamEventsResponseIncomplete } from "@openrouter/sdk/models"; - -let value: StreamEventsResponseIncomplete = { - response: { - completedAt: 854864, - createdAt: 1704067200, - error: null, - frequencyPenalty: 7279.68, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [], - parallelToolCalls: true, - presencePenalty: 1969.92, - status: "in_progress", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, - }, - sequenceNumber: 0, - type: "response.incomplete", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](/client-sdks/typescript/api-reference/models/openresponsesresult) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"created_at": 1704067200,"error": 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,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": `{"input_tokens": 10,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens": 25,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"total_tokens": `35
`\}
\} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.incomplete"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemadded.mdx b/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemadded.mdx deleted file mode 100644 index fcd5e55c..00000000 --- a/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemadded.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: StreamEventsResponseOutputItemAdded - TypeScript SDK -sidebarTitle: StreamEventsResponseOutputItemAdded -description: StreamEventsResponseOutputItemAdded type definition -seoTitle: StreamEventsResponseOutputItemAdded Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streameventsresponseoutputitemadded -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemAdded Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEventsResponseOutputItemAdded type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemAdded%20-%20TypeScript%20SDK&description=StreamEventsResponseOutputItemAdded%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a new output item is added to the response - -## Example Usage - -```typescript lines -import { StreamEventsResponseOutputItemAdded } from "@openrouter/sdk/models"; - -let value: StreamEventsResponseOutputItemAdded = { - item: { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - outputIndex: 253212, - sequenceNumber: 0, - type: "response.output_item.added", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | *models.OutputItems* | :heavy_check_mark: | An output item from the response | `{"content": [{"text": "Hello! How can I help you today?","type": "output_text"}`
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
\} | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_item.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemdone.mdx b/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemdone.mdx deleted file mode 100644 index ef8c8d8d..00000000 --- a/client-sdks/typescript/api-reference/models/streameventsresponseoutputitemdone.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: StreamEventsResponseOutputItemDone - TypeScript SDK -sidebarTitle: StreamEventsResponseOutputItemDone -description: StreamEventsResponseOutputItemDone type definition -seoTitle: StreamEventsResponseOutputItemDone Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streameventsresponseoutputitemdone -'og:site_name': OpenRouter Documentation -'og:title': StreamEventsResponseOutputItemDone Type | OpenRouter TypeScript SDK -'og:description': >- - StreamEventsResponseOutputItemDone type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamEventsResponseOutputItemDone%20-%20TypeScript%20SDK&description=StreamEventsResponseOutputItemDone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when an output item is complete - -## Example Usage - -```typescript lines -import { StreamEventsResponseOutputItemDone } from "@openrouter/sdk/models"; - -let value: StreamEventsResponseOutputItemDone = { - item: { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - outputIndex: 307595, - sequenceNumber: 0, - type: "response.output_item.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | *models.OutputItems* | :heavy_check_mark: | An output item from the response | `{"content": [{"text": "Hello! How can I help you today?","type": "output_text"}`
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
\} | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_item.done"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streamlogprob.mdx b/client-sdks/typescript/api-reference/models/streamlogprob.mdx deleted file mode 100644 index ae7b6f1c..00000000 --- a/client-sdks/typescript/api-reference/models/streamlogprob.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: StreamLogprob - TypeScript SDK -sidebarTitle: StreamLogprob -description: StreamLogprob type definition -seoTitle: StreamLogprob Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/streamlogprob' -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprob Type | OpenRouter TypeScript SDK -'og:description': >- - StreamLogprob type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprob%20-%20TypeScript%20SDK&description=StreamLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Log probability information for a token - -## Example Usage - -```typescript lines -import { StreamLogprob } from "@openrouter/sdk/models"; - -let value: StreamLogprob = { - logprob: -0.5, - token: "Hello", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_minus_sign: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.StreamLogprobTopLogprob](/client-sdks/typescript/api-reference/models/streamlogprobtoplogprob)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/streamlogprobtoplogprob.mdx b/client-sdks/typescript/api-reference/models/streamlogprobtoplogprob.mdx deleted file mode 100644 index 5fcd9327..00000000 --- a/client-sdks/typescript/api-reference/models/streamlogprobtoplogprob.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: StreamLogprobTopLogprob - TypeScript SDK -sidebarTitle: StreamLogprobTopLogprob -description: StreamLogprobTopLogprob type definition -seoTitle: StreamLogprobTopLogprob Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/streamlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': StreamLogprobTopLogprob Type | OpenRouter TypeScript SDK -'og:description': >- - StreamLogprobTopLogprob type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamLogprobTopLogprob%20-%20TypeScript%20SDK&description=StreamLogprobTopLogprob%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Alternative token with its log probability - -## Example Usage - -```typescript lines -import { StreamLogprobTopLogprob } from "@openrouter/sdk/models"; - -let value: StreamLogprobTopLogprob = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_minus_sign: | N/A | -| `logprob` | *number* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sttinputaudio.mdx b/client-sdks/typescript/api-reference/models/sttinputaudio.mdx deleted file mode 100644 index 2776e925..00000000 --- a/client-sdks/typescript/api-reference/models/sttinputaudio.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: STTInputAudio - TypeScript SDK -sidebarTitle: STTInputAudio -description: STTInputAudio type definition -seoTitle: STTInputAudio Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sttinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': STTInputAudio Type | OpenRouter TypeScript SDK -'og:description': >- - STTInputAudio type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTInputAudio%20-%20TypeScript%20SDK&description=STTInputAudio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Base64-encoded audio to transcribe - -## Example Usage - -```typescript lines -import { STTInputAudio } from "@openrouter/sdk/models"; - -let value: STTInputAudio = { - data: "UklGRiQA...", - format: "wav", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `format` | *string* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sttrequest.mdx b/client-sdks/typescript/api-reference/models/sttrequest.mdx deleted file mode 100644 index c41aa119..00000000 --- a/client-sdks/typescript/api-reference/models/sttrequest.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: STTRequest - TypeScript SDK -sidebarTitle: STTRequest -description: STTRequest type definition -seoTitle: STTRequest Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sttrequest' -'og:site_name': OpenRouter Documentation -'og:title': STTRequest Type | OpenRouter TypeScript SDK -'og:description': >- - STTRequest type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequest%20-%20TypeScript%20SDK&description=STTRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Speech-to-text request input. Accepts a JSON body with input_audio containing base64-encoded audio. - -## Example Usage - -```typescript lines -import { STTRequest } from "@openrouter/sdk/models"; - -let value: STTRequest = { - inputAudio: { - data: "UklGRiQA...", - format: "wav", - }, - model: "openai/whisper-large-v3", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `inputAudio` | [models.STTInputAudio](/client-sdks/typescript/api-reference/models/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` | [models.STTRequestProvider](/client-sdks/typescript/api-reference/models/sttrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sttrequestprovider.mdx b/client-sdks/typescript/api-reference/models/sttrequestprovider.mdx deleted file mode 100644 index 1ce64a4a..00000000 --- a/client-sdks/typescript/api-reference/models/sttrequestprovider.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: STTRequestProvider - TypeScript SDK -sidebarTitle: STTRequestProvider -description: STTRequestProvider type definition -seoTitle: STTRequestProvider Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/sttrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': STTRequestProvider Type | OpenRouter TypeScript SDK -'og:description': >- - STTRequestProvider type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTRequestProvider%20-%20TypeScript%20SDK&description=STTRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Example Usage - -```typescript lines -import { STTRequestProvider } from "@openrouter/sdk/models"; - -let value: STTRequestProvider = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `options` | [models.ProviderOptions](/client-sdks/typescript/api-reference/models/provideroptions) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. The options for the matched provider are spread into the upstream request body. | `{"openai": {"max_tokens": 1000}`
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sttresponse.mdx b/client-sdks/typescript/api-reference/models/sttresponse.mdx deleted file mode 100644 index 8d7ecdc1..00000000 --- a/client-sdks/typescript/api-reference/models/sttresponse.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: STTResponse - TypeScript SDK -sidebarTitle: STTResponse -description: STTResponse type definition -seoTitle: STTResponse Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sttresponse' -'og:site_name': OpenRouter Documentation -'og:title': STTResponse Type | OpenRouter TypeScript SDK -'og:description': >- - STTResponse type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTResponse%20-%20TypeScript%20SDK&description=STTResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -STT response containing transcribed text and optional usage statistics - -## Example Usage - -```typescript lines -import { STTResponse } from "@openrouter/sdk/models"; - -let value: STTResponse = { - text: "Hello, this is a test of OpenAI speech-to-text transcription.", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | -| `usage` | [models.STTUsage](/client-sdks/typescript/api-reference/models/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}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/sttusage.mdx b/client-sdks/typescript/api-reference/models/sttusage.mdx deleted file mode 100644 index 1eea9f21..00000000 --- a/client-sdks/typescript/api-reference/models/sttusage.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: STTUsage - TypeScript SDK -sidebarTitle: STTUsage -description: STTUsage type definition -seoTitle: STTUsage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/sttusage' -'og:site_name': OpenRouter Documentation -'og:title': STTUsage Type | OpenRouter TypeScript SDK -'og:description': >- - STTUsage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=STTUsage%20-%20TypeScript%20SDK&description=STTUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Aggregated usage statistics for the request - -## Example Usage - -```typescript lines -import { STTUsage } from "@openrouter/sdk/models"; - -let value: STTUsage = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `inputTokens` | *number* | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `outputTokens` | *number* | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `seconds` | *number* | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `totalTokens` | *number* | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/supportedaspectratio.mdx b/client-sdks/typescript/api-reference/models/supportedaspectratio.mdx deleted file mode 100644 index e77d1314..00000000 --- a/client-sdks/typescript/api-reference/models/supportedaspectratio.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SupportedAspectRatio - TypeScript SDK -sidebarTitle: SupportedAspectRatio -description: SupportedAspectRatio type definition -seoTitle: SupportedAspectRatio Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/supportedaspectratio -'og:site_name': OpenRouter Documentation -'og:title': SupportedAspectRatio Type | OpenRouter TypeScript SDK -'og:description': >- - SupportedAspectRatio type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedAspectRatio%20-%20TypeScript%20SDK&description=SupportedAspectRatio%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SupportedAspectRatio } from "@openrouter/sdk/models"; - -let value: SupportedAspectRatio = "9:21"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "3:2" | "2:3" | "21:9" | "9:21" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/supportedframeimage.mdx b/client-sdks/typescript/api-reference/models/supportedframeimage.mdx deleted file mode 100644 index ad14f881..00000000 --- a/client-sdks/typescript/api-reference/models/supportedframeimage.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SupportedFrameImage - TypeScript SDK -sidebarTitle: SupportedFrameImage -description: SupportedFrameImage type definition -seoTitle: SupportedFrameImage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/supportedframeimage -'og:site_name': OpenRouter Documentation -'og:title': SupportedFrameImage Type | OpenRouter TypeScript SDK -'og:description': >- - SupportedFrameImage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedFrameImage%20-%20TypeScript%20SDK&description=SupportedFrameImage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SupportedFrameImage } from "@openrouter/sdk/models"; - -let value: SupportedFrameImage = "last_frame"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"first_frame" | "last_frame" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/supportedresolution.mdx b/client-sdks/typescript/api-reference/models/supportedresolution.mdx deleted file mode 100644 index 0314c00c..00000000 --- a/client-sdks/typescript/api-reference/models/supportedresolution.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SupportedResolution - TypeScript SDK -sidebarTitle: SupportedResolution -description: SupportedResolution type definition -seoTitle: SupportedResolution Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/supportedresolution -'og:site_name': OpenRouter Documentation -'og:title': SupportedResolution Type | OpenRouter TypeScript SDK -'og:description': >- - SupportedResolution type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedResolution%20-%20TypeScript%20SDK&description=SupportedResolution%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SupportedResolution } from "@openrouter/sdk/models"; - -let value: SupportedResolution = "720p"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"480p" | "720p" | "1080p" | "1K" | "2K" | "4K" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/supportedsize.mdx b/client-sdks/typescript/api-reference/models/supportedsize.mdx deleted file mode 100644 index 91cc5ff9..00000000 --- a/client-sdks/typescript/api-reference/models/supportedsize.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: SupportedSize - TypeScript SDK -sidebarTitle: SupportedSize -description: SupportedSize type definition -seoTitle: SupportedSize Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/supportedsize' -'og:site_name': OpenRouter Documentation -'og:title': SupportedSize Type | OpenRouter TypeScript SDK -'og:description': >- - SupportedSize type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SupportedSize%20-%20TypeScript%20SDK&description=SupportedSize%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SupportedSize } from "@openrouter/sdk/models"; - -let value: SupportedSize = "2520x1080"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"480x480" | "480x640" | "480x720" | "480x854" | "480x1120" | "640x480" | "720x480" | "720x720" | "720x960" | "720x1080" | "720x1280" | "720x1680" | "854x480" | "960x720" | "1080x720" | "1080x1080" | "1080x1440" | "1080x1620" | "1080x1920" | "1080x2520" | "1120x480" | "1280x720" | "1440x1080" | "1620x1080" | "1680x720" | "1920x1080" | "2160x2160" | "2160x2880" | "2160x3240" | "2160x3840" | "2160x5040" | "2520x1080" | "2880x2160" | "3240x2160" | "3840x2160" | "5040x2160" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/syntax.mdx b/client-sdks/typescript/api-reference/models/syntax.mdx deleted file mode 100644 index 5e55f46b..00000000 --- a/client-sdks/typescript/api-reference/models/syntax.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Syntax - TypeScript SDK -sidebarTitle: Syntax -description: Syntax type definition -seoTitle: Syntax Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/syntax' -'og:site_name': OpenRouter Documentation -'og:title': Syntax Type | OpenRouter TypeScript SDK -'og:description': >- - Syntax type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Syntax%20-%20TypeScript%20SDK&description=Syntax%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Syntax } from "@openrouter/sdk/models"; - -let value: Syntax = "regex"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"lark" | "regex" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/system.mdx b/client-sdks/typescript/api-reference/models/system.mdx deleted file mode 100644 index 61c657be..00000000 --- a/client-sdks/typescript/api-reference/models/system.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: System - TypeScript SDK -sidebarTitle: System -description: System type definition -seoTitle: System Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/system' -'og:site_name': OpenRouter Documentation -'og:title': System Type | OpenRouter TypeScript SDK -'og:description': >- - System type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=System%20-%20TypeScript%20SDK&description=System%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.AnthropicTextBlockParam[]` - -```typescript lines -const value: models.AnthropicTextBlockParam[] = [ - { - text: "Hello, world!", - type: "text", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/taskbudget.mdx b/client-sdks/typescript/api-reference/models/taskbudget.mdx deleted file mode 100644 index bc0d217a..00000000 --- a/client-sdks/typescript/api-reference/models/taskbudget.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: TaskBudget - TypeScript SDK -sidebarTitle: TaskBudget -description: TaskBudget type definition -seoTitle: TaskBudget Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/taskbudget' -'og:site_name': OpenRouter Documentation -'og:title': TaskBudget Type | OpenRouter TypeScript SDK -'og:description': >- - TaskBudget type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TaskBudget%20-%20TypeScript%20SDK&description=TaskBudget%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { TaskBudget } from "@openrouter/sdk/models"; - -let value: TaskBudget = { - total: 400000, - type: "tokens", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `remaining` | *number* | :heavy_minus_sign: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.TypeTokens](/client-sdks/typescript/api-reference/models/typetokens) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/textdeltaevent.mdx b/client-sdks/typescript/api-reference/models/textdeltaevent.mdx deleted file mode 100644 index f502d4bd..00000000 --- a/client-sdks/typescript/api-reference/models/textdeltaevent.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: TextDeltaEvent - TypeScript SDK -sidebarTitle: TextDeltaEvent -description: TextDeltaEvent type definition -seoTitle: TextDeltaEvent Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/textdeltaevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDeltaEvent Type | OpenRouter TypeScript SDK -'og:description': >- - TextDeltaEvent type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDeltaEvent%20-%20TypeScript%20SDK&description=TextDeltaEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a text delta is streamed - -## Example Usage - -```typescript lines -import { TextDeltaEvent } from "@openrouter/sdk/models"; - -let value: TextDeltaEvent = { - contentIndex: 391056, - delta: "", - itemId: "", - logprobs: [ - { - logprob: -0.5, - token: "Hello", - }, - ], - outputIndex: 776894, - sequenceNumber: 0, - type: "response.output_text.delta", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](/client-sdks/typescript/api-reference/models/streamlogprob)[] | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.output_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/textdoneevent.mdx b/client-sdks/typescript/api-reference/models/textdoneevent.mdx deleted file mode 100644 index a19c4f13..00000000 --- a/client-sdks/typescript/api-reference/models/textdoneevent.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: TextDoneEvent - TypeScript SDK -sidebarTitle: TextDoneEvent -description: TextDoneEvent type definition -seoTitle: TextDoneEvent Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/textdoneevent' -'og:site_name': OpenRouter Documentation -'og:title': TextDoneEvent Type | OpenRouter TypeScript SDK -'og:description': >- - TextDoneEvent type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextDoneEvent%20-%20TypeScript%20SDK&description=TextDoneEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when text streaming is complete - -## Example Usage - -```typescript lines -import { TextDoneEvent } from "@openrouter/sdk/models"; - -let value: TextDoneEvent = { - contentIndex: 541485, - itemId: "", - logprobs: [ - { - logprob: -0.5, - token: "Hello", - }, - ], - outputIndex: 497734, - sequenceNumber: 0, - text: "", - type: "response.output_text.done", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](/client-sdks/typescript/api-reference/models/streamlogprob)[] | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.output_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/textextendedconfig.mdx b/client-sdks/typescript/api-reference/models/textextendedconfig.mdx deleted file mode 100644 index b78b0565..00000000 --- a/client-sdks/typescript/api-reference/models/textextendedconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: TextExtendedConfig - TypeScript SDK -sidebarTitle: TextExtendedConfig -description: TextExtendedConfig type definition -seoTitle: TextExtendedConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/textextendedconfig -'og:site_name': OpenRouter Documentation -'og:title': TextExtendedConfig Type | OpenRouter TypeScript SDK -'og:description': >- - TextExtendedConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TextExtendedConfig%20-%20TypeScript%20SDK&description=TextExtendedConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Example Usage - -```typescript lines -import { TextExtendedConfig } from "@openrouter/sdk/models"; - -let value: TextExtendedConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `format` | *models.Formats* | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [models.Verbosity](/client-sdks/typescript/api-reference/models/verbosity) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/thinking.mdx b/client-sdks/typescript/api-reference/models/thinking.mdx deleted file mode 100644 index 25bc7380..00000000 --- a/client-sdks/typescript/api-reference/models/thinking.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Thinking - TypeScript SDK -sidebarTitle: Thinking -description: Thinking type definition -seoTitle: Thinking Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/thinking' -'og:site_name': OpenRouter Documentation -'og:title': Thinking Type | OpenRouter TypeScript SDK -'og:description': >- - Thinking type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Thinking%20-%20TypeScript%20SDK&description=Thinking%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ThinkingEnabled` - -```typescript lines -const value: models.ThinkingEnabled = { - budgetTokens: 599839, - type: "enabled", -}; -``` - -### `models.ThinkingDisabled` - -```typescript lines -const value: models.ThinkingDisabled = { - type: "disabled", -}; -``` - -### `models.ThinkingAdaptive` - -```typescript lines -const value: models.ThinkingAdaptive = { - type: "adaptive", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/thinkingadaptive.mdx b/client-sdks/typescript/api-reference/models/thinkingadaptive.mdx deleted file mode 100644 index 5cada25d..00000000 --- a/client-sdks/typescript/api-reference/models/thinkingadaptive.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ThinkingAdaptive - TypeScript SDK -sidebarTitle: ThinkingAdaptive -description: ThinkingAdaptive type definition -seoTitle: ThinkingAdaptive Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/thinkingadaptive -'og:site_name': OpenRouter Documentation -'og:title': ThinkingAdaptive Type | OpenRouter TypeScript SDK -'og:description': >- - ThinkingAdaptive type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingAdaptive%20-%20TypeScript%20SDK&description=ThinkingAdaptive%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ThinkingAdaptive } from "@openrouter/sdk/models"; - -let value: ThinkingAdaptive = { - type: "adaptive", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `display` | [models.AnthropicThinkingDisplay](/client-sdks/typescript/api-reference/models/anthropicthinkingdisplay) | :heavy_minus_sign: | N/A | summarized | -| `type` | *"adaptive"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/thinkingdisabled.mdx b/client-sdks/typescript/api-reference/models/thinkingdisabled.mdx deleted file mode 100644 index d82ee48e..00000000 --- a/client-sdks/typescript/api-reference/models/thinkingdisabled.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ThinkingDisabled - TypeScript SDK -sidebarTitle: ThinkingDisabled -description: ThinkingDisabled type definition -seoTitle: ThinkingDisabled Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/thinkingdisabled -'og:site_name': OpenRouter Documentation -'og:title': ThinkingDisabled Type | OpenRouter TypeScript SDK -'og:description': >- - ThinkingDisabled type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingDisabled%20-%20TypeScript%20SDK&description=ThinkingDisabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ThinkingDisabled } from "@openrouter/sdk/models"; - -let value: ThinkingDisabled = { - type: "disabled", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"disabled"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/thinkingenabled.mdx b/client-sdks/typescript/api-reference/models/thinkingenabled.mdx deleted file mode 100644 index dae66c6c..00000000 --- a/client-sdks/typescript/api-reference/models/thinkingenabled.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ThinkingEnabled - TypeScript SDK -sidebarTitle: ThinkingEnabled -description: ThinkingEnabled type definition -seoTitle: ThinkingEnabled Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/thinkingenabled -'og:site_name': OpenRouter Documentation -'og:title': ThinkingEnabled Type | OpenRouter TypeScript SDK -'og:description': >- - ThinkingEnabled type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ThinkingEnabled%20-%20TypeScript%20SDK&description=ThinkingEnabled%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ThinkingEnabled } from "@openrouter/sdk/models"; - -let value: ThinkingEnabled = { - budgetTokens: 599839, - type: "enabled", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `budgetTokens` | *number* | :heavy_check_mark: | N/A | | -| `display` | [models.AnthropicThinkingDisplay](/client-sdks/typescript/api-reference/models/anthropicthinkingdisplay) | :heavy_minus_sign: | N/A | summarized | -| `type` | *"enabled"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/tokenizer.mdx b/client-sdks/typescript/api-reference/models/tokenizer.mdx deleted file mode 100644 index 45002ffa..00000000 --- a/client-sdks/typescript/api-reference/models/tokenizer.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Tokenizer - TypeScript SDK -sidebarTitle: Tokenizer -description: Tokenizer type definition -seoTitle: Tokenizer Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/tokenizer' -'og:site_name': OpenRouter Documentation -'og:title': Tokenizer Type | OpenRouter TypeScript SDK -'og:description': >- - Tokenizer type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Tokenizer%20-%20TypeScript%20SDK&description=Tokenizer%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```typescript lines -import { Tokenizer } from "@openrouter/sdk/models"; - -let value: Tokenizer = "GPT"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"Router" | "Media" | "Other" | "GPT" | "Claude" | "Gemini" | "Gemma" | "Grok" | "Cohere" | "Nova" | "Qwen" | "Yi" | "DeepSeek" | "Mistral" | "Llama2" | "Llama3" | "Llama4" | "PaLM" | "RWKV" | "Qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/tooladvisor20260301.mdx b/client-sdks/typescript/api-reference/models/tooladvisor20260301.mdx deleted file mode 100644 index 25a5f4e8..00000000 --- a/client-sdks/typescript/api-reference/models/tooladvisor20260301.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ToolAdvisor20260301 - TypeScript SDK -sidebarTitle: ToolAdvisor20260301 -description: ToolAdvisor20260301 type definition -seoTitle: ToolAdvisor20260301 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/tooladvisor20260301 -'og:site_name': OpenRouter Documentation -'og:title': ToolAdvisor20260301 Type | OpenRouter TypeScript SDK -'og:description': >- - ToolAdvisor20260301 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolAdvisor20260301%20-%20TypeScript%20SDK&description=ToolAdvisor20260301%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolAdvisor20260301 } from "@openrouter/sdk/models"; - -let value: ToolAdvisor20260301 = { - model: "Fortwo", - name: "advisor", - type: "advisor_20260301", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedCallers` | [models.AnthropicAllowedCallers](/client-sdks/typescript/api-reference/models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `caching` | [models.Caching](/client-sdks/typescript/api-reference/models/caching) | :heavy_minus_sign: | N/A | `{"type": "ephemeral"}` | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `name` | [models.NameAdvisor](/client-sdks/typescript/api-reference/models/nameadvisor) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeAdvisor20260301](/client-sdks/typescript/api-reference/models/typeadvisor20260301) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolbash20250124.mdx b/client-sdks/typescript/api-reference/models/toolbash20250124.mdx deleted file mode 100644 index 5e033aed..00000000 --- a/client-sdks/typescript/api-reference/models/toolbash20250124.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ToolBash20250124 - TypeScript SDK -sidebarTitle: ToolBash20250124 -description: ToolBash20250124 type definition -seoTitle: ToolBash20250124 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toolbash20250124 -'og:site_name': OpenRouter Documentation -'og:title': ToolBash20250124 Type | OpenRouter TypeScript SDK -'og:description': >- - ToolBash20250124 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolBash20250124%20-%20TypeScript%20SDK&description=ToolBash20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolBash20250124 } from "@openrouter/sdk/models"; - -let value: ToolBash20250124 = { - name: "bash", - type: "bash_20250124", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `name` | [models.NameBash](/client-sdks/typescript/api-reference/models/namebash) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeBash20250124](/client-sdks/typescript/api-reference/models/typebash20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolcallstatus.mdx b/client-sdks/typescript/api-reference/models/toolcallstatus.mdx deleted file mode 100644 index 004087cf..00000000 --- a/client-sdks/typescript/api-reference/models/toolcallstatus.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolCallStatus - TypeScript SDK -sidebarTitle: ToolCallStatus -description: ToolCallStatus type definition -seoTitle: ToolCallStatus Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ToolCallStatus Type | OpenRouter TypeScript SDK -'og:description': >- - ToolCallStatus type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCallStatus%20-%20TypeScript%20SDK&description=ToolCallStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolCallStatus } from "@openrouter/sdk/models"; - -let value: ToolCallStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoice.mdx b/client-sdks/typescript/api-reference/models/toolchoice.mdx deleted file mode 100644 index 4224b30a..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoice.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ToolChoice - TypeScript SDK -sidebarTitle: ToolChoice -description: ToolChoice type definition -seoTitle: ToolChoice Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolchoice' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoice Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoice type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoice%20-%20TypeScript%20SDK&description=ToolChoice%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ToolChoiceAuto` - -```typescript lines -const value: models.ToolChoiceAuto = { - type: "auto", -}; -``` - -### `models.ToolChoiceAny` - -```typescript lines -const value: models.ToolChoiceAny = { - type: "any", -}; -``` - -### `models.ToolChoiceNone` - -```typescript lines -const value: models.ToolChoiceNone = { - type: "none", -}; -``` - -### `models.ToolChoiceTool` - -```typescript lines -const value: models.ToolChoiceTool = { - name: "", - type: "tool", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoiceallowed.mdx b/client-sdks/typescript/api-reference/models/toolchoiceallowed.mdx deleted file mode 100644 index 05e4590a..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoiceallowed.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: ToolChoiceAllowed - TypeScript SDK -sidebarTitle: ToolChoiceAllowed -description: ToolChoiceAllowed type definition -seoTitle: ToolChoiceAllowed Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toolchoiceallowed -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowed Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceAllowed type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowed%20-%20TypeScript%20SDK&description=ToolChoiceAllowed%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Constrains the model to a pre-defined set of allowed tools - -## Example Usage - -```typescript lines -import { ToolChoiceAllowed } from "@openrouter/sdk/models"; - -let value: ToolChoiceAllowed = { - mode: "auto", - tools: [ - { - "name": "get_weather", - "type": "function", - }, - ], - type: "allowed_tools", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `mode` | *models.Mode* | :heavy_check_mark: | N/A | -| `tools` | `Record`[] | :heavy_check_mark: | N/A | -| `type` | [models.ToolChoiceAllowedType](/client-sdks/typescript/api-reference/models/toolchoiceallowedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoiceallowedtype.mdx b/client-sdks/typescript/api-reference/models/toolchoiceallowedtype.mdx deleted file mode 100644 index bc94b786..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoiceallowedtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ToolChoiceAllowedType - TypeScript SDK -sidebarTitle: ToolChoiceAllowedType -description: ToolChoiceAllowedType type definition -seoTitle: ToolChoiceAllowedType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toolchoiceallowedtype -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAllowedType Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceAllowedType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAllowedType%20-%20TypeScript%20SDK&description=ToolChoiceAllowedType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolChoiceAllowedType } from "@openrouter/sdk/models"; - -let value: ToolChoiceAllowedType = "allowed_tools"; -``` - -## Values - -```typescript lines -"allowed_tools" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoiceany.mdx b/client-sdks/typescript/api-reference/models/toolchoiceany.mdx deleted file mode 100644 index cfa2c80f..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoiceany.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ToolChoiceAny - TypeScript SDK -sidebarTitle: ToolChoiceAny -description: ToolChoiceAny type definition -seoTitle: ToolChoiceAny Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolchoiceany' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAny Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceAny type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAny%20-%20TypeScript%20SDK&description=ToolChoiceAny%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolChoiceAny } from "@openrouter/sdk/models"; - -let value: ToolChoiceAny = { - type: "any", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"any"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoiceauto.mdx b/client-sdks/typescript/api-reference/models/toolchoiceauto.mdx deleted file mode 100644 index 3c82688c..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoiceauto.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ToolChoiceAuto - TypeScript SDK -sidebarTitle: ToolChoiceAuto -description: ToolChoiceAuto type definition -seoTitle: ToolChoiceAuto Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolchoiceauto' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceAuto Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceAuto type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceAuto%20-%20TypeScript%20SDK&description=ToolChoiceAuto%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolChoiceAuto } from "@openrouter/sdk/models"; - -let value: ToolChoiceAuto = { - type: "auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"auto"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoicenone.mdx b/client-sdks/typescript/api-reference/models/toolchoicenone.mdx deleted file mode 100644 index 30b35feb..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoicenone.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ToolChoiceNone - TypeScript SDK -sidebarTitle: ToolChoiceNone -description: ToolChoiceNone type definition -seoTitle: ToolChoiceNone Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolchoicenone' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceNone Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceNone type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceNone%20-%20TypeScript%20SDK&description=ToolChoiceNone%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolChoiceNone } from "@openrouter/sdk/models"; - -let value: ToolChoiceNone = { - type: "none", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"none"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolchoicetool.mdx b/client-sdks/typescript/api-reference/models/toolchoicetool.mdx deleted file mode 100644 index 9506c335..00000000 --- a/client-sdks/typescript/api-reference/models/toolchoicetool.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ToolChoiceTool - TypeScript SDK -sidebarTitle: ToolChoiceTool -description: ToolChoiceTool type definition -seoTitle: ToolChoiceTool Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolchoicetool' -'og:site_name': OpenRouter Documentation -'og:title': ToolChoiceTool Type | OpenRouter TypeScript SDK -'og:description': >- - ToolChoiceTool type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolChoiceTool%20-%20TypeScript%20SDK&description=ToolChoiceTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolChoiceTool } from "@openrouter/sdk/models"; - -let value: ToolChoiceTool = { - name: "", - type: "tool", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolcustom.mdx b/client-sdks/typescript/api-reference/models/toolcustom.mdx deleted file mode 100644 index 3e779b2b..00000000 --- a/client-sdks/typescript/api-reference/models/toolcustom.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ToolCustom - TypeScript SDK -sidebarTitle: ToolCustom -description: ToolCustom type definition -seoTitle: ToolCustom Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/toolcustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolCustom Type | OpenRouter TypeScript SDK -'og:description': >- - ToolCustom type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCustom%20-%20TypeScript%20SDK&description=ToolCustom%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolCustom } from "@openrouter/sdk/models"; - -let value: ToolCustom = { - inputSchema: {}, - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `inputSchema` | [models.InputSchema](/client-sdks/typescript/api-reference/models/inputschema) | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.ToolTypeCustom](/client-sdks/typescript/api-reference/models/tooltypecustom) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/tooltexteditor20250124.mdx b/client-sdks/typescript/api-reference/models/tooltexteditor20250124.mdx deleted file mode 100644 index c36ec13a..00000000 --- a/client-sdks/typescript/api-reference/models/tooltexteditor20250124.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ToolTextEditor20250124 - TypeScript SDK -sidebarTitle: ToolTextEditor20250124 -description: ToolTextEditor20250124 type definition -seoTitle: ToolTextEditor20250124 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/tooltexteditor20250124 -'og:site_name': OpenRouter Documentation -'og:title': ToolTextEditor20250124 Type | OpenRouter TypeScript SDK -'og:description': >- - ToolTextEditor20250124 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTextEditor20250124%20-%20TypeScript%20SDK&description=ToolTextEditor20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolTextEditor20250124 } from "@openrouter/sdk/models"; - -let value: ToolTextEditor20250124 = { - name: "str_replace_editor", - type: "text_editor_20250124", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `name` | [models.NameStrReplaceEditor](/client-sdks/typescript/api-reference/models/namestrreplaceeditor) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeTextEditor20250124](/client-sdks/typescript/api-reference/models/typetexteditor20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/tooltypecustom.mdx b/client-sdks/typescript/api-reference/models/tooltypecustom.mdx deleted file mode 100644 index cb4ecbc1..00000000 --- a/client-sdks/typescript/api-reference/models/tooltypecustom.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ToolTypeCustom - TypeScript SDK -sidebarTitle: ToolTypeCustom -description: ToolTypeCustom type definition -seoTitle: ToolTypeCustom Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/tooltypecustom' -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeCustom Type | OpenRouter TypeScript SDK -'og:description': >- - ToolTypeCustom type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeCustom%20-%20TypeScript%20SDK&description=ToolTypeCustom%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolTypeCustom } from "@openrouter/sdk/models"; - -let value: ToolTypeCustom = "custom"; -``` - -## Values - -```typescript lines -"custom" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/tooltypeephemeral.mdx b/client-sdks/typescript/api-reference/models/tooltypeephemeral.mdx deleted file mode 100644 index f87d0164..00000000 --- a/client-sdks/typescript/api-reference/models/tooltypeephemeral.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ToolTypeEphemeral - TypeScript SDK -sidebarTitle: ToolTypeEphemeral -description: ToolTypeEphemeral type definition -seoTitle: ToolTypeEphemeral Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/tooltypeephemeral -'og:site_name': OpenRouter Documentation -'og:title': ToolTypeEphemeral Type | OpenRouter TypeScript SDK -'og:description': >- - ToolTypeEphemeral type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolTypeEphemeral%20-%20TypeScript%20SDK&description=ToolTypeEphemeral%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolTypeEphemeral } from "@openrouter/sdk/models"; - -let value: ToolTypeEphemeral = "ephemeral"; -``` - -## Values - -```typescript lines -"ephemeral" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/toolwebsearch20250305.mdx b/client-sdks/typescript/api-reference/models/toolwebsearch20250305.mdx deleted file mode 100644 index 3dcf5d75..00000000 --- a/client-sdks/typescript/api-reference/models/toolwebsearch20250305.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ToolWebSearch20250305 - TypeScript SDK -sidebarTitle: ToolWebSearch20250305 -description: ToolWebSearch20250305 type definition -seoTitle: ToolWebSearch20250305 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toolwebsearch20250305 -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20250305 Type | OpenRouter TypeScript SDK -'og:description': >- - ToolWebSearch20250305 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20250305%20-%20TypeScript%20SDK&description=ToolWebSearch20250305%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolWebSearch20250305 } from "@openrouter/sdk/models"; - -let value: ToolWebSearch20250305 = { - name: "web_search", - type: "web_search_20250305", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch1](/client-sdks/typescript/api-reference/models/namewebsearch1) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20250305](/client-sdks/typescript/api-reference/models/typewebsearch20250305) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/toolwebsearch20260209.mdx b/client-sdks/typescript/api-reference/models/toolwebsearch20260209.mdx deleted file mode 100644 index d9d3998f..00000000 --- a/client-sdks/typescript/api-reference/models/toolwebsearch20260209.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ToolWebSearch20260209 - TypeScript SDK -sidebarTitle: ToolWebSearch20260209 -description: ToolWebSearch20260209 type definition -seoTitle: ToolWebSearch20260209 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toolwebsearch20260209 -'og:site_name': OpenRouter Documentation -'og:title': ToolWebSearch20260209 Type | OpenRouter TypeScript SDK -'og:description': >- - ToolWebSearch20260209 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolWebSearch20260209%20-%20TypeScript%20SDK&description=ToolWebSearch20260209%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolWebSearch20260209 } from "@openrouter/sdk/models"; - -let value: ToolWebSearch20260209 = { - name: "web_search", - type: "web_search_20260209", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedCallers` | [models.AnthropicAllowedCallers](/client-sdks/typescript/api-reference/models/anthropicallowedcallers)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](/client-sdks/typescript/api-reference/models/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. Currently supported for Anthropic Claude models. | `{"type": "ephemeral"}` | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch2](/client-sdks/typescript/api-reference/models/namewebsearch2) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20260209](/client-sdks/typescript/api-reference/models/typewebsearch20260209) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/toomanyrequestsresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/toomanyrequestsresponseerrordata.mdx deleted file mode 100644 index a063ddbd..00000000 --- a/client-sdks/typescript/api-reference/models/toomanyrequestsresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: TooManyRequestsResponseErrorData - TypeScript SDK -sidebarTitle: TooManyRequestsResponseErrorData -description: TooManyRequestsResponseErrorData type definition -seoTitle: TooManyRequestsResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/toomanyrequestsresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - TooManyRequestsResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseErrorData%20-%20TypeScript%20SDK&description=TooManyRequestsResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for TooManyRequestsResponse - -## Example Usage - -```typescript lines -import { TooManyRequestsResponseErrorData } from "@openrouter/sdk/models"; - -let value: TooManyRequestsResponseErrorData = { - code: 429, - message: "Rate limit exceeded", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/topproviderinfo.mdx b/client-sdks/typescript/api-reference/models/topproviderinfo.mdx deleted file mode 100644 index 6de0e78d..00000000 --- a/client-sdks/typescript/api-reference/models/topproviderinfo.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: TopProviderInfo - TypeScript SDK -sidebarTitle: TopProviderInfo -description: TopProviderInfo type definition -seoTitle: TopProviderInfo Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/topproviderinfo -'og:site_name': OpenRouter Documentation -'og:title': TopProviderInfo Type | OpenRouter TypeScript SDK -'og:description': >- - TopProviderInfo type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TopProviderInfo%20-%20TypeScript%20SDK&description=TopProviderInfo%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about the top provider for this model - -## Example Usage - -```typescript lines -import { TopProviderInfo } from "@openrouter/sdk/models"; - -let value: TopProviderInfo = { - isModerated: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `contextLength` | *number* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `isModerated` | *boolean* | :heavy_check_mark: | Whether the top provider moderates content | true | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum completion tokens from the top provider | 4096 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/traceconfig.mdx b/client-sdks/typescript/api-reference/models/traceconfig.mdx deleted file mode 100644 index 41ad9bba..00000000 --- a/client-sdks/typescript/api-reference/models/traceconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: TraceConfig - TypeScript SDK -sidebarTitle: TraceConfig -description: TraceConfig type definition -seoTitle: TraceConfig Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/traceconfig' -'og:site_name': OpenRouter Documentation -'og:title': TraceConfig Type | OpenRouter TypeScript SDK -'og:description': >- - TraceConfig type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TraceConfig%20-%20TypeScript%20SDK&description=TraceConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { TraceConfig } from "@openrouter/sdk/models"; - -let value: TraceConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `generationName` | *string* | :heavy_minus_sign: | N/A | | -| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | | -| `spanName` | *string* | :heavy_minus_sign: | N/A | | -| `traceId` | *string* | :heavy_minus_sign: | N/A | | -| `traceName` | *string* | :heavy_minus_sign: | N/A | | -| `additionalProperties` | `Record` | :heavy_minus_sign: | N/A | `{"trace_id": "trace-abc123","trace_name": "my-app-trace"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/trigger.mdx b/client-sdks/typescript/api-reference/models/trigger.mdx deleted file mode 100644 index 545d9b8d..00000000 --- a/client-sdks/typescript/api-reference/models/trigger.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Trigger - TypeScript SDK -sidebarTitle: Trigger -description: Trigger type definition -seoTitle: Trigger Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/trigger' -'og:site_name': OpenRouter Documentation -'og:title': Trigger Type | OpenRouter TypeScript SDK -'og:description': >- - Trigger type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Trigger%20-%20TypeScript%20SDK&description=Trigger%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.AnthropicInputTokensTrigger` - -```typescript lines -const value: models.AnthropicInputTokensTrigger = { - type: "input_tokens", - value: 100000, -}; -``` - -### `models.AnthropicToolUsesTrigger` - -```typescript lines -const value: models.AnthropicToolUsesTrigger = { - type: "tool_uses", - value: 10, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/triggerinputtokens.mdx b/client-sdks/typescript/api-reference/models/triggerinputtokens.mdx deleted file mode 100644 index 1bf8d656..00000000 --- a/client-sdks/typescript/api-reference/models/triggerinputtokens.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: TriggerInputTokens - TypeScript SDK -sidebarTitle: TriggerInputTokens -description: TriggerInputTokens type definition -seoTitle: TriggerInputTokens Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/triggerinputtokens -'og:site_name': OpenRouter Documentation -'og:title': TriggerInputTokens Type | OpenRouter TypeScript SDK -'og:description': >- - TriggerInputTokens type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TriggerInputTokens%20-%20TypeScript%20SDK&description=TriggerInputTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TriggerInputTokens } from "@openrouter/sdk/models"; - -let value: TriggerInputTokens = { - type: "input_tokens", - value: 100000, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.EditTypeInputTokens](/client-sdks/typescript/api-reference/models/edittypeinputtokens) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/truncation.mdx b/client-sdks/typescript/api-reference/models/truncation.mdx deleted file mode 100644 index 0dc616ec..00000000 --- a/client-sdks/typescript/api-reference/models/truncation.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Truncation - TypeScript SDK -sidebarTitle: Truncation -description: Truncation type definition -seoTitle: Truncation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/truncation' -'og:site_name': OpenRouter Documentation -'og:title': Truncation Type | OpenRouter TypeScript SDK -'og:description': >- - Truncation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Truncation%20-%20TypeScript%20SDK&description=Truncation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Truncation } from "@openrouter/sdk/models"; - -let value: Truncation = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "disabled" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/type.mdx b/client-sdks/typescript/api-reference/models/type.mdx deleted file mode 100644 index 48415f83..00000000 --- a/client-sdks/typescript/api-reference/models/type.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Type - TypeScript SDK -sidebarTitle: Type -description: Type type definition -seoTitle: Type Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/type' -'og:site_name': OpenRouter Documentation -'og:title': Type Type | OpenRouter TypeScript SDK -'og:description': >- - Type type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Type%20-%20TypeScript%20SDK&description=Type%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = - "web_search_preview_2025_03_11"; -``` - -### `models.OpenAIResponsesToolChoiceTypeWebSearchPreview` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceTypeWebSearchPreview = - "web_search_preview"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typeadvisor20260301.mdx b/client-sdks/typescript/api-reference/models/typeadvisor20260301.mdx deleted file mode 100644 index a0831dab..00000000 --- a/client-sdks/typescript/api-reference/models/typeadvisor20260301.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeAdvisor20260301 - TypeScript SDK -sidebarTitle: TypeAdvisor20260301 -description: TypeAdvisor20260301 type definition -seoTitle: TypeAdvisor20260301 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typeadvisor20260301 -'og:site_name': OpenRouter Documentation -'og:title': TypeAdvisor20260301 Type | OpenRouter TypeScript SDK -'og:description': >- - TypeAdvisor20260301 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeAdvisor20260301%20-%20TypeScript%20SDK&description=TypeAdvisor20260301%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeAdvisor20260301 } from "@openrouter/sdk/models"; - -let value: TypeAdvisor20260301 = "advisor_20260301"; -``` - -## Values - -```typescript lines -"advisor_20260301" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typebash20250124.mdx b/client-sdks/typescript/api-reference/models/typebash20250124.mdx deleted file mode 100644 index 1618db6a..00000000 --- a/client-sdks/typescript/api-reference/models/typebash20250124.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeBash20250124 - TypeScript SDK -sidebarTitle: TypeBash20250124 -description: TypeBash20250124 type definition -seoTitle: TypeBash20250124 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typebash20250124 -'og:site_name': OpenRouter Documentation -'og:title': TypeBash20250124 Type | OpenRouter TypeScript SDK -'og:description': >- - TypeBash20250124 type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeBash20250124%20-%20TypeScript%20SDK&description=TypeBash20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeBash20250124 } from "@openrouter/sdk/models"; - -let value: TypeBash20250124 = "bash_20250124"; -``` - -## Values - -```typescript lines -"bash_20250124" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typecodeinterpretercall.mdx b/client-sdks/typescript/api-reference/models/typecodeinterpretercall.mdx deleted file mode 100644 index d3aaedee..00000000 --- a/client-sdks/typescript/api-reference/models/typecodeinterpretercall.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeCodeInterpreterCall - TypeScript SDK -sidebarTitle: TypeCodeInterpreterCall -description: TypeCodeInterpreterCall type definition -seoTitle: TypeCodeInterpreterCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typecodeinterpretercall -'og:site_name': OpenRouter Documentation -'og:title': TypeCodeInterpreterCall Type | OpenRouter TypeScript SDK -'og:description': >- - TypeCodeInterpreterCall type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeCodeInterpreterCall%20-%20TypeScript%20SDK&description=TypeCodeInterpreterCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeCodeInterpreterCall } from "@openrouter/sdk/models"; - -let value: TypeCodeInterpreterCall = "code_interpreter_call"; -``` - -## Values - -```typescript lines -"code_interpreter_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typeexec.mdx b/client-sdks/typescript/api-reference/models/typeexec.mdx deleted file mode 100644 index 021cbd58..00000000 --- a/client-sdks/typescript/api-reference/models/typeexec.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TypeExec - TypeScript SDK -sidebarTitle: TypeExec -description: TypeExec type definition -seoTitle: TypeExec Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/typeexec' -'og:site_name': OpenRouter Documentation -'og:title': TypeExec Type | OpenRouter TypeScript SDK -'og:description': >- - TypeExec type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeExec%20-%20TypeScript%20SDK&description=TypeExec%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeExec } from "@openrouter/sdk/models"; - -let value: TypeExec = "exec"; -``` - -## Values - -```typescript lines -"exec" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typelocalshellcall.mdx b/client-sdks/typescript/api-reference/models/typelocalshellcall.mdx deleted file mode 100644 index 09f254b7..00000000 --- a/client-sdks/typescript/api-reference/models/typelocalshellcall.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeLocalShellCall - TypeScript SDK -sidebarTitle: TypeLocalShellCall -description: TypeLocalShellCall type definition -seoTitle: TypeLocalShellCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typelocalshellcall -'og:site_name': OpenRouter Documentation -'og:title': TypeLocalShellCall Type | OpenRouter TypeScript SDK -'og:description': >- - TypeLocalShellCall type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeLocalShellCall%20-%20TypeScript%20SDK&description=TypeLocalShellCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeLocalShellCall } from "@openrouter/sdk/models"; - -let value: TypeLocalShellCall = "local_shell_call"; -``` - -## Values - -```typescript lines -"local_shell_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typetexteditor20250124.mdx b/client-sdks/typescript/api-reference/models/typetexteditor20250124.mdx deleted file mode 100644 index bfe27ace..00000000 --- a/client-sdks/typescript/api-reference/models/typetexteditor20250124.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeTextEditor20250124 - TypeScript SDK -sidebarTitle: TypeTextEditor20250124 -description: TypeTextEditor20250124 type definition -seoTitle: TypeTextEditor20250124 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typetexteditor20250124 -'og:site_name': OpenRouter Documentation -'og:title': TypeTextEditor20250124 Type | OpenRouter TypeScript SDK -'og:description': >- - TypeTextEditor20250124 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTextEditor20250124%20-%20TypeScript%20SDK&description=TypeTextEditor20250124%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeTextEditor20250124 } from "@openrouter/sdk/models"; - -let value: TypeTextEditor20250124 = "text_editor_20250124"; -``` - -## Values - -```typescript lines -"text_editor_20250124" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typetokens.mdx b/client-sdks/typescript/api-reference/models/typetokens.mdx deleted file mode 100644 index de0b0dc9..00000000 --- a/client-sdks/typescript/api-reference/models/typetokens.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: TypeTokens - TypeScript SDK -sidebarTitle: TypeTokens -description: TypeTokens type definition -seoTitle: TypeTokens Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/typetokens' -'og:site_name': OpenRouter Documentation -'og:title': TypeTokens Type | OpenRouter TypeScript SDK -'og:description': >- - TypeTokens type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeTokens%20-%20TypeScript%20SDK&description=TypeTokens%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeTokens } from "@openrouter/sdk/models"; - -let value: TypeTokens = "tokens"; -``` - -## Values - -```typescript lines -"tokens" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typewebsearch20250305.mdx b/client-sdks/typescript/api-reference/models/typewebsearch20250305.mdx deleted file mode 100644 index 59ed0862..00000000 --- a/client-sdks/typescript/api-reference/models/typewebsearch20250305.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeWebSearch20250305 - TypeScript SDK -sidebarTitle: TypeWebSearch20250305 -description: TypeWebSearch20250305 type definition -seoTitle: TypeWebSearch20250305 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typewebsearch20250305 -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20250305 Type | OpenRouter TypeScript SDK -'og:description': >- - TypeWebSearch20250305 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20250305%20-%20TypeScript%20SDK&description=TypeWebSearch20250305%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeWebSearch20250305 } from "@openrouter/sdk/models"; - -let value: TypeWebSearch20250305 = "web_search_20250305"; -``` - -## Values - -```typescript lines -"web_search_20250305" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typewebsearch20260209.mdx b/client-sdks/typescript/api-reference/models/typewebsearch20260209.mdx deleted file mode 100644 index 547ced0b..00000000 --- a/client-sdks/typescript/api-reference/models/typewebsearch20260209.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeWebSearch20260209 - TypeScript SDK -sidebarTitle: TypeWebSearch20260209 -description: TypeWebSearch20260209 type definition -seoTitle: TypeWebSearch20260209 Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typewebsearch20260209 -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearch20260209 Type | OpenRouter TypeScript SDK -'og:description': >- - TypeWebSearch20260209 type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearch20260209%20-%20TypeScript%20SDK&description=TypeWebSearch20260209%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeWebSearch20260209 } from "@openrouter/sdk/models"; - -let value: TypeWebSearch20260209 = "web_search_20260209"; -``` - -## Values - -```typescript lines -"web_search_20260209" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typewebsearchcall.mdx b/client-sdks/typescript/api-reference/models/typewebsearchcall.mdx deleted file mode 100644 index a2d7d0d2..00000000 --- a/client-sdks/typescript/api-reference/models/typewebsearchcall.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeWebSearchCall - TypeScript SDK -sidebarTitle: TypeWebSearchCall -description: TypeWebSearchCall type definition -seoTitle: TypeWebSearchCall Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typewebsearchcall -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchCall Type | OpenRouter TypeScript SDK -'og:description': >- - TypeWebSearchCall type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchCall%20-%20TypeScript%20SDK&description=TypeWebSearchCall%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeWebSearchCall } from "@openrouter/sdk/models"; - -let value: TypeWebSearchCall = "web_search_call"; -``` - -## Values - -```typescript lines -"web_search_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/typewebsearchtoolresulterror.mdx b/client-sdks/typescript/api-reference/models/typewebsearchtoolresulterror.mdx deleted file mode 100644 index a41073cd..00000000 --- a/client-sdks/typescript/api-reference/models/typewebsearchtoolresulterror.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: TypeWebSearchToolResultError - TypeScript SDK -sidebarTitle: TypeWebSearchToolResultError -description: TypeWebSearchToolResultError type definition -seoTitle: TypeWebSearchToolResultError Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/typewebsearchtoolresulterror -'og:site_name': OpenRouter Documentation -'og:title': TypeWebSearchToolResultError Type | OpenRouter TypeScript SDK -'og:description': >- - TypeWebSearchToolResultError type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeWebSearchToolResultError%20-%20TypeScript%20SDK&description=TypeWebSearchToolResultError%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { TypeWebSearchToolResultError } from "@openrouter/sdk/models"; - -let value: TypeWebSearchToolResultError = "web_search_tool_result_error"; -``` - -## Values - -```typescript lines -"web_search_tool_result_error" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/unauthorizedresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/unauthorizedresponseerrordata.mdx deleted file mode 100644 index a1f80b0e..00000000 --- a/client-sdks/typescript/api-reference/models/unauthorizedresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UnauthorizedResponseErrorData - TypeScript SDK -sidebarTitle: UnauthorizedResponseErrorData -description: UnauthorizedResponseErrorData type definition -seoTitle: UnauthorizedResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/unauthorizedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - UnauthorizedResponseErrorData type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseErrorData%20-%20TypeScript%20SDK&description=UnauthorizedResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for UnauthorizedResponse - -## Example Usage - -```typescript lines -import { UnauthorizedResponseErrorData } from "@openrouter/sdk/models"; - -let value: UnauthorizedResponseErrorData = { - code: 401, - message: "Missing Authentication header", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/uniqueinsight.mdx b/client-sdks/typescript/api-reference/models/uniqueinsight.mdx deleted file mode 100644 index 2e6eb9a9..00000000 --- a/client-sdks/typescript/api-reference/models/uniqueinsight.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: UniqueInsight - TypeScript SDK -sidebarTitle: UniqueInsight -description: UniqueInsight type definition -seoTitle: UniqueInsight Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/uniqueinsight' -'og:site_name': OpenRouter Documentation -'og:title': UniqueInsight Type | OpenRouter TypeScript SDK -'og:description': >- - UniqueInsight type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UniqueInsight%20-%20TypeScript%20SDK&description=UniqueInsight%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UniqueInsight } from "@openrouter/sdk/models"; - -let value: UniqueInsight = { - insight: "", - model: "Model 3", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `insight` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/unprocessableentityresponseerrordata.mdx b/client-sdks/typescript/api-reference/models/unprocessableentityresponseerrordata.mdx deleted file mode 100644 index 22283649..00000000 --- a/client-sdks/typescript/api-reference/models/unprocessableentityresponseerrordata.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UnprocessableEntityResponseErrorData - TypeScript SDK -sidebarTitle: UnprocessableEntityResponseErrorData -description: UnprocessableEntityResponseErrorData type definition -seoTitle: UnprocessableEntityResponseErrorData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/unprocessableentityresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseErrorData Type | OpenRouter TypeScript SDK -'og:description': >- - UnprocessableEntityResponseErrorData type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseErrorData%20-%20TypeScript%20SDK&description=UnprocessableEntityResponseErrorData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for UnprocessableEntityResponse - -## Example Usage - -```typescript lines -import { UnprocessableEntityResponseErrorData } from "@openrouter/sdk/models"; - -let value: UnprocessableEntityResponseErrorData = { - code: 422, - message: "Invalid argument", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/updatebyokkeyrequest.mdx b/client-sdks/typescript/api-reference/models/updatebyokkeyrequest.mdx deleted file mode 100644 index 29795f01..00000000 --- a/client-sdks/typescript/api-reference/models/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - TypeScript SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest type definition -seoTitle: UpdateBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updatebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20TypeScript%20SDK&description=UpdateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateBYOKKeyRequest } from "@openrouter/sdk/models"; - -let value: UpdateBYOKKeyRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | `` | -| `allowedUserIds` | *string*[] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | `` | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `isFallback` | *boolean* | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | false | -| `key` | *string* | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/updatebyokkeyresponse.mdx b/client-sdks/typescript/api-reference/models/updatebyokkeyresponse.mdx deleted file mode 100644 index bb1325ca..00000000 --- a/client-sdks/typescript/api-reference/models/updatebyokkeyresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: UpdateBYOKKeyResponse - TypeScript SDK -sidebarTitle: UpdateBYOKKeyResponse -description: UpdateBYOKKeyResponse type definition -seoTitle: UpdateBYOKKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updatebyokkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateBYOKKeyResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyResponse%20-%20TypeScript%20SDK&description=UpdateBYOKKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateBYOKKeyResponse } from "@openrouter/sdk/models"; - -let value: UpdateBYOKKeyResponse = { - data: { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.BYOKKey](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/updateguardrailrequest.mdx b/client-sdks/typescript/api-reference/models/updateguardrailrequest.mdx deleted file mode 100644 index c65c9196..00000000 --- a/client-sdks/typescript/api-reference/models/updateguardrailrequest.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: UpdateGuardrailRequest - TypeScript SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest type definition -seoTitle: UpdateGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20TypeScript%20SDK&description=UpdateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailRequest } from "@openrouter/sdk/models"; - -let value: UpdateGuardrailRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](/client-sdks/typescript/api-reference/models/contentfilterbuiltinentryinput)[] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. The "flag" action is only supported for "regex-prompt-injection"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept "block" or "redact" only. | [
`{"action": "block","slug": "regex-prompt-injection"}`
] | -| `contentFilters` | [models.ContentFilterEntry](/client-sdks/typescript/api-reference/models/contentfilterentry)[] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | `` | -| `description` | *string* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided. | true | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `limitUsd` | *number* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *string* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `resetInterval` | [models.GuardrailInterval](/client-sdks/typescript/api-reference/models/guardrailinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/updateguardrailresponse.mdx b/client-sdks/typescript/api-reference/models/updateguardrailresponse.mdx deleted file mode 100644 index 56a6a3a8..00000000 --- a/client-sdks/typescript/api-reference/models/updateguardrailresponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateGuardrailResponse - TypeScript SDK -sidebarTitle: UpdateGuardrailResponse -description: UpdateGuardrailResponse type definition -seoTitle: UpdateGuardrailResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResponse Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResponse%20-%20TypeScript%20SDK&description=UpdateGuardrailResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailResponse } from "@openrouter/sdk/models"; - -let value: UpdateGuardrailResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Updated Guardrail Name", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](/client-sdks/typescript/api-reference/models/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",
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/typescript/api-reference/models/updateobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/models/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index 8ead167a..00000000 --- a/client-sdks/typescript/api-reference/models/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest type definition -seoTitle: UpdateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=UpdateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateObservabilityDestinationRequest } from "@openrouter/sdk/models"; - -let value: UpdateObservabilityDestinationRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | `` | -| `config` | `Record` | :heavy_minus_sign: | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | `{"baseUrl": "https://us.cloud.langfuse.com","publicKey": "pk-l...EfGh","secretKey": "sk-l...AbCd"}` | -| `enabled` | *boolean* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](/client-sdks/typescript/api-reference/models/observabilityfilterrulesconfig) | :heavy_minus_sign: | N/A | `` | -| `name` | *string* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/updateobservabilitydestinationresponse.mdx b/client-sdks/typescript/api-reference/models/updateobservabilitydestinationresponse.mdx deleted file mode 100644 index a0835b52..00000000 --- a/client-sdks/typescript/api-reference/models/updateobservabilitydestinationresponse.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: UpdateObservabilityDestinationResponse - TypeScript SDK -sidebarTitle: UpdateObservabilityDestinationResponse -description: UpdateObservabilityDestinationResponse type definition -seoTitle: UpdateObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateobservabilitydestinationresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateObservabilityDestinationResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationResponse%20-%20TypeScript%20SDK&description=UpdateObservabilityDestinationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { UpdateObservabilityDestinationResponse } from "@openrouter/sdk/models"; - -let value: UpdateObservabilityDestinationResponse = { - data: { - apiKeyHashes: null, - config: { - baseUrl: "https://us.cloud.langfuse.com", - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.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/client-sdks/typescript/api-reference/models/updateworkspacerequest.mdx b/client-sdks/typescript/api-reference/models/updateworkspacerequest.mdx deleted file mode 100644 index f663c7ec..00000000 --- a/client-sdks/typescript/api-reference/models/updateworkspacerequest.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: UpdateWorkspaceRequest - TypeScript SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest type definition -seoTitle: UpdateWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateWorkspaceRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20TypeScript%20SDK&description=UpdateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateWorkspaceRequest } from "@openrouter/sdk/models"; - -let value: UpdateWorkspaceRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `defaultImageModel` | *string* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | `` | -| `ioLoggingSamplingRate` | *number* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *string* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *string* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/updateworkspaceresponse.mdx b/client-sdks/typescript/api-reference/models/updateworkspaceresponse.mdx deleted file mode 100644 index 7b144507..00000000 --- a/client-sdks/typescript/api-reference/models/updateworkspaceresponse.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: UpdateWorkspaceResponse - TypeScript SDK -sidebarTitle: UpdateWorkspaceResponse -description: UpdateWorkspaceResponse type definition -seoTitle: UpdateWorkspaceResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/updateworkspaceresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceResponse Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateWorkspaceResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceResponse%20-%20TypeScript%20SDK&description=UpdateWorkspaceResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { UpdateWorkspaceResponse } from "@openrouter/sdk/models"; - -let value: UpdateWorkspaceResponse = { - data: { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Updated Workspace", - slug: "updated-workspace", - updatedAt: "2025-08-25T10:00:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](/client-sdks/typescript/api-reference/models/workspace) | :heavy_check_mark: | N/A | `{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/typescript/api-reference/models/urlcitation.mdx b/client-sdks/typescript/api-reference/models/urlcitation.mdx deleted file mode 100644 index a5b8321d..00000000 --- a/client-sdks/typescript/api-reference/models/urlcitation.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: URLCitation - TypeScript SDK -sidebarTitle: URLCitation -description: URLCitation type definition -seoTitle: URLCitation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/urlcitation' -'og:site_name': OpenRouter Documentation -'og:title': URLCitation Type | OpenRouter TypeScript SDK -'og:description': >- - URLCitation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitation%20-%20TypeScript%20SDK&description=URLCitation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { URLCitation } from "@openrouter/sdk/models"; - -let value: URLCitation = { - endIndex: 827156, - startIndex: 720244, - title: "", - type: "url_citation", - url: "https://snappy-decision.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"url_citation"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/usage.mdx b/client-sdks/typescript/api-reference/models/usage.mdx deleted file mode 100644 index 3dfa4647..00000000 --- a/client-sdks/typescript/api-reference/models/usage.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Usage - TypeScript SDK -sidebarTitle: Usage -description: Usage type definition -seoTitle: Usage Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/usage' -'og:site_name': OpenRouter Documentation -'og:title': Usage Type | OpenRouter TypeScript SDK -'og:description': >- - Usage type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Usage%20-%20TypeScript%20SDK&description=Usage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Token usage information for the response - -## Example Usage - -```typescript lines -import { Usage } from "@openrouter/sdk/models"; - -let value: Usage = { - inputTokens: 10, - inputTokensDetails: { - cachedTokens: 0, - }, - outputTokens: 25, - outputTokensDetails: { - reasoningTokens: 0, - }, - totalTokens: 35, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `inputTokens` | *number* | :heavy_check_mark: | N/A | -| `inputTokensDetails` | [models.InputTokensDetails](/client-sdks/typescript/api-reference/models/inputtokensdetails) | :heavy_check_mark: | N/A | -| `outputTokens` | *number* | :heavy_check_mark: | N/A | -| `outputTokensDetails` | [models.OutputTokensDetails](/client-sdks/typescript/api-reference/models/outputtokensdetails) | :heavy_check_mark: | N/A | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | -| `costDetails` | [models.UsageCostDetails](/client-sdks/typescript/api-reference/models/usagecostdetails) | :heavy_minus_sign: | N/A | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/usagecostdetails.mdx b/client-sdks/typescript/api-reference/models/usagecostdetails.mdx deleted file mode 100644 index 7461c211..00000000 --- a/client-sdks/typescript/api-reference/models/usagecostdetails.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UsageCostDetails - TypeScript SDK -sidebarTitle: UsageCostDetails -description: UsageCostDetails type definition -seoTitle: UsageCostDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/usagecostdetails -'og:site_name': OpenRouter Documentation -'og:title': UsageCostDetails Type | OpenRouter TypeScript SDK -'og:description': >- - UsageCostDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageCostDetails%20-%20TypeScript%20SDK&description=UsageCostDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UsageCostDetails } from "@openrouter/sdk/models"; - -let value: UsageCostDetails = { - upstreamInferenceInputCost: 1419.94, - upstreamInferenceOutputCost: 9808.47, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `upstreamInferenceCost` | *number* | :heavy_minus_sign: | N/A | -| `upstreamInferenceInputCost` | *number* | :heavy_check_mark: | N/A | -| `upstreamInferenceOutputCost` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/userlocation.mdx b/client-sdks/typescript/api-reference/models/userlocation.mdx deleted file mode 100644 index 0a4fd3b0..00000000 --- a/client-sdks/typescript/api-reference/models/userlocation.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UserLocation - TypeScript SDK -sidebarTitle: UserLocation -description: UserLocation type definition -seoTitle: UserLocation Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/userlocation' -'og:site_name': OpenRouter Documentation -'og:title': UserLocation Type | OpenRouter TypeScript SDK -'og:description': >- - UserLocation type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserLocation%20-%20TypeScript%20SDK&description=UserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased search results. Passed through to native providers that support it (e.g. Anthropic). - -## Example Usage - -```typescript lines -import { UserLocation } from "@openrouter/sdk/models"; - -let value: UserLocation = { - type: "approximate", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchPluginType](/client-sdks/typescript/api-reference/models/websearchplugintype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/variables.mdx b/client-sdks/typescript/api-reference/models/variables.mdx deleted file mode 100644 index 39b61bf6..00000000 --- a/client-sdks/typescript/api-reference/models/variables.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Variables - TypeScript SDK -sidebarTitle: Variables -description: Variables type definition -seoTitle: Variables Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/variables' -'og:site_name': OpenRouter Documentation -'og:title': Variables Type | OpenRouter TypeScript SDK -'og:description': >- - Variables type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Variables%20-%20TypeScript%20SDK&description=Variables%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.InputText` - -```typescript lines -const value: models.InputText = { - text: "Hello, how can I help you?", - type: "input_text", -}; -``` - -### `models.InputImage` - -```typescript lines -const value: models.InputImage = { - detail: "auto", - type: "input_image", -}; -``` - -### `models.InputFile` - -```typescript lines -const value: models.InputFile = { - type: "input_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/verbosity.mdx b/client-sdks/typescript/api-reference/models/verbosity.mdx deleted file mode 100644 index d9f5375e..00000000 --- a/client-sdks/typescript/api-reference/models/verbosity.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Verbosity - TypeScript SDK -sidebarTitle: Verbosity -description: Verbosity type definition -seoTitle: Verbosity Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/verbosity' -'og:site_name': OpenRouter Documentation -'og:title': Verbosity Type | OpenRouter TypeScript SDK -'og:description': >- - Verbosity type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Verbosity%20-%20TypeScript%20SDK&description=Verbosity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Verbosity } from "@openrouter/sdk/models"; - -let value: Verbosity = "low"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"low" | "medium" | "high" | "xhigh" | "max" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/version.mdx b/client-sdks/typescript/api-reference/models/version.mdx deleted file mode 100644 index d0626ef7..00000000 --- a/client-sdks/typescript/api-reference/models/version.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Version - TypeScript SDK -sidebarTitle: Version -description: Version type definition -seoTitle: Version Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/version' -'og:site_name': OpenRouter Documentation -'og:title': Version Type | OpenRouter TypeScript SDK -'og:description': >- - Version type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Version%20-%20TypeScript%20SDK&description=Version%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Dataset version. Field names and grain are stable for the life of `v1`. - -## Example Usage - -```typescript lines -import { Version } from "@openrouter/sdk/models"; - -let value: Version = "v1"; -``` - -## Values - -```typescript lines -"v1" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/videogenerationrequest.mdx b/client-sdks/typescript/api-reference/models/videogenerationrequest.mdx deleted file mode 100644 index c5bfabca..00000000 --- a/client-sdks/typescript/api-reference/models/videogenerationrequest.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: VideoGenerationRequest - TypeScript SDK -sidebarTitle: VideoGenerationRequest -description: VideoGenerationRequest type definition -seoTitle: VideoGenerationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/videogenerationrequest -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - VideoGenerationRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequest%20-%20TypeScript%20SDK&description=VideoGenerationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { VideoGenerationRequest } from "@openrouter/sdk/models"; - -let value: VideoGenerationRequest = { - model: "google/veo-3.1", - prompt: "A serene mountain landscape at sunset", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspectRatio` | [models.AspectRatio](/client-sdks/typescript/api-reference/models/aspectratio) | :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` | *number* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frameImages` | [models.FrameImage](/client-sdks/typescript/api-reference/models/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` | *boolean* | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `inputReferences` | [models.ContentPartImage](/client-sdks/typescript/api-reference/models/contentpartimage)[] | :heavy_minus_sign: | Reference images to guide video generation | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `prompt` | *string* | :heavy_check_mark: | N/A | | -| `provider` | [models.VideoGenerationRequestProvider](/client-sdks/typescript/api-reference/models/videogenerationrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [models.Resolution](/client-sdks/typescript/api-reference/models/resolution) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *number* | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `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/client-sdks/typescript/api-reference/models/videogenerationrequestprovider.mdx b/client-sdks/typescript/api-reference/models/videogenerationrequestprovider.mdx deleted file mode 100644 index b8d89c97..00000000 --- a/client-sdks/typescript/api-reference/models/videogenerationrequestprovider.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: VideoGenerationRequestProvider - TypeScript SDK -sidebarTitle: VideoGenerationRequestProvider -description: VideoGenerationRequestProvider type definition -seoTitle: VideoGenerationRequestProvider Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/videogenerationrequestprovider -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationRequestProvider Type | OpenRouter TypeScript SDK -'og:description': >- - VideoGenerationRequestProvider type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationRequestProvider%20-%20TypeScript%20SDK&description=VideoGenerationRequestProvider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider-specific passthrough configuration - -## Example Usage - -```typescript lines -import { VideoGenerationRequestProvider } from "@openrouter/sdk/models"; - -let value: VideoGenerationRequestProvider = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `options` | [models.Options](/client-sdks/typescript/api-reference/models/options) | :heavy_minus_sign: | N/A | `{"google-vertex": {"output_config": {"effort": "low"}`
\}
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/videogenerationresponse.mdx b/client-sdks/typescript/api-reference/models/videogenerationresponse.mdx deleted file mode 100644 index c56f4dda..00000000 --- a/client-sdks/typescript/api-reference/models/videogenerationresponse.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: VideoGenerationResponse - TypeScript SDK -sidebarTitle: VideoGenerationResponse -description: VideoGenerationResponse type definition -seoTitle: VideoGenerationResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/videogenerationresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponse Type | OpenRouter TypeScript SDK -'og:description': >- - VideoGenerationResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponse%20-%20TypeScript%20SDK&description=VideoGenerationResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { VideoGenerationResponse } from "@openrouter/sdk/models"; - -let value: VideoGenerationResponse = { - id: "job-abc123", - pollingUrl: "/api/v1/videos/job-abc123", - status: "pending", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `error` | *string* | :heavy_minus_sign: | N/A | | -| `generationId` | *string* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `pollingUrl` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.VideoGenerationResponseStatus](/client-sdks/typescript/api-reference/models/videogenerationresponsestatus) | :heavy_check_mark: | N/A | | -| `unsignedUrls` | *string*[] | :heavy_minus_sign: | N/A | | -| `usage` | [models.VideoGenerationUsage](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/videogenerationresponsestatus.mdx b/client-sdks/typescript/api-reference/models/videogenerationresponsestatus.mdx deleted file mode 100644 index 1a2425a0..00000000 --- a/client-sdks/typescript/api-reference/models/videogenerationresponsestatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: VideoGenerationResponseStatus - TypeScript SDK -sidebarTitle: VideoGenerationResponseStatus -description: VideoGenerationResponseStatus type definition -seoTitle: VideoGenerationResponseStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/videogenerationresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationResponseStatus Type | OpenRouter TypeScript SDK -'og:description': >- - VideoGenerationResponseStatus type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationResponseStatus%20-%20TypeScript%20SDK&description=VideoGenerationResponseStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { VideoGenerationResponseStatus } from "@openrouter/sdk/models"; - -let value: VideoGenerationResponseStatus = "cancelled"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"pending" | "in_progress" | "completed" | "failed" | "cancelled" | "expired" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/videogenerationusage.mdx b/client-sdks/typescript/api-reference/models/videogenerationusage.mdx deleted file mode 100644 index 2056f9df..00000000 --- a/client-sdks/typescript/api-reference/models/videogenerationusage.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: VideoGenerationUsage - TypeScript SDK -sidebarTitle: VideoGenerationUsage -description: VideoGenerationUsage type definition -seoTitle: VideoGenerationUsage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/videogenerationusage -'og:site_name': OpenRouter Documentation -'og:title': VideoGenerationUsage Type | OpenRouter TypeScript SDK -'og:description': >- - VideoGenerationUsage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGenerationUsage%20-%20TypeScript%20SDK&description=VideoGenerationUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Usage and cost information for the video generation. Available once the job has completed. - -## Example Usage - -```typescript lines -import { VideoGenerationUsage } from "@openrouter/sdk/models"; - -let value: VideoGenerationUsage = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | The cost of the video generation in USD. | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/videomodel.mdx b/client-sdks/typescript/api-reference/models/videomodel.mdx deleted file mode 100644 index 450e4900..00000000 --- a/client-sdks/typescript/api-reference/models/videomodel.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: VideoModel - TypeScript SDK -sidebarTitle: VideoModel -description: VideoModel type definition -seoTitle: VideoModel Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/videomodel' -'og:site_name': OpenRouter Documentation -'og:title': VideoModel Type | OpenRouter TypeScript SDK -'og:description': >- - VideoModel type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModel%20-%20TypeScript%20SDK&description=VideoModel%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { VideoModel } from "@openrouter/sdk/models"; - -let value: VideoModel = { - allowedPassthroughParameters: [], - canonicalSlug: "google/veo-3.1", - created: 1700000000, - generateAudio: true, - id: "google/veo-3.1", - name: "Veo 3.1", - seed: null, - supportedAspectRatios: [ - "16:9", - ], - supportedDurations: [ - 5, - 8, - ], - supportedFrameImages: [ - "first_frame", - "last_frame", - ], - supportedResolutions: [ - "720p", - ], - supportedSizes: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowedPassthroughParameters` | *string*[] | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *string* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `generateAudio` | *boolean* | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `pricingSkus` | `Record` | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | -| `seed` | *boolean* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `supportedAspectRatios` | [models.SupportedAspectRatio](/client-sdks/typescript/api-reference/models/supportedaspectratio)[] | :heavy_check_mark: | Supported output aspect ratios | | -| `supportedDurations` | *number*[] | :heavy_check_mark: | Supported video durations in seconds | | -| `supportedFrameImages` | [models.SupportedFrameImage](/client-sdks/typescript/api-reference/models/supportedframeimage)[] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `supportedResolutions` | [models.SupportedResolution](/client-sdks/typescript/api-reference/models/supportedresolution)[] | :heavy_check_mark: | Supported output resolutions | | -| `supportedSizes` | [models.SupportedSize](/client-sdks/typescript/api-reference/models/supportedsize)[] | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/videomodelslistresponse.mdx b/client-sdks/typescript/api-reference/models/videomodelslistresponse.mdx deleted file mode 100644 index 8ca9478f..00000000 --- a/client-sdks/typescript/api-reference/models/videomodelslistresponse.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: VideoModelsListResponse - TypeScript SDK -sidebarTitle: VideoModelsListResponse -description: VideoModelsListResponse type definition -seoTitle: VideoModelsListResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/videomodelslistresponse -'og:site_name': OpenRouter Documentation -'og:title': VideoModelsListResponse Type | OpenRouter TypeScript SDK -'og:description': >- - VideoModelsListResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoModelsListResponse%20-%20TypeScript%20SDK&description=VideoModelsListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { VideoModelsListResponse } from "@openrouter/sdk/models"; - -let value: VideoModelsListResponse = { - data: [ - { - allowedPassthroughParameters: [], - canonicalSlug: "google/veo-3.1", - created: 1700000000, - generateAudio: true, - id: "google/veo-3.1", - name: "Veo 3.1", - seed: null, - supportedAspectRatios: [ - "16:9", - ], - supportedDurations: [ - 5, - 8, - ], - supportedFrameImages: [ - "first_frame", - "last_frame", - ], - supportedResolutions: [ - "720p", - ], - supportedSizes: null, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `data` | [models.VideoModel](/client-sdks/typescript/api-reference/models/videomodel)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/webfetchengineenum.mdx b/client-sdks/typescript/api-reference/models/webfetchengineenum.mdx deleted file mode 100644 index 18135d1f..00000000 --- a/client-sdks/typescript/api-reference/models/webfetchengineenum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WebFetchEngineEnum - TypeScript SDK -sidebarTitle: WebFetchEngineEnum -description: WebFetchEngineEnum type definition -seoTitle: WebFetchEngineEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/webfetchengineenum -'og:site_name': OpenRouter Documentation -'og:title': WebFetchEngineEnum Type | OpenRouter TypeScript SDK -'og:description': >- - WebFetchEngineEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchEngineEnum%20-%20TypeScript%20SDK&description=WebFetchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { WebFetchEngineEnum } from "@openrouter/sdk/models"; - -let value: WebFetchEngineEnum = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "native" | "openrouter" | "exa" | "parallel" | "firecrawl" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/webfetchplugin.mdx b/client-sdks/typescript/api-reference/models/webfetchplugin.mdx deleted file mode 100644 index 55cb167d..00000000 --- a/client-sdks/typescript/api-reference/models/webfetchplugin.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: WebFetchPlugin - TypeScript SDK -sidebarTitle: WebFetchPlugin -description: WebFetchPlugin type definition -seoTitle: WebFetchPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/webfetchplugin' -'og:site_name': OpenRouter Documentation -'og:title': WebFetchPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - WebFetchPlugin type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchPlugin%20-%20TypeScript%20SDK&description=WebFetchPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebFetchPlugin } from "@openrouter/sdk/models"; - -let value: WebFetchPlugin = { - id: "web-fetch", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Only fetch from these domains. | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | Never fetch from these domains. | -| `id` | *"web-fetch"* | :heavy_check_mark: | N/A | -| `maxContentTokens` | *number* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/webfetchservertool.mdx b/client-sdks/typescript/api-reference/models/webfetchservertool.mdx deleted file mode 100644 index 97b06c01..00000000 --- a/client-sdks/typescript/api-reference/models/webfetchservertool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: WebFetchServerTool - TypeScript SDK -sidebarTitle: WebFetchServerTool -description: WebFetchServerTool type definition -seoTitle: WebFetchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/webfetchservertool -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - WebFetchServerTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerTool%20-%20TypeScript%20SDK&description=WebFetchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: fetches full content from a URL (web page or PDF) - -## Example Usage - -```typescript lines -import { WebFetchServerTool } from "@openrouter/sdk/models"; - -let value: WebFetchServerTool = { - type: "openrouter:web_fetch", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.WebFetchServerToolConfig](/client-sdks/typescript/api-reference/models/webfetchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | `{"max_content_tokens": 100000,"max_uses": 10}` | -| `type` | [models.WebFetchServerToolType](/client-sdks/typescript/api-reference/models/webfetchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/webfetchservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/webfetchservertoolconfig.mdx deleted file mode 100644 index 3621af60..00000000 --- a/client-sdks/typescript/api-reference/models/webfetchservertoolconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: WebFetchServerToolConfig - TypeScript SDK -sidebarTitle: WebFetchServerToolConfig -description: WebFetchServerToolConfig type definition -seoTitle: WebFetchServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/webfetchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - WebFetchServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolConfig%20-%20TypeScript%20SDK&description=WebFetchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_fetch server tool - -## Example Usage - -```typescript lines -import { WebFetchServerToolConfig } from "@openrouter/sdk/models"; - -let value: WebFetchServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Only fetch from these domains. | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | Never fetch from these domains. | | -| `engine` | [models.WebFetchEngineEnum](/client-sdks/typescript/api-reference/models/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` | *number* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/webfetchservertooltype.mdx b/client-sdks/typescript/api-reference/models/webfetchservertooltype.mdx deleted file mode 100644 index 8c4f6d59..00000000 --- a/client-sdks/typescript/api-reference/models/webfetchservertooltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebFetchServerToolType - TypeScript SDK -sidebarTitle: WebFetchServerToolType -description: WebFetchServerToolType type definition -seoTitle: WebFetchServerToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/webfetchservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebFetchServerToolType Type | OpenRouter TypeScript SDK -'og:description': >- - WebFetchServerToolType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebFetchServerToolType%20-%20TypeScript%20SDK&description=WebFetchServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebFetchServerToolType } from "@openrouter/sdk/models"; - -let value: WebFetchServerToolType = "openrouter:web_fetch"; -``` - -## Values - -```typescript lines -"openrouter:web_fetch" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchcallcompletedevent.mdx b/client-sdks/typescript/api-reference/models/websearchcallcompletedevent.mdx deleted file mode 100644 index b6317b67..00000000 --- a/client-sdks/typescript/api-reference/models/websearchcallcompletedevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WebSearchCallCompletedEvent - TypeScript SDK -sidebarTitle: WebSearchCallCompletedEvent -description: WebSearchCallCompletedEvent type definition -seoTitle: WebSearchCallCompletedEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchcallcompletedevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallCompletedEvent Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchCallCompletedEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallCompletedEvent%20-%20TypeScript%20SDK&description=WebSearchCallCompletedEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search call completed - -## Example Usage - -```typescript lines -import { WebSearchCallCompletedEvent } from "@openrouter/sdk/models"; - -let value: WebSearchCallCompletedEvent = { - itemId: "", - outputIndex: 871568, - sequenceNumber: 0, - type: "response.web_search_call.completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchcallinprogressevent.mdx b/client-sdks/typescript/api-reference/models/websearchcallinprogressevent.mdx deleted file mode 100644 index 8d3b83fb..00000000 --- a/client-sdks/typescript/api-reference/models/websearchcallinprogressevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WebSearchCallInProgressEvent - TypeScript SDK -sidebarTitle: WebSearchCallInProgressEvent -description: WebSearchCallInProgressEvent type definition -seoTitle: WebSearchCallInProgressEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchcallinprogressevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallInProgressEvent Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchCallInProgressEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallInProgressEvent%20-%20TypeScript%20SDK&description=WebSearchCallInProgressEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search call in progress - -## Example Usage - -```typescript lines -import { WebSearchCallInProgressEvent } from "@openrouter/sdk/models"; - -let value: WebSearchCallInProgressEvent = { - itemId: "", - outputIndex: 549158, - sequenceNumber: 0, - type: "response.web_search_call.in_progress", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchcallsearchingevent.mdx b/client-sdks/typescript/api-reference/models/websearchcallsearchingevent.mdx deleted file mode 100644 index 55c9606b..00000000 --- a/client-sdks/typescript/api-reference/models/websearchcallsearchingevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WebSearchCallSearchingEvent - TypeScript SDK -sidebarTitle: WebSearchCallSearchingEvent -description: WebSearchCallSearchingEvent type definition -seoTitle: WebSearchCallSearchingEvent Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchcallsearchingevent -'og:site_name': OpenRouter Documentation -'og:title': WebSearchCallSearchingEvent Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchCallSearchingEvent type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchCallSearchingEvent%20-%20TypeScript%20SDK&description=WebSearchCallSearchingEvent%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search call is searching - -## Example Usage - -```typescript lines -import { WebSearchCallSearchingEvent } from "@openrouter/sdk/models"; - -let value: WebSearchCallSearchingEvent = { - itemId: "", - outputIndex: 112521, - sequenceNumber: 0, - type: "response.web_search_call.searching", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.searching"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchconfig.mdx b/client-sdks/typescript/api-reference/models/websearchconfig.mdx deleted file mode 100644 index 3de580f8..00000000 --- a/client-sdks/typescript/api-reference/models/websearchconfig.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: WebSearchConfig - TypeScript SDK -sidebarTitle: WebSearchConfig -description: WebSearchConfig type definition -seoTitle: WebSearchConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchconfig -'og:site_name': OpenRouter Documentation -'og:title': WebSearchConfig Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchConfig type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchConfig%20-%20TypeScript%20SDK&description=WebSearchConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchConfig } from "@openrouter/sdk/models"; - -let value: WebSearchConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `searchContextSize` | [models.SearchQualityLevel](/client-sdks/typescript/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/websearchdomainfilter.mdx b/client-sdks/typescript/api-reference/models/websearchdomainfilter.mdx deleted file mode 100644 index 3f80984b..00000000 --- a/client-sdks/typescript/api-reference/models/websearchdomainfilter.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WebSearchDomainFilter - TypeScript SDK -sidebarTitle: WebSearchDomainFilter -description: WebSearchDomainFilter type definition -seoTitle: WebSearchDomainFilter Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchdomainfilter -'og:site_name': OpenRouter Documentation -'og:title': WebSearchDomainFilter Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchDomainFilter type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchDomainFilter%20-%20TypeScript%20SDK&description=WebSearchDomainFilter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchDomainFilter } from "@openrouter/sdk/models"; - -let value: WebSearchDomainFilter = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchengine.mdx b/client-sdks/typescript/api-reference/models/websearchengine.mdx deleted file mode 100644 index 1d2a5949..00000000 --- a/client-sdks/typescript/api-reference/models/websearchengine.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WebSearchEngine - TypeScript SDK -sidebarTitle: WebSearchEngine -description: WebSearchEngine type definition -seoTitle: WebSearchEngine Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchengine -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngine Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchEngine type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngine%20-%20TypeScript%20SDK&description=WebSearchEngine%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The search engine to use for web search. - -## Example Usage - -```typescript lines -import { WebSearchEngine } from "@openrouter/sdk/models"; - -let value: WebSearchEngine = "exa"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"native" | "exa" | "firecrawl" | "parallel" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchengineenum.mdx b/client-sdks/typescript/api-reference/models/websearchengineenum.mdx deleted file mode 100644 index d4503d02..00000000 --- a/client-sdks/typescript/api-reference/models/websearchengineenum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WebSearchEngineEnum - TypeScript SDK -sidebarTitle: WebSearchEngineEnum -description: WebSearchEngineEnum type definition -seoTitle: WebSearchEngineEnum Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchengineenum -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngineEnum Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchEngineEnum type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngineEnum%20-%20TypeScript%20SDK&description=WebSearchEngineEnum%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { WebSearchEngineEnum } from "@openrouter/sdk/models"; - -let value: WebSearchEngineEnum = "auto"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"auto" | "native" | "exa" | "parallel" | "firecrawl" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchplugin.mdx b/client-sdks/typescript/api-reference/models/websearchplugin.mdx deleted file mode 100644 index 3968df34..00000000 --- a/client-sdks/typescript/api-reference/models/websearchplugin.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WebSearchPlugin - TypeScript SDK -sidebarTitle: WebSearchPlugin -description: WebSearchPlugin type definition -seoTitle: WebSearchPlugin Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchplugin -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPlugin Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchPlugin type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPlugin%20-%20TypeScript%20SDK&description=WebSearchPlugin%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchPlugin } from "@openrouter/sdk/models"; - -let value: WebSearchPlugin = { - id: "web", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [models.WebSearchEngine](/client-sdks/typescript/api-reference/models/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` | *"web"* | :heavy_check_mark: | N/A | | -| `includeDomains` | *string*[] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `maxResults` | *number* | :heavy_minus_sign: | N/A | | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | -| `searchPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `userLocation` | [models.UserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/websearchplugintype.mdx b/client-sdks/typescript/api-reference/models/websearchplugintype.mdx deleted file mode 100644 index 295110be..00000000 --- a/client-sdks/typescript/api-reference/models/websearchplugintype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchPluginType - TypeScript SDK -sidebarTitle: WebSearchPluginType -description: WebSearchPluginType type definition -seoTitle: WebSearchPluginType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchplugintype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPluginType Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchPluginType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPluginType%20-%20TypeScript%20SDK&description=WebSearchPluginType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchPluginType } from "@openrouter/sdk/models"; - -let value: WebSearchPluginType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchservertool.mdx b/client-sdks/typescript/api-reference/models/websearchservertool.mdx deleted file mode 100644 index 76f9672b..00000000 --- a/client-sdks/typescript/api-reference/models/websearchservertool.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: WebSearchServerTool - TypeScript SDK -sidebarTitle: WebSearchServerTool -description: WebSearchServerTool type definition -seoTitle: WebSearchServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchservertool -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchServerTool type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerTool%20-%20TypeScript%20SDK&description=WebSearchServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search tool configuration (2025-08-26 version) - -## Example Usage - -```typescript lines -import { WebSearchServerTool } from "@openrouter/sdk/models"; - -let value: WebSearchServerTool = { - type: "web_search_2025_08_26", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `filters` | [models.WebSearchDomainFilter](/client-sdks/typescript/api-reference/models/websearchdomainfilter) | :heavy_minus_sign: | N/A | `{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}` | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `searchContextSize` | [models.SearchContextSizeEnum](/client-sdks/typescript/api-reference/models/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | *"web_search_2025_08_26"* | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/websearchservertoolconfig.mdx b/client-sdks/typescript/api-reference/models/websearchservertoolconfig.mdx deleted file mode 100644 index f85ed0b7..00000000 --- a/client-sdks/typescript/api-reference/models/websearchservertoolconfig.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: WebSearchServerToolConfig - TypeScript SDK -sidebarTitle: WebSearchServerToolConfig -description: WebSearchServerToolConfig type definition -seoTitle: WebSearchServerToolConfig Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchservertoolconfig -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolConfig Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchServerToolConfig type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolConfig%20-%20TypeScript%20SDK&description=WebSearchServerToolConfig%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for the openrouter:web_search server tool - -## Example Usage - -```typescript lines -import { WebSearchServerToolConfig } from "@openrouter/sdk/models"; - -let value: WebSearchServerToolConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, and most native providers (Anthropic, OpenAI, xAI). Not supported with Perplexity. Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](/client-sdks/typescript/api-reference/models/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. | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Anthropic, and xAI. Not supported with OpenAI (silently ignored) or Perplexity. Cannot be used with allowed_domains. | | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `searchContextSize` | [models.SearchQualityLevel](/client-sdks/typescript/api-reference/models/searchqualitylevel) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa and Parallel 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. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/websearchservertoolopenrouter.mdx b/client-sdks/typescript/api-reference/models/websearchservertoolopenrouter.mdx deleted file mode 100644 index 55bcf36b..00000000 --- a/client-sdks/typescript/api-reference/models/websearchservertoolopenrouter.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: WebSearchServerToolOpenRouter - TypeScript SDK -sidebarTitle: WebSearchServerToolOpenRouter -description: WebSearchServerToolOpenRouter type definition -seoTitle: WebSearchServerToolOpenRouter Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchservertoolopenrouter -'og:site_name': OpenRouter Documentation -'og:title': WebSearchServerToolOpenRouter Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchServerToolOpenRouter type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchServerToolOpenRouter%20-%20TypeScript%20SDK&description=WebSearchServerToolOpenRouter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -OpenRouter built-in server tool: searches the web for current information - -## Example Usage - -```typescript lines -import { WebSearchServerToolOpenRouter } from "@openrouter/sdk/models"; - -let value: WebSearchServerToolOpenRouter = { - type: "openrouter:web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `parameters` | [models.WebSearchServerToolConfig](/client-sdks/typescript/api-reference/models/websearchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | `{"max_results": 5,"search_context_size": "medium"}` | -| `type` | *"openrouter:web_search"* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchsource.mdx b/client-sdks/typescript/api-reference/models/websearchsource.mdx deleted file mode 100644 index 9823c458..00000000 --- a/client-sdks/typescript/api-reference/models/websearchsource.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WebSearchSource - TypeScript SDK -sidebarTitle: WebSearchSource -description: WebSearchSource type definition -seoTitle: WebSearchSource Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchsource -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSource Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchSource type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSource%20-%20TypeScript%20SDK&description=WebSearchSource%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchSource } from "@openrouter/sdk/models"; - -let value: WebSearchSource = { - type: "url", - url: "https://example.com/article", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.WebSearchSourceType](/client-sdks/typescript/api-reference/models/websearchsourcetype) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchsourcetype.mdx b/client-sdks/typescript/api-reference/models/websearchsourcetype.mdx deleted file mode 100644 index 71518b6c..00000000 --- a/client-sdks/typescript/api-reference/models/websearchsourcetype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchSourceType - TypeScript SDK -sidebarTitle: WebSearchSourceType -description: WebSearchSourceType type definition -seoTitle: WebSearchSourceType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchsourcetype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchSourceType Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchSourceType type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchSourceType%20-%20TypeScript%20SDK&description=WebSearchSourceType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchSourceType } from "@openrouter/sdk/models"; - -let value: WebSearchSourceType = "url"; -``` - -## Values - -```typescript lines -"url" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchstatus.mdx b/client-sdks/typescript/api-reference/models/websearchstatus.mdx deleted file mode 100644 index 10f41509..00000000 --- a/client-sdks/typescript/api-reference/models/websearchstatus.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchStatus - TypeScript SDK -sidebarTitle: WebSearchStatus -description: WebSearchStatus type definition -seoTitle: WebSearchStatus Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchstatus -'og:site_name': OpenRouter Documentation -'og:title': WebSearchStatus Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchStatus type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchStatus%20-%20TypeScript%20SDK&description=WebSearchStatus%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchStatus } from "@openrouter/sdk/models"; - -let value: WebSearchStatus = "completed"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"completed" | "searching" | "in_progress" | "failed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchuserlocation.mdx b/client-sdks/typescript/api-reference/models/websearchuserlocation.mdx deleted file mode 100644 index 004e9846..00000000 --- a/client-sdks/typescript/api-reference/models/websearchuserlocation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: WebSearchUserLocation - TypeScript SDK -sidebarTitle: WebSearchUserLocation -description: WebSearchUserLocation type definition -seoTitle: WebSearchUserLocation Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocation Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchUserLocation type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocation%20-%20TypeScript%20SDK&description=WebSearchUserLocation%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -User location information for web search - -## Example Usage - -```typescript lines -import { WebSearchUserLocation } from "@openrouter/sdk/models"; - -let value: WebSearchUserLocation = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationType](/client-sdks/typescript/api-reference/models/websearchuserlocationtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchuserlocationservertool.mdx b/client-sdks/typescript/api-reference/models/websearchuserlocationservertool.mdx deleted file mode 100644 index 0f56a495..00000000 --- a/client-sdks/typescript/api-reference/models/websearchuserlocationservertool.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: WebSearchUserLocationServerTool - TypeScript SDK -sidebarTitle: WebSearchUserLocationServerTool -description: WebSearchUserLocationServerTool type definition -seoTitle: WebSearchUserLocationServerTool Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchuserlocationservertool -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerTool Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchUserLocationServerTool type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerTool%20-%20TypeScript%20SDK&description=WebSearchUserLocationServerTool%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Approximate user location for location-biased results. - -## Example Usage - -```typescript lines -import { WebSearchUserLocationServerTool } from "@openrouter/sdk/models"; - -let value: WebSearchUserLocationServerTool = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationServerToolType](/client-sdks/typescript/api-reference/models/websearchuserlocationservertooltype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchuserlocationservertooltype.mdx b/client-sdks/typescript/api-reference/models/websearchuserlocationservertooltype.mdx deleted file mode 100644 index d5e5de86..00000000 --- a/client-sdks/typescript/api-reference/models/websearchuserlocationservertooltype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchUserLocationServerToolType - TypeScript SDK -sidebarTitle: WebSearchUserLocationServerToolType -description: WebSearchUserLocationServerToolType type definition -seoTitle: WebSearchUserLocationServerToolType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchuserlocationservertooltype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationServerToolType Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchUserLocationServerToolType type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationServerToolType%20-%20TypeScript%20SDK&description=WebSearchUserLocationServerToolType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchUserLocationServerToolType } from "@openrouter/sdk/models"; - -let value: WebSearchUserLocationServerToolType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/websearchuserlocationtype.mdx b/client-sdks/typescript/api-reference/models/websearchuserlocationtype.mdx deleted file mode 100644 index cccd5d1f..00000000 --- a/client-sdks/typescript/api-reference/models/websearchuserlocationtype.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchUserLocationType - TypeScript SDK -sidebarTitle: WebSearchUserLocationType -description: WebSearchUserLocationType type definition -seoTitle: WebSearchUserLocationType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/websearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchUserLocationType Type | OpenRouter TypeScript SDK -'og:description': >- - WebSearchUserLocationType type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchUserLocationType%20-%20TypeScript%20SDK&description=WebSearchUserLocationType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchUserLocationType } from "@openrouter/sdk/models"; - -let value: WebSearchUserLocationType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/workspace.mdx b/client-sdks/typescript/api-reference/models/workspace.mdx deleted file mode 100644 index 60b9ff7a..00000000 --- a/client-sdks/typescript/api-reference/models/workspace.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: Workspace - TypeScript SDK -sidebarTitle: Workspace -description: Workspace type definition -seoTitle: Workspace Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/models/workspace' -'og:site_name': OpenRouter Documentation -'og:title': Workspace Type | OpenRouter TypeScript SDK -'og:description': >- - Workspace type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspace%20-%20TypeScript%20SDK&description=Workspace%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Workspace } from "@openrouter/sdk/models"; - -let value: Workspace = { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Production", - slug: "production", - updatedAt: "2025-08-24T15:45:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `createdBy` | *string* | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `defaultImageModel` | *string* | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | `` | -| `ioLoggingSamplingRate` | *number* | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `name` | *string* | :heavy_check_mark: | Name of the workspace | Production | -| `slug` | *string* | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/models/workspacemember.mdx b/client-sdks/typescript/api-reference/models/workspacemember.mdx deleted file mode 100644 index 27a6b212..00000000 --- a/client-sdks/typescript/api-reference/models/workspacemember.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: WorkspaceMember - TypeScript SDK -sidebarTitle: WorkspaceMember -description: WorkspaceMember type definition -seoTitle: WorkspaceMember Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/workspacemember -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMember Type | OpenRouter TypeScript SDK -'og:description': >- - WorkspaceMember type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMember%20-%20TypeScript%20SDK&description=WorkspaceMember%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WorkspaceMember } from "@openrouter/sdk/models"; - -let value: WorkspaceMember = { - createdAt: "2025-08-24T10:30:00Z", - id: "660e8400-e29b-41d4-a716-446655440000", - role: "member", - userId: "user_abc123", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [models.WorkspaceMemberRole](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/models/workspacememberrole.mdx b/client-sdks/typescript/api-reference/models/workspacememberrole.mdx deleted file mode 100644 index 29f2dfa8..00000000 --- a/client-sdks/typescript/api-reference/models/workspacememberrole.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WorkspaceMemberRole - TypeScript SDK -sidebarTitle: WorkspaceMemberRole -description: WorkspaceMemberRole type definition -seoTitle: WorkspaceMemberRole Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/models/workspacememberrole -'og:site_name': OpenRouter Documentation -'og:title': WorkspaceMemberRole Type | OpenRouter TypeScript SDK -'og:description': >- - WorkspaceMemberRole type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WorkspaceMemberRole%20-%20TypeScript%20SDK&description=WorkspaceMemberRole%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Role of the member in the workspace - -## Example Usage - -```typescript lines -import { WorkspaceMemberRole } from "@openrouter/sdk/models"; - -let value: WorkspaceMemberRole = "member"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"admin" | "member" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/oauth.mdx b/client-sdks/typescript/api-reference/oauth.mdx deleted file mode 100644 index 99ac6b5f..00000000 --- a/client-sdks/typescript/api-reference/oauth.mdx +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: OAuth - TypeScript SDK -sidebarTitle: OAuth -description: OAuth method reference -seoTitle: OAuth | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/oauth' -'og:site_name': OpenRouter Documentation -'og:title': OAuth | OpenRouter TypeScript SDK -'og:description': >- - OAuth method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OAuth%20-%20TypeScript%20SDK&description=OAuth%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: shield-check ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -OAuth authentication endpoints - -### Available Operations - -* [exchangeAuthCodeForAPIKey](#exchangeauthcodeforapikey) - Exchange authorization code for API key -* [createAuthCode](#createauthcode) - Create authorization code - -## exchangeAuthCodeForAPIKey - -Exchange an authorization code from the PKCE flow for a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="exchangeAuthCodeForAPIKey" method="post" path="/auth/keys" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.oAuth.exchangeAuthCodeForAPIKey({ - requestBody: { - code: "auth_code_abc123def456", - codeChallengeMethod: "S256", - codeVerifier: "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { oAuthExchangeAuthCodeForAPIKey } from "@openrouter/sdk/funcs/oAuthExchangeAuthCodeForAPIKey.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await oAuthExchangeAuthCodeForAPIKey(openRouter, { - requestBody: { - code: "auth_code_abc123def456", - codeChallengeMethod: "S256", - codeVerifier: "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("oAuthExchangeAuthCodeForAPIKey failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ExchangeAuthCodeForAPIKeyResponse](/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## createAuthCode - -Create an authorization code for the PKCE flow to generate a user-controlled API key - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createAuthKeysCode" method="post" path="/auth/keys/code" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.oAuth.createAuthCode({ - requestBody: { - callbackUrl: "https://myapp.com/auth/callback", - codeChallenge: "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", - codeChallengeMethod: "S256", - limit: 100, - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { oAuthCreateAuthCode } from "@openrouter/sdk/funcs/oAuthCreateAuthCode.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await oAuthCreateAuthCode(openRouter, { - requestBody: { - callbackUrl: "https://myapp.com/auth/callback", - codeChallenge: "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM", - codeChallengeMethod: "S256", - limit: 100, - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("oAuthCreateAuthCode failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAuthKeysCodeRequest](/client-sdks/typescript/api-reference/operations/createauthkeyscoderequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.CreateAuthKeysCodeResponse](/client-sdks/typescript/api-reference/operations/createauthkeyscoderesponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/observability.mdx b/client-sdks/typescript/api-reference/observability.mdx deleted file mode 100644 index 996b56f1..00000000 --- a/client-sdks/typescript/api-reference/observability.mdx +++ /dev/null @@ -1,477 +0,0 @@ ---- -title: Observability - TypeScript SDK -sidebarTitle: Observability -description: Observability method reference -seoTitle: Observability | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/observability' -'og:site_name': OpenRouter Documentation -'og:title': Observability | OpenRouter TypeScript SDK -'og:description': >- - Observability method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Observability%20-%20TypeScript%20SDK&description=Observability%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Observability endpoints - -### Available Operations - -* [list](#list) - List observability destinations -* [create](#create) - Create an observability destination -* [delete](#delete) - Delete an observability destination -* [get](#get) - Get an observability destination -* [update](#update) - Update an observability destination - -## list - -List the observability destinations configured for the authenticated entity's default workspace. Use the `workspace_id` query parameter to scope the result to a different workspace. Only destinations with stable release status are surfaced — destinations of other types are excluded. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listObservabilityDestinations" method="get" path="/observability/destinations" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.observability.list(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { observabilityList } from "@openrouter/sdk/funcs/observabilityList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await observabilityList(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("observabilityList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListObservabilityDestinationsRequest](/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListObservabilityDestinationsResponse](/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new observability destination. A maximum of 5 destinations per type is allowed. Defaults to the authenticated entity's default workspace; use the `workspace_id` body field to scope to a different workspace. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createObservabilityDestination" method="post" path="/observability/destinations" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.observability.create({ - createObservabilityDestinationRequest: { - config: { - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, - name: "Production Langfuse", - type: "langfuse", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { observabilityCreate } from "@openrouter/sdk/funcs/observabilityCreate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await observabilityCreate(openRouter, { - createObservabilityDestinationRequest: { - config: { - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, - name: "Production Langfuse", - type: "langfuse", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("observabilityCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateObservabilityDestinationRequest](/client-sdks/typescript/api-reference/operations/createobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreateObservabilityDestinationResponse](/client-sdks/typescript/api-reference/models/createobservabilitydestinationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing observability destination. This performs a soft delete. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="deleteObservabilityDestination" method="delete" path="/observability/destinations/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.observability.delete({ - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { observabilityDelete } from "@openrouter/sdk/funcs/observabilityDelete.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await observabilityDelete(openRouter, { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("observabilityDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteObservabilityDestinationRequest](/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.DeleteObservabilityDestinationResponse](/client-sdks/typescript/api-reference/models/deleteobservabilitydestinationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Fetch a single observability destination by its UUID. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getObservabilityDestination" method="get" path="/observability/destinations/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.observability.get({ - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { observabilityGet } from "@openrouter/sdk/funcs/observabilityGet.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await observabilityGet(openRouter, { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("observabilityGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetObservabilityDestinationRequest](/client-sdks/typescript/api-reference/operations/getobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GetObservabilityDestinationResponse](/client-sdks/typescript/api-reference/models/getobservabilitydestinationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing observability destination. Only the fields provided in the request body are updated. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="updateObservabilityDestination" method="patch" path="/observability/destinations/{id}" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.observability.update({ - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - updateObservabilityDestinationRequest: { - enabled: false, - name: "Updated Langfuse", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { observabilityUpdate } from "@openrouter/sdk/funcs/observabilityUpdate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await observabilityUpdate(openRouter, { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - updateObservabilityDestinationRequest: { - enabled: false, - name: "Updated Langfuse", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("observabilityUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateObservabilityDestinationRequest](/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.UpdateObservabilityDestinationResponse](/client-sdks/typescript/api-reference/models/updateobservabilitydestinationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersglobals.mdx deleted file mode 100644 index 1eba215b..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkAddWorkspaceMembersGlobals - TypeScript SDK -sidebarTitle: BulkAddWorkspaceMembersGlobals -description: BulkAddWorkspaceMembersGlobals type definition -seoTitle: BulkAddWorkspaceMembersGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkaddworkspacemembersglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAddWorkspaceMembersGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersGlobals%20-%20TypeScript%20SDK&description=BulkAddWorkspaceMembersGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAddWorkspaceMembersGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkAddWorkspaceMembersGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersrequest.mdx deleted file mode 100644 index 6fa3086e..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersrequest.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BulkAddWorkspaceMembersRequest - TypeScript SDK -sidebarTitle: BulkAddWorkspaceMembersRequest -description: BulkAddWorkspaceMembersRequest type definition -seoTitle: BulkAddWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkaddworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAddWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAddWorkspaceMembersRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAddWorkspaceMembersRequest%20-%20TypeScript%20SDK&description=BulkAddWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAddWorkspaceMembersRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkAddWorkspaceMembersRequest = { - id: "production", - bulkAddWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [models.BulkAddWorkspaceMembersRequest](/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailglobals.mdx deleted file mode 100644 index e2d74a04..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailGlobals - TypeScript SDK -sidebarTitle: BulkAssignKeysToGuardrailGlobals -description: BulkAssignKeysToGuardrailGlobals type definition -seoTitle: BulkAssignKeysToGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkassignkeystoguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysToGuardrailGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailGlobals%20-%20TypeScript%20SDK&description=BulkAssignKeysToGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysToGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignKeysToGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailrequest.mdx deleted file mode 100644 index fe5bbc06..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkassignkeystoguardrailrequest.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequest - TypeScript SDK -sidebarTitle: BulkAssignKeysToGuardrailRequest -description: BulkAssignKeysToGuardrailRequest type definition -seoTitle: BulkAssignKeysToGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkassignkeystoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysToGuardrailRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequest%20-%20TypeScript%20SDK&description=BulkAssignKeysToGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysToGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignKeysToGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [models.BulkAssignKeysRequest](/client-sdks/typescript/api-reference/models/bulkassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx deleted file mode 100644 index ea2da175..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailGlobals - TypeScript SDK -sidebarTitle: BulkAssignMembersToGuardrailGlobals -description: BulkAssignMembersToGuardrailGlobals type definition -seoTitle: BulkAssignMembersToGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersToGuardrailGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailGlobals%20-%20TypeScript%20SDK&description=BulkAssignMembersToGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersToGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignMembersToGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx deleted file mode 100644 index d874bb78..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailrequest.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequest - TypeScript SDK -sidebarTitle: BulkAssignMembersToGuardrailRequest -description: BulkAssignMembersToGuardrailRequest type definition -seoTitle: BulkAssignMembersToGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkassignmemberstoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersToGuardrailRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequest%20-%20TypeScript%20SDK&description=BulkAssignMembersToGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersToGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignMembersToGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkAssignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [models.BulkAssignMembersRequest](/client-sdks/typescript/api-reference/models/bulkassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersglobals.mdx deleted file mode 100644 index f49608ba..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersGlobals - TypeScript SDK -sidebarTitle: BulkRemoveWorkspaceMembersGlobals -description: BulkRemoveWorkspaceMembersGlobals type definition -seoTitle: BulkRemoveWorkspaceMembersGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkremoveworkspacemembersglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkRemoveWorkspaceMembersGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersGlobals%20-%20TypeScript%20SDK&description=BulkRemoveWorkspaceMembersGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkRemoveWorkspaceMembersGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkRemoveWorkspaceMembersGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersrequest.mdx deleted file mode 100644 index 44a9e224..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersrequest.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BulkRemoveWorkspaceMembersRequest - TypeScript SDK -sidebarTitle: BulkRemoveWorkspaceMembersRequest -description: BulkRemoveWorkspaceMembersRequest type definition -seoTitle: BulkRemoveWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkremoveworkspacemembersrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkRemoveWorkspaceMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkRemoveWorkspaceMembersRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkRemoveWorkspaceMembersRequest%20-%20TypeScript%20SDK&description=BulkRemoveWorkspaceMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkRemoveWorkspaceMembersRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkRemoveWorkspaceMembersRequest = { - id: "production", - bulkRemoveWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [models.BulkRemoveWorkspaceMembersRequest](/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | `{"user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx deleted file mode 100644 index 12e65d19..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailGlobals - TypeScript SDK -sidebarTitle: BulkUnassignKeysFromGuardrailGlobals -description: BulkUnassignKeysFromGuardrailGlobals type definition -seoTitle: BulkUnassignKeysFromGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysFromGuardrailGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailGlobals%20-%20TypeScript%20SDK&description=BulkUnassignKeysFromGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysFromGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignKeysFromGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx deleted file mode 100644 index ec131428..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailrequest.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequest - TypeScript SDK -sidebarTitle: BulkUnassignKeysFromGuardrailRequest -description: BulkUnassignKeysFromGuardrailRequest type definition -seoTitle: BulkUnassignKeysFromGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkunassignkeysfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequest%20-%20TypeScript%20SDK&description=BulkUnassignKeysFromGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysFromGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignKeysFromGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignKeysRequest: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [models.BulkUnassignKeysRequest](/client-sdks/typescript/api-reference/models/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | `{"key_hashes": ["c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx deleted file mode 100644 index 2c72cd6f..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailGlobals - TypeScript SDK -sidebarTitle: BulkUnassignMembersFromGuardrailGlobals -description: BulkUnassignMembersFromGuardrailGlobals type definition -seoTitle: BulkUnassignMembersFromGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersFromGuardrailGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailGlobals%20-%20TypeScript%20SDK&description=BulkUnassignMembersFromGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersFromGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignMembersFromGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx deleted file mode 100644 index 6a37cdbb..00000000 --- a/client-sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailrequest.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequest - TypeScript SDK -sidebarTitle: BulkUnassignMembersFromGuardrailRequest -description: BulkUnassignMembersFromGuardrailRequest type definition -seoTitle: BulkUnassignMembersFromGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/bulkunassignmembersfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequest%20-%20TypeScript%20SDK&description=BulkUnassignMembersFromGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersFromGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignMembersFromGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - bulkUnassignMembersRequest: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [models.BulkUnassignMembersRequest](/client-sdks/typescript/api-reference/models/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | `{"member_user_ids": ["user_abc123","user_def456"]}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/category.mdx b/client-sdks/typescript/api-reference/operations/category.mdx deleted file mode 100644 index 1877d9f9..00000000 --- a/client-sdks/typescript/api-reference/operations/category.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Category - TypeScript SDK -sidebarTitle: Category -description: Category type definition -seoTitle: Category Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/category' -'og:site_name': OpenRouter Documentation -'og:title': Category Type | OpenRouter TypeScript SDK -'og:description': >- - Category type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Category%20-%20TypeScript%20SDK&description=Category%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Filter models by use case category - -## Example Usage - -```typescript lines -import { Category } from "@openrouter/sdk/models/operations"; - -let value: Category = "programming"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"programming" | "roleplay" | "marketing" | "marketing/seo" | "technology" | "science" | "translation" | "legal" | "finance" | "health" | "trivia" | "academia" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/content.mdx b/client-sdks/typescript/api-reference/operations/content.mdx deleted file mode 100644 index 1f585744..00000000 --- a/client-sdks/typescript/api-reference/operations/content.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Content - TypeScript SDK -sidebarTitle: Content -description: Content type definition -seoTitle: Content Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/content' -'og:site_name': OpenRouter Documentation -'og:title': Content Type | OpenRouter TypeScript SDK -'og:description': >- - Content type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Content%20-%20TypeScript%20SDK&description=Content%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.ContentText` - -```typescript lines -const value: operations.ContentText = { - text: "", - type: "text", -}; -``` - -### `operations.ContentImageURL` - -```typescript lines -const value: operations.ContentImageURL = { - imageUrl: { - url: "https://zealous-march.biz/", - }, - type: "image_url", -}; -``` - -### `models.ContentPartInputAudio` - -```typescript lines -const value: models.ContentPartInputAudio = { - inputAudio: { - data: "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...", - }, - type: "input_audio", -}; -``` - -### `models.ContentPartInputVideo` - -```typescript lines -const value: models.ContentPartInputVideo = { - inputVideo: { - data: "data:video/mp4;base64,AAAAGGZ0eXBtcDQyAAAAAGlzb21tcDQy...", - }, - type: "input_video", -}; -``` - -### `models.ContentPartInputFile` - -```typescript lines -const value: models.ContentPartInputFile = { - inputFile: { - data: "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAw...", - }, - type: "input_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/contentimageurl.mdx b/client-sdks/typescript/api-reference/operations/contentimageurl.mdx deleted file mode 100644 index 3316a5f5..00000000 --- a/client-sdks/typescript/api-reference/operations/contentimageurl.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ContentImageURL - TypeScript SDK -sidebarTitle: ContentImageURL -description: ContentImageURL type definition -seoTitle: ContentImageURL Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/contentimageurl -'og:site_name': OpenRouter Documentation -'og:title': ContentImageURL Type | OpenRouter TypeScript SDK -'og:description': >- - ContentImageURL type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentImageURL%20-%20TypeScript%20SDK&description=ContentImageURL%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentImageURL } from "@openrouter/sdk/models/operations"; - -let value: ContentImageURL = { - imageUrl: { - url: "https://zealous-march.biz/", - }, - type: "image_url", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `imageUrl` | [operations.ImageUrl](/client-sdks/typescript/api-reference/operations/imageurl) | :heavy_check_mark: | N/A | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/contenttext.mdx b/client-sdks/typescript/api-reference/operations/contenttext.mdx deleted file mode 100644 index 0e9ba086..00000000 --- a/client-sdks/typescript/api-reference/operations/contenttext.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentText - TypeScript SDK -sidebarTitle: ContentText -description: ContentText type definition -seoTitle: ContentText Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/contenttext -'og:site_name': OpenRouter Documentation -'og:title': ContentText Type | OpenRouter TypeScript SDK -'og:description': >- - ContentText type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentText%20-%20TypeScript%20SDK&description=ContentText%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentText } from "@openrouter/sdk/models/operations"; - -let value: ContentText = { - text: "", - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createaudiospeechglobals.mdx b/client-sdks/typescript/api-reference/operations/createaudiospeechglobals.mdx deleted file mode 100644 index 4cf6e032..00000000 --- a/client-sdks/typescript/api-reference/operations/createaudiospeechglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateAudioSpeechGlobals - TypeScript SDK -sidebarTitle: CreateAudioSpeechGlobals -description: CreateAudioSpeechGlobals type definition -seoTitle: CreateAudioSpeechGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createaudiospeechglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioSpeechGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAudioSpeechGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioSpeechGlobals%20-%20TypeScript%20SDK&description=CreateAudioSpeechGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAudioSpeechGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateAudioSpeechGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createaudiospeechrequest.mdx b/client-sdks/typescript/api-reference/operations/createaudiospeechrequest.mdx deleted file mode 100644 index 42784b64..00000000 --- a/client-sdks/typescript/api-reference/operations/createaudiospeechrequest.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: CreateAudioSpeechRequest - TypeScript SDK -sidebarTitle: CreateAudioSpeechRequest -description: CreateAudioSpeechRequest type definition -seoTitle: CreateAudioSpeechRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createaudiospeechrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioSpeechRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAudioSpeechRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioSpeechRequest%20-%20TypeScript%20SDK&description=CreateAudioSpeechRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAudioSpeechRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateAudioSpeechRequest = { - speechRequest: { - input: "Hello world", - model: "elevenlabs/eleven-turbo-v2", - voice: "alloy", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speechRequest` | [models.SpeechRequest](/client-sdks/typescript/api-reference/models/speechrequest) | :heavy_check_mark: | N/A | `{"input": "Hello world","model": "elevenlabs/eleven-turbo-v2","response_format": "pcm","speed": 1,"voice": "alloy"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsglobals.mdx b/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsglobals.mdx deleted file mode 100644 index 17cbf39c..00000000 --- a/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateAudioTranscriptionsGlobals - TypeScript SDK -sidebarTitle: CreateAudioTranscriptionsGlobals -description: CreateAudioTranscriptionsGlobals type definition -seoTitle: CreateAudioTranscriptionsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createaudiotranscriptionsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioTranscriptionsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAudioTranscriptionsGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioTranscriptionsGlobals%20-%20TypeScript%20SDK&description=CreateAudioTranscriptionsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAudioTranscriptionsGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateAudioTranscriptionsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsrequest.mdx b/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsrequest.mdx deleted file mode 100644 index 4abe836b..00000000 --- a/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsrequest.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CreateAudioTranscriptionsRequest - TypeScript SDK -sidebarTitle: CreateAudioTranscriptionsRequest -description: CreateAudioTranscriptionsRequest type definition -seoTitle: CreateAudioTranscriptionsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createaudiotranscriptionsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAudioTranscriptionsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAudioTranscriptionsRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAudioTranscriptionsRequest%20-%20TypeScript%20SDK&description=CreateAudioTranscriptionsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAudioTranscriptionsRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateAudioTranscriptionsRequest = { - sttRequest: { - inputAudio: { - data: "UklGRiQA...", - format: "wav", - }, - model: "openai/whisper-large-v3", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `sttRequest` | [models.STTRequest](/client-sdks/typescript/api-reference/models/sttrequest) | :heavy_check_mark: | N/A | `{"input_audio": {"data": "UklGRiQA...","format": "wav"}`,
"language": "en",
"model": "openai/whisper-large-v3"
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscodecodechallengemethod.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscodecodechallengemethod.mdx deleted file mode 100644 index c146cce7..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscodecodechallengemethod.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CreateAuthKeysCodeCodeChallengeMethod - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeCodeChallengeMethod -description: CreateAuthKeysCodeCodeChallengeMethod type definition -seoTitle: CreateAuthKeysCodeCodeChallengeMethod Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscodecodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeCodeChallengeMethod Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeCodeChallengeMethod type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeCodeChallengeMethod%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeCodeChallengeMethod%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeCodeChallengeMethod } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeCodeChallengeMethod = "S256"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"S256" | "plain" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscodedata.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscodedata.mdx deleted file mode 100644 index 37940d81..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscodedata.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateAuthKeysCodeData - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeData -description: CreateAuthKeysCodeData type definition -seoTitle: CreateAuthKeysCodeData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscodedata -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeData Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeData%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Auth code data - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeData } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeData = { - appId: 12345, - createdAt: "2025-08-24T10:30:00Z", - id: "auth_code_xyz789", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `appId` | *number* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscodeglobals.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscodeglobals.mdx deleted file mode 100644 index 95e39b5a..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscodeglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateAuthKeysCodeGlobals - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeGlobals -description: CreateAuthKeysCodeGlobals type definition -seoTitle: CreateAuthKeysCodeGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscodeglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeGlobals%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscoderequest.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscoderequest.mdx deleted file mode 100644 index c6c50dcf..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscoderequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateAuthKeysCodeRequest - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeRequest -description: CreateAuthKeysCodeRequest type definition -seoTitle: CreateAuthKeysCodeRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscoderequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequest%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeRequest = { - requestBody: { - callbackUrl: "https://myapp.com/auth/callback", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateAuthKeysCodeRequestBody](/client-sdks/typescript/api-reference/operations/createauthkeyscoderequestbody) | :heavy_check_mark: | N/A | `{"callback_url": "https://myapp.com/auth/callback","code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM","code_challenge_method": "S256","limit": 100}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscoderequestbody.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscoderequestbody.mdx deleted file mode 100644 index f209ce02..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscoderequestbody.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateAuthKeysCodeRequestBody - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeRequestBody -description: CreateAuthKeysCodeRequestBody type definition -seoTitle: CreateAuthKeysCodeRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscoderequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeRequestBody type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequestBody%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeRequestBody } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeRequestBody = { - callbackUrl: "https://myapp.com/auth/callback", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `callbackUrl` | *string* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `codeChallenge` | *string* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](/client-sdks/typescript/api-reference/operations/createauthkeyscodecodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional 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` | *number* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usageLimitType` | [operations.UsageLimitType](/client-sdks/typescript/api-reference/operations/usagelimittype) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createauthkeyscoderesponse.mdx b/client-sdks/typescript/api-reference/operations/createauthkeyscoderesponse.mdx deleted file mode 100644 index eadceaef..00000000 --- a/client-sdks/typescript/api-reference/operations/createauthkeyscoderesponse.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateAuthKeysCodeResponse - TypeScript SDK -sidebarTitle: CreateAuthKeysCodeResponse -description: CreateAuthKeysCodeResponse type definition -seoTitle: CreateAuthKeysCodeResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createauthkeyscoderesponse -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeResponse%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Successfully created authorization code - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeResponse = { - data: { - appId: 12345, - createdAt: "2025-08-24T10:30:00Z", - id: "auth_code_xyz789", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/createbyokkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/createbyokkeyglobals.mdx deleted file mode 100644 index c385df23..00000000 --- a/client-sdks/typescript/api-reference/operations/createbyokkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateBYOKKeyGlobals - TypeScript SDK -sidebarTitle: CreateBYOKKeyGlobals -description: CreateBYOKKeyGlobals type definition -seoTitle: CreateBYOKKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createbyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateBYOKKeyGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyGlobals%20-%20TypeScript%20SDK&description=CreateBYOKKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateBYOKKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateBYOKKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createbyokkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/createbyokkeyrequest.mdx deleted file mode 100644 index 97161874..00000000 --- a/client-sdks/typescript/api-reference/operations/createbyokkeyrequest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateBYOKKeyRequest - TypeScript SDK -sidebarTitle: CreateBYOKKeyRequest -description: CreateBYOKKeyRequest type definition -seoTitle: CreateBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateBYOKKeyRequest%20-%20TypeScript%20SDK&description=CreateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateBYOKKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateBYOKKeyRequest = { - createBYOKKeyRequest: { - key: "sk-proj-abc123...", - provider: "openai", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createBYOKKeyRequest` | [models.CreateBYOKKeyRequest](/client-sdks/typescript/api-reference/models/createbyokkeyrequest) | :heavy_check_mark: | N/A | `{"key": "sk-proj-abc123...","name": "Production OpenAI Key","provider": "openai"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsdata.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsdata.mdx deleted file mode 100644 index a63a02f8..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CreateEmbeddingsData - TypeScript SDK -sidebarTitle: CreateEmbeddingsData -description: CreateEmbeddingsData type definition -seoTitle: CreateEmbeddingsData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsdata -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsData Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsData%20-%20TypeScript%20SDK&description=CreateEmbeddingsData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A single embedding object - -## Example Usage - -```typescript lines -import { CreateEmbeddingsData } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsData = { - embedding: [ - 0.0023064255, - -0.009327292, - 0.015797347, - ], - object: "embedding", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `embedding` | *operations.Embedding* | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *number* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](/client-sdks/typescript/api-reference/operations/objectembedding) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsglobals.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsglobals.mdx deleted file mode 100644 index 5cf9876b..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateEmbeddingsGlobals - TypeScript SDK -sidebarTitle: CreateEmbeddingsGlobals -description: CreateEmbeddingsGlobals type definition -seoTitle: CreateEmbeddingsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsGlobals%20-%20TypeScript%20SDK&description=CreateEmbeddingsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateEmbeddingsGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsrequest.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsrequest.mdx deleted file mode 100644 index 1e05778f..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsrequest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateEmbeddingsRequest - TypeScript SDK -sidebarTitle: CreateEmbeddingsRequest -description: CreateEmbeddingsRequest type definition -seoTitle: CreateEmbeddingsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequest%20-%20TypeScript%20SDK&description=CreateEmbeddingsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateEmbeddingsRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsRequest = { - requestBody: { - input: "The quick brown fox jumps over the lazy dog", - model: "openai/text-embedding-3-small", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateEmbeddingsRequestBody](/client-sdks/typescript/api-reference/operations/createembeddingsrequestbody) | :heavy_check_mark: | N/A | `{"dimensions": 1536,"input": "The quick brown fox jumps over the lazy dog","model": "openai/text-embedding-3-small"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsrequestbody.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsrequestbody.mdx deleted file mode 100644 index f551d39b..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsrequestbody.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CreateEmbeddingsRequestBody - TypeScript SDK -sidebarTitle: CreateEmbeddingsRequestBody -description: CreateEmbeddingsRequestBody type definition -seoTitle: CreateEmbeddingsRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsRequestBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequestBody%20-%20TypeScript%20SDK&description=CreateEmbeddingsRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Embeddings request input - -## Example Usage - -```typescript lines -import { CreateEmbeddingsRequestBody } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsRequestBody = { - input: "The quick brown fox jumps over the lazy dog", - model: "openai/text-embedding-3-small", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `dimensions` | *number* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encodingFormat` | [operations.EncodingFormat](/client-sdks/typescript/api-reference/operations/encodingformat) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input` | *operations.InputUnion* | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `inputType` | *string* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `model` | *string* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/createembeddingsresponse.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsresponse.mdx deleted file mode 100644 index 8d3283c7..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsresponse.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateEmbeddingsResponse - TypeScript SDK -sidebarTitle: CreateEmbeddingsResponse -description: CreateEmbeddingsResponse type definition -seoTitle: CreateEmbeddingsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponse%20-%20TypeScript%20SDK&description=CreateEmbeddingsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateEmbeddingsResponseBody` - -```typescript lines -const value: operations.CreateEmbeddingsResponseBody = { - data: [ - { - embedding: [ - 0.0023064255, - -0.009327292, - 0.015797347, - ], - object: "embedding", - }, - ], - model: "openai/text-embedding-3-small", - object: "list", -}; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsresponsebody.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsresponsebody.mdx deleted file mode 100644 index 2c265c3e..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsresponsebody.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: CreateEmbeddingsResponseBody - TypeScript SDK -sidebarTitle: CreateEmbeddingsResponseBody -description: CreateEmbeddingsResponseBody type definition -seoTitle: CreateEmbeddingsResponseBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponseBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsResponseBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponseBody%20-%20TypeScript%20SDK&description=CreateEmbeddingsResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Embeddings response containing embedding vectors - -## Example Usage - -```typescript lines -import { CreateEmbeddingsResponseBody } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsResponseBody = { - data: [ - { - embedding: [ - 0.0023064255, - -0.009327292, - 0.015797347, - ], - object: "embedding", - }, - ], - model: "openai/text-embedding-3-small", - object: "list", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateEmbeddingsData](/client-sdks/typescript/api-reference/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.ObjectT](/client-sdks/typescript/api-reference/operations/objectt) | :heavy_check_mark: | N/A | | -| `usage` | [operations.CreateEmbeddingsUsage](/client-sdks/typescript/api-reference/operations/createembeddingsusage) | :heavy_minus_sign: | Token usage statistics | `{"prompt_tokens": 8,"total_tokens": 8}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createembeddingsusage.mdx b/client-sdks/typescript/api-reference/operations/createembeddingsusage.mdx deleted file mode 100644 index 760631d7..00000000 --- a/client-sdks/typescript/api-reference/operations/createembeddingsusage.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateEmbeddingsUsage - TypeScript SDK -sidebarTitle: CreateEmbeddingsUsage -description: CreateEmbeddingsUsage type definition -seoTitle: CreateEmbeddingsUsage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createembeddingsusage -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsUsage Type | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsUsage type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsUsage%20-%20TypeScript%20SDK&description=CreateEmbeddingsUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Token usage statistics - -## Example Usage - -```typescript lines -import { CreateEmbeddingsUsage } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsUsage = { - promptTokens: 8, - totalTokens: 8, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `promptTokensDetails` | [operations.PromptTokensDetails](/client-sdks/typescript/api-reference/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` | *number* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/createguardrailglobals.mdx deleted file mode 100644 index e9156272..00000000 --- a/client-sdks/typescript/api-reference/operations/createguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateGuardrailGlobals - TypeScript SDK -sidebarTitle: CreateGuardrailGlobals -description: CreateGuardrailGlobals type definition -seoTitle: CreateGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailGlobals%20-%20TypeScript%20SDK&description=CreateGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/createguardrailrequest.mdx deleted file mode 100644 index 0d1e53ce..00000000 --- a/client-sdks/typescript/api-reference/operations/createguardrailrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateGuardrailRequest - TypeScript SDK -sidebarTitle: CreateGuardrailRequest -description: CreateGuardrailRequest type definition -seoTitle: CreateGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20TypeScript%20SDK&description=CreateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailRequest = { - createGuardrailRequest: { - name: "My New Guardrail", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createGuardrailRequest` | [models.CreateGuardrailRequest](/client-sdks/typescript/api-reference/models/createguardrailrequest) | :heavy_check_mark: | N/A | `{"allowed_models": null,"allowed_providers": ["openai","anthropic","deepseek"],"content_filter_builtins": [{"action": "block","slug": "regex-prompt-injection"}`
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createkeysdata.mdx b/client-sdks/typescript/api-reference/operations/createkeysdata.mdx deleted file mode 100644 index b1fef4c1..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeysdata.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: CreateKeysData - TypeScript SDK -sidebarTitle: CreateKeysData -description: CreateKeysData type definition -seoTitle: CreateKeysData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeysdata -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysData Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysData type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysData%20-%20TypeScript%20SDK&description=CreateKeysData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The created API key information - -## Example Usage - -```typescript expandable lines -import { CreateKeysData } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysData = { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "sk-or-v1-0e6...1c96", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createkeysglobals.mdx b/client-sdks/typescript/api-reference/operations/createkeysglobals.mdx deleted file mode 100644 index 639b0917..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeysglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateKeysGlobals - TypeScript SDK -sidebarTitle: CreateKeysGlobals -description: CreateKeysGlobals type definition -seoTitle: CreateKeysGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeysglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysGlobals%20-%20TypeScript%20SDK&description=CreateKeysGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateKeysGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createkeyslimitreset.mdx b/client-sdks/typescript/api-reference/operations/createkeyslimitreset.mdx deleted file mode 100644 index fb271b6a..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeyslimitreset.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CreateKeysLimitReset - TypeScript SDK -sidebarTitle: CreateKeysLimitReset -description: CreateKeysLimitReset type definition -seoTitle: CreateKeysLimitReset Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysLimitReset Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysLimitReset type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysLimitReset%20-%20TypeScript%20SDK&description=CreateKeysLimitReset%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { CreateKeysLimitReset } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysLimitReset = "monthly"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createkeysrequest.mdx b/client-sdks/typescript/api-reference/operations/createkeysrequest.mdx deleted file mode 100644 index 60e168cc..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeysrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateKeysRequest - TypeScript SDK -sidebarTitle: CreateKeysRequest -description: CreateKeysRequest type definition -seoTitle: CreateKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequest%20-%20TypeScript%20SDK&description=CreateKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysRequest = { - requestBody: { - name: "My New API Key", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateKeysRequestBody](/client-sdks/typescript/api-reference/operations/createkeysrequestbody) | :heavy_check_mark: | N/A | `{"expires_at": "2027-12-31T23:59:59Z","include_byok_in_limit": true,"limit": 50,"limit_reset": "monthly","name": "My New API Key"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createkeysrequestbody.mdx b/client-sdks/typescript/api-reference/operations/createkeysrequestbody.mdx deleted file mode 100644 index ab49c18f..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeysrequestbody.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateKeysRequestBody - TypeScript SDK -sidebarTitle: CreateKeysRequestBody -description: CreateKeysRequestBody type definition -seoTitle: CreateKeysRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeysrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysRequestBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequestBody%20-%20TypeScript%20SDK&description=CreateKeysRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateKeysRequestBody } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysRequestBody = { - name: "My New API Key", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `creatorUserId` | *string* | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected | 2027-12-31T23:59:59Z | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *number* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limitReset` | [operations.CreateKeysLimitReset](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/createkeysresponse.mdx b/client-sdks/typescript/api-reference/operations/createkeysresponse.mdx deleted file mode 100644 index 4e655ebb..00000000 --- a/client-sdks/typescript/api-reference/operations/createkeysresponse.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: CreateKeysResponse - TypeScript SDK -sidebarTitle: CreateKeysResponse -description: CreateKeysResponse type definition -seoTitle: CreateKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysResponse%20-%20TypeScript%20SDK&description=CreateKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key created successfully - -## Example Usage - -```typescript expandable lines -import { CreateKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysResponse = { - data: { - byokUsage: 0, - byokUsageDaily: 0, - byokUsageMonthly: 0, - byokUsageWeekly: 0, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: true, - label: "My New API Key", - limit: 50, - limitRemaining: 50, - limitReset: "monthly", - name: "My New API Key", - updatedAt: null, - usage: 0, - usageDaily: 0, - usageMonthly: 0, - usageWeekly: 0, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, - key: - "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", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.CreateKeysData](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/createobservabilitydestinationglobals.mdx b/client-sdks/typescript/api-reference/operations/createobservabilitydestinationglobals.mdx deleted file mode 100644 index 0edd53ad..00000000 --- a/client-sdks/typescript/api-reference/operations/createobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateObservabilityDestinationGlobals - TypeScript SDK -sidebarTitle: CreateObservabilityDestinationGlobals -description: CreateObservabilityDestinationGlobals type definition -seoTitle: CreateObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateObservabilityDestinationGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationGlobals%20-%20TypeScript%20SDK&description=CreateObservabilityDestinationGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateObservabilityDestinationGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateObservabilityDestinationGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/operations/createobservabilitydestinationrequest.mdx deleted file mode 100644 index 57f8f7ea..00000000 --- a/client-sdks/typescript/api-reference/operations/createobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: CreateObservabilityDestinationRequest -description: CreateObservabilityDestinationRequest type definition -seoTitle: CreateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=CreateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateObservabilityDestinationRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateObservabilityDestinationRequest = { - createObservabilityDestinationRequest: { - config: { - "baseUrl": "https://us.cloud.langfuse.com", - "publicKey": "pk-l...EfGh", - "secretKey": "sk-l...AbCd", - }, - name: "Production Langfuse", - type: "langfuse", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createObservabilityDestinationRequest` | [models.CreateObservabilityDestinationRequest](/client-sdks/typescript/api-reference/models/createobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"config": {"baseUrl": "https://us.cloud.langfuse.com","publicKey": "pk-l...EfGh","secretKey": "sk-l...AbCd"}`,
"name": "Production Langfuse",
"type": "langfuse"
\} | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsglobals.mdx b/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsglobals.mdx deleted file mode 100644 index 3517a461..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreatePresetsChatCompletionsGlobals - TypeScript SDK -sidebarTitle: CreatePresetsChatCompletionsGlobals -description: CreatePresetsChatCompletionsGlobals type definition -seoTitle: CreatePresetsChatCompletionsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetschatcompletionsglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsChatCompletionsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsChatCompletionsGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsChatCompletionsGlobals%20-%20TypeScript%20SDK&description=CreatePresetsChatCompletionsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsChatCompletionsGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsChatCompletionsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsrequest.mdx b/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsrequest.mdx deleted file mode 100644 index 2e48ab3c..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsrequest.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: CreatePresetsChatCompletionsRequest - TypeScript SDK -sidebarTitle: CreatePresetsChatCompletionsRequest -description: CreatePresetsChatCompletionsRequest type definition -seoTitle: CreatePresetsChatCompletionsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetschatcompletionsrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsChatCompletionsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsChatCompletionsRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsChatCompletionsRequest%20-%20TypeScript%20SDK&description=CreatePresetsChatCompletionsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsChatCompletionsRequest } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsChatCompletionsRequest = { - slug: "my-preset", - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [models.ChatRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/createpresetsmessagesglobals.mdx b/client-sdks/typescript/api-reference/operations/createpresetsmessagesglobals.mdx deleted file mode 100644 index ac154e84..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetsmessagesglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreatePresetsMessagesGlobals - TypeScript SDK -sidebarTitle: CreatePresetsMessagesGlobals -description: CreatePresetsMessagesGlobals type definition -seoTitle: CreatePresetsMessagesGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetsmessagesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsMessagesGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsMessagesGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsMessagesGlobals%20-%20TypeScript%20SDK&description=CreatePresetsMessagesGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsMessagesGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsMessagesGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createpresetsmessagesrequest.mdx b/client-sdks/typescript/api-reference/operations/createpresetsmessagesrequest.mdx deleted file mode 100644 index bad58c0f..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetsmessagesrequest.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: CreatePresetsMessagesRequest - TypeScript SDK -sidebarTitle: CreatePresetsMessagesRequest -description: CreatePresetsMessagesRequest type definition -seoTitle: CreatePresetsMessagesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetsmessagesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsMessagesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsMessagesRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsMessagesRequest%20-%20TypeScript%20SDK&description=CreatePresetsMessagesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsMessagesRequest } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsMessagesRequest = { - slug: "my-preset", - messagesRequest: { - messages: [ - { - content: "Hello, how are you?", - role: "user", - }, - ], - model: "anthropic/claude-4.5-sonnet-20250929", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [models.MessagesRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/createpresetsresponsesglobals.mdx b/client-sdks/typescript/api-reference/operations/createpresetsresponsesglobals.mdx deleted file mode 100644 index 91438a77..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetsresponsesglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreatePresetsResponsesGlobals - TypeScript SDK -sidebarTitle: CreatePresetsResponsesGlobals -description: CreatePresetsResponsesGlobals type definition -seoTitle: CreatePresetsResponsesGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetsresponsesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsResponsesGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsResponsesGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsResponsesGlobals%20-%20TypeScript%20SDK&description=CreatePresetsResponsesGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsResponsesGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsResponsesGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createpresetsresponsesrequest.mdx b/client-sdks/typescript/api-reference/operations/createpresetsresponsesrequest.mdx deleted file mode 100644 index 0fa41f2e..00000000 --- a/client-sdks/typescript/api-reference/operations/createpresetsresponsesrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreatePresetsResponsesRequest - TypeScript SDK -sidebarTitle: CreatePresetsResponsesRequest -description: CreatePresetsResponsesRequest type definition -seoTitle: CreatePresetsResponsesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createpresetsresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreatePresetsResponsesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreatePresetsResponsesRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreatePresetsResponsesRequest%20-%20TypeScript%20SDK&description=CreatePresetsResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreatePresetsResponsesRequest } from "@openrouter/sdk/models/operations"; - -let value: CreatePresetsResponsesRequest = { - slug: "my-preset", - responsesRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [models.ResponsesRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/creatererankglobals.mdx b/client-sdks/typescript/api-reference/operations/creatererankglobals.mdx deleted file mode 100644 index 65e093fe..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateRerankGlobals - TypeScript SDK -sidebarTitle: CreateRerankGlobals -description: CreateRerankGlobals type definition -seoTitle: CreateRerankGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankGlobals%20-%20TypeScript%20SDK&description=CreateRerankGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateRerankGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateRerankGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/creatererankrequest.mdx b/client-sdks/typescript/api-reference/operations/creatererankrequest.mdx deleted file mode 100644 index 50381abe..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankrequest.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: CreateRerankRequest - TypeScript SDK -sidebarTitle: CreateRerankRequest -description: CreateRerankRequest type definition -seoTitle: CreateRerankRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankRequest%20-%20TypeScript%20SDK&description=CreateRerankRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateRerankRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateRerankRequest = { - requestBody: { - documents: [ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - ], - model: "cohere/rerank-v3.5", - query: "What is the capital of France?", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateRerankRequestBody](/client-sdks/typescript/api-reference/operations/creatererankrequestbody) | :heavy_check_mark: | N/A | `{"documents": ["Paris is the capital of France.","Berlin is the capital of Germany."],"model": "cohere/rerank-v3.5","query": "What is the capital of France?","top_n": 3}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/creatererankrequestbody.mdx b/client-sdks/typescript/api-reference/operations/creatererankrequestbody.mdx deleted file mode 100644 index 8238cfd0..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankrequestbody.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateRerankRequestBody - TypeScript SDK -sidebarTitle: CreateRerankRequestBody -description: CreateRerankRequestBody type definition -seoTitle: CreateRerankRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankrequestbody -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankRequestBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankRequestBody%20-%20TypeScript%20SDK&description=CreateRerankRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Rerank request input - -## Example Usage - -```typescript lines -import { CreateRerankRequestBody } from "@openrouter/sdk/models/operations"; - -let value: CreateRerankRequestBody = { - documents: [ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - ], - model: "cohere/rerank-v3.5", - query: "What is the capital of France?", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `documents` | *string*[] | :heavy_check_mark: | The list of documents to rerank | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `model` | *string* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/api-reference/models/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` | *number* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/creatererankresponse.mdx b/client-sdks/typescript/api-reference/operations/creatererankresponse.mdx deleted file mode 100644 index 3a1638c6..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankresponse.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CreateRerankResponse - TypeScript SDK -sidebarTitle: CreateRerankResponse -description: CreateRerankResponse type definition -seoTitle: CreateRerankResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponse%20-%20TypeScript%20SDK&description=CreateRerankResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateRerankResponseBody` - -```typescript lines -const value: operations.CreateRerankResponseBody = { - model: "cohere/rerank-v3.5", - results: [ - { - document: { - text: "Paris is the capital of France.", - }, - index: 0, - relevanceScore: 0.98, - }, - ], -}; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/creatererankresponsebody.mdx b/client-sdks/typescript/api-reference/operations/creatererankresponsebody.mdx deleted file mode 100644 index b72ce6da..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankresponsebody.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: CreateRerankResponseBody - TypeScript SDK -sidebarTitle: CreateRerankResponseBody -description: CreateRerankResponseBody type definition -seoTitle: CreateRerankResponseBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankResponseBody Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankResponseBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankResponseBody%20-%20TypeScript%20SDK&description=CreateRerankResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Rerank response containing ranked results - -## Example Usage - -```typescript lines -import { CreateRerankResponseBody } from "@openrouter/sdk/models/operations"; - -let value: CreateRerankResponseBody = { - model: "cohere/rerank-v3.5", - results: [ - { - document: { - text: "Paris is the capital of France.", - }, - index: 0, - relevanceScore: 0.98, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `model` | *string* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `provider` | *string* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `results` | [operations.Result](/client-sdks/typescript/api-reference/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](/client-sdks/typescript/api-reference/operations/creatererankusage) | :heavy_minus_sign: | Usage statistics | `{"search_units": 1,"total_tokens": 150}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/creatererankusage.mdx b/client-sdks/typescript/api-reference/operations/creatererankusage.mdx deleted file mode 100644 index cb04c212..00000000 --- a/client-sdks/typescript/api-reference/operations/creatererankusage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CreateRerankUsage - TypeScript SDK -sidebarTitle: CreateRerankUsage -description: CreateRerankUsage type definition -seoTitle: CreateRerankUsage Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/creatererankusage -'og:site_name': OpenRouter Documentation -'og:title': CreateRerankUsage Type | OpenRouter TypeScript SDK -'og:description': >- - CreateRerankUsage type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateRerankUsage%20-%20TypeScript%20SDK&description=CreateRerankUsage%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Usage statistics - -## Example Usage - -```typescript lines -import { CreateRerankUsage } from "@openrouter/sdk/models/operations"; - -let value: CreateRerankUsage = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `searchUnits` | *number* | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `totalTokens` | *number* | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createresponsesglobals.mdx b/client-sdks/typescript/api-reference/operations/createresponsesglobals.mdx deleted file mode 100644 index a21bda43..00000000 --- a/client-sdks/typescript/api-reference/operations/createresponsesglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateResponsesGlobals - TypeScript SDK -sidebarTitle: CreateResponsesGlobals -description: CreateResponsesGlobals type definition -seoTitle: CreateResponsesGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createresponsesglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateResponsesGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesGlobals%20-%20TypeScript%20SDK&description=CreateResponsesGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateResponsesGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateResponsesGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createresponsesrequest.mdx b/client-sdks/typescript/api-reference/operations/createresponsesrequest.mdx deleted file mode 100644 index 30a94fa4..00000000 --- a/client-sdks/typescript/api-reference/operations/createresponsesrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateResponsesRequest - TypeScript SDK -sidebarTitle: CreateResponsesRequest -description: CreateResponsesRequest type definition -seoTitle: CreateResponsesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createresponsesrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateResponsesRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesRequest%20-%20TypeScript%20SDK&description=CreateResponsesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateResponsesRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateResponsesRequest = { - responsesRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterExperimentalMetadata` | [models.MetadataLevel](/client-sdks/typescript/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `responsesRequest` | [models.ResponsesRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/createresponsesresponse.mdx b/client-sdks/typescript/api-reference/operations/createresponsesresponse.mdx deleted file mode 100644 index 54686eca..00000000 --- a/client-sdks/typescript/api-reference/operations/createresponsesresponse.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: CreateResponsesResponse - TypeScript SDK -sidebarTitle: CreateResponsesResponse -description: CreateResponsesResponse type definition -seoTitle: CreateResponsesResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createresponsesresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponse Type | OpenRouter TypeScript SDK -'og:description': >- - CreateResponsesResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponse%20-%20TypeScript%20SDK&description=CreateResponsesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesResult` - -```typescript expandable lines -const value: models.OpenResponsesResult = { - completedAt: 728667, - createdAt: 1704067200, - error: null, - frequencyPenalty: 9990.37, - id: "resp-abc123", - incompleteDetails: null, - instructions: null, - metadata: null, - model: "gpt-4", - object: "response", - output: [ - { - content: [ - { - text: "Hello! How can I help you today?", - type: "output_text", - }, - ], - id: "msg-abc123", - role: "assistant", - type: "message", - }, - ], - parallelToolCalls: true, - presencePenalty: null, - status: "completed", - temperature: null, - toolChoice: "auto", - tools: [], - topP: null, -}; -``` - -### `EventStream` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createvideosglobals.mdx b/client-sdks/typescript/api-reference/operations/createvideosglobals.mdx deleted file mode 100644 index 9c052c25..00000000 --- a/client-sdks/typescript/api-reference/operations/createvideosglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateVideosGlobals - TypeScript SDK -sidebarTitle: CreateVideosGlobals -description: CreateVideosGlobals type definition -seoTitle: CreateVideosGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createvideosglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateVideosGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateVideosGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateVideosGlobals%20-%20TypeScript%20SDK&description=CreateVideosGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateVideosGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateVideosGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createvideosrequest.mdx b/client-sdks/typescript/api-reference/operations/createvideosrequest.mdx deleted file mode 100644 index b5ec2762..00000000 --- a/client-sdks/typescript/api-reference/operations/createvideosrequest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateVideosRequest - TypeScript SDK -sidebarTitle: CreateVideosRequest -description: CreateVideosRequest type definition -seoTitle: CreateVideosRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createvideosrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateVideosRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateVideosRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateVideosRequest%20-%20TypeScript%20SDK&description=CreateVideosRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateVideosRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateVideosRequest = { - videoGenerationRequest: { - model: "google/veo-3.1", - prompt: "A serene mountain landscape at sunset", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `videoGenerationRequest` | [models.VideoGenerationRequest](/client-sdks/typescript/api-reference/models/videogenerationrequest) | :heavy_check_mark: | N/A | `{"aspect_ratio": "16:9","duration": 8,"model": "google/veo-3.1","prompt": "A serene mountain landscape at sunset","resolution": "720p"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createworkspaceglobals.mdx b/client-sdks/typescript/api-reference/operations/createworkspaceglobals.mdx deleted file mode 100644 index 6167d10d..00000000 --- a/client-sdks/typescript/api-reference/operations/createworkspaceglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateWorkspaceGlobals - TypeScript SDK -sidebarTitle: CreateWorkspaceGlobals -description: CreateWorkspaceGlobals type definition -seoTitle: CreateWorkspaceGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - CreateWorkspaceGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceGlobals%20-%20TypeScript%20SDK&description=CreateWorkspaceGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateWorkspaceGlobals } from "@openrouter/sdk/models/operations"; - -let value: CreateWorkspaceGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/createworkspacerequest.mdx b/client-sdks/typescript/api-reference/operations/createworkspacerequest.mdx deleted file mode 100644 index dac02d0d..00000000 --- a/client-sdks/typescript/api-reference/operations/createworkspacerequest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: CreateWorkspaceRequest - TypeScript SDK -sidebarTitle: CreateWorkspaceRequest -description: CreateWorkspaceRequest type definition -seoTitle: CreateWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/createworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': CreateWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - CreateWorkspaceRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateWorkspaceRequest%20-%20TypeScript%20SDK&description=CreateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateWorkspaceRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateWorkspaceRequest = { - createWorkspaceRequest: { - name: "Production", - slug: "production", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createWorkspaceRequest` | [models.CreateWorkspaceRequest](/client-sdks/typescript/api-reference/models/createworkspacerequest) | :heavy_check_mark: | N/A | `{"default_image_model": "openai/dall-e-3","default_provider_sort": "price","default_text_model": "openai/gpt-4o","description": "Production environment workspace","name": "Production","slug": "production"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/datacenter.mdx b/client-sdks/typescript/api-reference/operations/datacenter.mdx deleted file mode 100644 index de871fb6..00000000 --- a/client-sdks/typescript/api-reference/operations/datacenter.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Datacenter - TypeScript SDK -sidebarTitle: Datacenter -description: Datacenter type definition -seoTitle: Datacenter Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/datacenter' -'og:site_name': OpenRouter Documentation -'og:title': Datacenter Type | OpenRouter TypeScript SDK -'og:description': >- - Datacenter type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Datacenter%20-%20TypeScript%20SDK&description=Datacenter%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Datacenter } from "@openrouter/sdk/models/operations"; - -let value: Datacenter = "KE"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deletebyokkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/deletebyokkeyglobals.mdx deleted file mode 100644 index f11d748d..00000000 --- a/client-sdks/typescript/api-reference/operations/deletebyokkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteBYOKKeyGlobals - TypeScript SDK -sidebarTitle: DeleteBYOKKeyGlobals -description: DeleteBYOKKeyGlobals type definition -seoTitle: DeleteBYOKKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deletebyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteBYOKKeyGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyGlobals%20-%20TypeScript%20SDK&description=DeleteBYOKKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteBYOKKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: DeleteBYOKKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deletebyokkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/deletebyokkeyrequest.mdx deleted file mode 100644 index 1168c5a1..00000000 --- a/client-sdks/typescript/api-reference/operations/deletebyokkeyrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DeleteBYOKKeyRequest - TypeScript SDK -sidebarTitle: DeleteBYOKKeyRequest -description: DeleteBYOKKeyRequest type definition -seoTitle: DeleteBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deletebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteBYOKKeyRequest%20-%20TypeScript%20SDK&description=DeleteBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteBYOKKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteBYOKKeyRequest = { - id: "11111111-2222-3333-4444-555555555555", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/deleteguardrailglobals.mdx deleted file mode 100644 index 2d954559..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteGuardrailGlobals - TypeScript SDK -sidebarTitle: DeleteGuardrailGlobals -description: DeleteGuardrailGlobals type definition -seoTitle: DeleteGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteGuardrailGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailGlobals%20-%20TypeScript%20SDK&description=DeleteGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: DeleteGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/deleteguardrailrequest.mdx deleted file mode 100644 index a1d895bd..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteguardrailrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DeleteGuardrailRequest - TypeScript SDK -sidebarTitle: DeleteGuardrailRequest -description: DeleteGuardrailRequest type definition -seoTitle: DeleteGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteGuardrailRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailRequest%20-%20TypeScript%20SDK&description=DeleteGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deletekeysglobals.mdx b/client-sdks/typescript/api-reference/operations/deletekeysglobals.mdx deleted file mode 100644 index f35c8eee..00000000 --- a/client-sdks/typescript/api-reference/operations/deletekeysglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteKeysGlobals - TypeScript SDK -sidebarTitle: DeleteKeysGlobals -description: DeleteKeysGlobals type definition -seoTitle: DeleteKeysGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deletekeysglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteKeysGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysGlobals%20-%20TypeScript%20SDK&description=DeleteKeysGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteKeysGlobals } from "@openrouter/sdk/models/operations"; - -let value: DeleteKeysGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deletekeysrequest.mdx b/client-sdks/typescript/api-reference/operations/deletekeysrequest.mdx deleted file mode 100644 index 6940f342..00000000 --- a/client-sdks/typescript/api-reference/operations/deletekeysrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DeleteKeysRequest - TypeScript SDK -sidebarTitle: DeleteKeysRequest -description: DeleteKeysRequest type definition -seoTitle: DeleteKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deletekeysrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteKeysRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysRequest%20-%20TypeScript%20SDK&description=DeleteKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteKeysRequest = { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deletekeysresponse.mdx b/client-sdks/typescript/api-reference/operations/deletekeysresponse.mdx deleted file mode 100644 index bdcfb08f..00000000 --- a/client-sdks/typescript/api-reference/operations/deletekeysresponse.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: DeleteKeysResponse - TypeScript SDK -sidebarTitle: DeleteKeysResponse -description: DeleteKeysResponse type definition -seoTitle: DeleteKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deletekeysresponse -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteKeysResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysResponse%20-%20TypeScript%20SDK&description=DeleteKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key deleted successfully - -## Example Usage - -```typescript lines -import { DeleteKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: DeleteKeysResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationglobals.mdx b/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationglobals.mdx deleted file mode 100644 index 6c5f63ba..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteObservabilityDestinationGlobals - TypeScript SDK -sidebarTitle: DeleteObservabilityDestinationGlobals -description: DeleteObservabilityDestinationGlobals type definition -seoTitle: DeleteObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteObservabilityDestinationGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationGlobals%20-%20TypeScript%20SDK&description=DeleteObservabilityDestinationGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteObservabilityDestinationGlobals } from "@openrouter/sdk/models/operations"; - -let value: DeleteObservabilityDestinationGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationrequest.mdx deleted file mode 100644 index cab6dce6..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DeleteObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: DeleteObservabilityDestinationRequest -description: DeleteObservabilityDestinationRequest type definition -seoTitle: DeleteObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=DeleteObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteObservabilityDestinationRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteObservabilityDestinationRequest = { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteworkspaceglobals.mdx b/client-sdks/typescript/api-reference/operations/deleteworkspaceglobals.mdx deleted file mode 100644 index 278a48aa..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteworkspaceglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteWorkspaceGlobals - TypeScript SDK -sidebarTitle: DeleteWorkspaceGlobals -description: DeleteWorkspaceGlobals type definition -seoTitle: DeleteWorkspaceGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteWorkspaceGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceGlobals%20-%20TypeScript%20SDK&description=DeleteWorkspaceGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteWorkspaceGlobals } from "@openrouter/sdk/models/operations"; - -let value: DeleteWorkspaceGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/deleteworkspacerequest.mdx b/client-sdks/typescript/api-reference/operations/deleteworkspacerequest.mdx deleted file mode 100644 index 68b3d5f7..00000000 --- a/client-sdks/typescript/api-reference/operations/deleteworkspacerequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DeleteWorkspaceRequest - TypeScript SDK -sidebarTitle: DeleteWorkspaceRequest -description: DeleteWorkspaceRequest type definition -seoTitle: DeleteWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/deleteworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': DeleteWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - DeleteWorkspaceRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteWorkspaceRequest%20-%20TypeScript%20SDK&description=DeleteWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteWorkspaceRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteWorkspaceRequest = { - id: "production", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/document.mdx b/client-sdks/typescript/api-reference/operations/document.mdx deleted file mode 100644 index 3c6bddda..00000000 --- a/client-sdks/typescript/api-reference/operations/document.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Document - TypeScript SDK -sidebarTitle: Document -description: Document type definition -seoTitle: Document Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/document' -'og:site_name': OpenRouter Documentation -'og:title': Document Type | OpenRouter TypeScript SDK -'og:description': >- - Document type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Document%20-%20TypeScript%20SDK&description=Document%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The document object containing the original text - -## Example Usage - -```typescript lines -import { Document } from "@openrouter/sdk/models/operations"; - -let value: Document = { - text: "Paris is the capital of France.", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `text` | *string* | :heavy_check_mark: | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/embedding.mdx b/client-sdks/typescript/api-reference/operations/embedding.mdx deleted file mode 100644 index 21bbcb2b..00000000 --- a/client-sdks/typescript/api-reference/operations/embedding.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Embedding - TypeScript SDK -sidebarTitle: Embedding -description: Embedding type definition -seoTitle: Embedding Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/embedding' -'og:site_name': OpenRouter Documentation -'og:title': Embedding Type | OpenRouter TypeScript SDK -'og:description': >- - Embedding type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embedding%20-%20TypeScript%20SDK&description=Embedding%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Embedding vector as an array of floats or a base64 string - -## Supported Types - -### `number[]` - -```typescript lines -const value: number[] = [ - 0.0023064255, - -0.009327292, - 0.015797347, -]; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/encodingformat.mdx b/client-sdks/typescript/api-reference/operations/encodingformat.mdx deleted file mode 100644 index 708ee4f9..00000000 --- a/client-sdks/typescript/api-reference/operations/encodingformat.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: EncodingFormat - TypeScript SDK -sidebarTitle: EncodingFormat -description: EncodingFormat type definition -seoTitle: EncodingFormat Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/encodingformat -'og:site_name': OpenRouter Documentation -'og:title': EncodingFormat Type | OpenRouter TypeScript SDK -'og:description': >- - EncodingFormat type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EncodingFormat%20-%20TypeScript%20SDK&description=EncodingFormat%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The format of the output embeddings - -## Example Usage - -```typescript lines -import { EncodingFormat } from "@openrouter/sdk/models/operations"; - -let value: EncodingFormat = "float"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"float" | "base64" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx b/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx deleted file mode 100644 index 22037bd2..00000000 --- a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyCodeChallengeMethod - TypeScript SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod -description: ExchangeAuthCodeForAPIKeyCodeChallengeMethod type definition -seoTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/exchangeauthcodeforapikeycodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyCodeChallengeMethod Type | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyCodeChallengeMethod type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyCodeChallengeMethod } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyCodeChallengeMethod = "S256"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"S256" | "plain" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx b/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx deleted file mode 100644 index 156b098c..00000000 --- a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyGlobals - TypeScript SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyGlobals -description: ExchangeAuthCodeForAPIKeyGlobals type definition -seoTitle: ExchangeAuthCodeForAPIKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyglobals -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyGlobals%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx b/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx deleted file mode 100644 index 8d72aed2..00000000 --- a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequest - TypeScript SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyRequest -description: ExchangeAuthCodeForAPIKeyRequest type definition -seoTitle: ExchangeAuthCodeForAPIKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequest -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequest%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyRequest = { - requestBody: { - code: "auth_code_abc123def456", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequestbody) | :heavy_check_mark: | N/A | `{"code": "auth_code_abc123def456","code_challenge_method": "S256","code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx b/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx deleted file mode 100644 index 1e361321..00000000 --- a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequestBody - TypeScript SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyRequestBody -description: ExchangeAuthCodeForAPIKeyRequestBody type definition -seoTitle: ExchangeAuthCodeForAPIKeyRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyrequestbody -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequestBody type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequestBody%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyRequestBody } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyRequestBody = { - code: "auth_code_abc123def456", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *string* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx b/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx deleted file mode 100644 index 8fa7195d..00000000 --- a/client-sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyresponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyResponse - TypeScript SDK -sidebarTitle: ExchangeAuthCodeForAPIKeyResponse -description: ExchangeAuthCodeForAPIKeyResponse type definition -seoTitle: ExchangeAuthCodeForAPIKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/exchangeauthcodeforapikeyresponse -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyResponse%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Successfully exchanged code for an API key - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyResponse = { - key: - "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", - userId: "user_2yOPcMpKoQhcd4bVgSMlELRaIah", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `userId` | *string* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getbyokkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/getbyokkeyglobals.mdx deleted file mode 100644 index e655fd55..00000000 --- a/client-sdks/typescript/api-reference/operations/getbyokkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetBYOKKeyGlobals - TypeScript SDK -sidebarTitle: GetBYOKKeyGlobals -description: GetBYOKKeyGlobals type definition -seoTitle: GetBYOKKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getbyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetBYOKKeyGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyGlobals%20-%20TypeScript%20SDK&description=GetBYOKKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetBYOKKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetBYOKKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getbyokkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/getbyokkeyrequest.mdx deleted file mode 100644 index 84519639..00000000 --- a/client-sdks/typescript/api-reference/operations/getbyokkeyrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetBYOKKeyRequest - TypeScript SDK -sidebarTitle: GetBYOKKeyRequest -description: GetBYOKKeyRequest type definition -seoTitle: GetBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getbyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetBYOKKeyRequest%20-%20TypeScript%20SDK&description=GetBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetBYOKKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: GetBYOKKeyRequest = { - id: "11111111-2222-3333-4444-555555555555", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcreditsdata.mdx b/client-sdks/typescript/api-reference/operations/getcreditsdata.mdx deleted file mode 100644 index f8ebf63e..00000000 --- a/client-sdks/typescript/api-reference/operations/getcreditsdata.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: GetCreditsData - TypeScript SDK -sidebarTitle: GetCreditsData -description: GetCreditsData type definition -seoTitle: GetCreditsData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcreditsdata -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsData Type | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsData type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsData%20-%20TypeScript%20SDK&description=GetCreditsData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCreditsData } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsData = { - totalCredits: 100.5, - totalUsage: 25.75, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `totalCredits` | *number* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `totalUsage` | *number* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcreditsglobals.mdx b/client-sdks/typescript/api-reference/operations/getcreditsglobals.mdx deleted file mode 100644 index ed5c100f..00000000 --- a/client-sdks/typescript/api-reference/operations/getcreditsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetCreditsGlobals - TypeScript SDK -sidebarTitle: GetCreditsGlobals -description: GetCreditsGlobals type definition -seoTitle: GetCreditsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcreditsglobals -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsGlobals%20-%20TypeScript%20SDK&description=GetCreditsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCreditsGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcreditsrequest.mdx b/client-sdks/typescript/api-reference/operations/getcreditsrequest.mdx deleted file mode 100644 index 7f0156e6..00000000 --- a/client-sdks/typescript/api-reference/operations/getcreditsrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetCreditsRequest - TypeScript SDK -sidebarTitle: GetCreditsRequest -description: GetCreditsRequest type definition -seoTitle: GetCreditsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcreditsrequest -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsRequest%20-%20TypeScript%20SDK&description=GetCreditsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCreditsRequest } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcreditsresponse.mdx b/client-sdks/typescript/api-reference/operations/getcreditsresponse.mdx deleted file mode 100644 index 55b6d4ed..00000000 --- a/client-sdks/typescript/api-reference/operations/getcreditsresponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: GetCreditsResponse - TypeScript SDK -sidebarTitle: GetCreditsResponse -description: GetCreditsResponse type definition -seoTitle: GetCreditsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcreditsresponse -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsResponse%20-%20TypeScript%20SDK&description=GetCreditsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Total credits purchased and used - -## Example Usage - -```typescript lines -import { GetCreditsResponse } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsResponse = { - data: { - totalCredits: 100.5, - totalUsage: 25.75, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.GetCreditsData](/client-sdks/typescript/api-reference/operations/getcreditsdata) | :heavy_check_mark: | N/A | `{"total_credits": 100.5,"total_usage": 25.75}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcurrentkeydata.mdx b/client-sdks/typescript/api-reference/operations/getcurrentkeydata.mdx deleted file mode 100644 index 4a8b65e1..00000000 --- a/client-sdks/typescript/api-reference/operations/getcurrentkeydata.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: GetCurrentKeyData - TypeScript SDK -sidebarTitle: GetCurrentKeyData -description: GetCurrentKeyData type definition -seoTitle: GetCurrentKeyData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcurrentkeydata -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyData Type | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyData type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyData%20-%20TypeScript%20SDK&description=GetCurrentKeyData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Current API key information - -## Example Usage - -```typescript expandable lines -import { GetCurrentKeyData } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyData = { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - includeByokInLimit: false, - isFreeTier: false, - isManagementKey: false, - isProvisioningKey: false, - label: "sk-or-v1-au7...890", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - rateLimit: { - interval: "1h", - note: "This field is deprecated and safe to ignore.", - requests: 1000, - }, - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `isFreeTier` | *boolean* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `isManagementKey` | *boolean* | :heavy_check_mark: | Whether this is a management key | false | -| ~~`isProvisioningKey`~~ | *boolean* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| ~~`rateLimit`~~ | [operations.RateLimit](/client-sdks/typescript/api-reference/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` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcurrentkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/getcurrentkeyglobals.mdx deleted file mode 100644 index 351c91ba..00000000 --- a/client-sdks/typescript/api-reference/operations/getcurrentkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetCurrentKeyGlobals - TypeScript SDK -sidebarTitle: GetCurrentKeyGlobals -description: GetCurrentKeyGlobals type definition -seoTitle: GetCurrentKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcurrentkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyGlobals%20-%20TypeScript%20SDK&description=GetCurrentKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCurrentKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcurrentkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/getcurrentkeyrequest.mdx deleted file mode 100644 index 2995d9ca..00000000 --- a/client-sdks/typescript/api-reference/operations/getcurrentkeyrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetCurrentKeyRequest - TypeScript SDK -sidebarTitle: GetCurrentKeyRequest -description: GetCurrentKeyRequest type definition -seoTitle: GetCurrentKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcurrentkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyRequest%20-%20TypeScript%20SDK&description=GetCurrentKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCurrentKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getcurrentkeyresponse.mdx b/client-sdks/typescript/api-reference/operations/getcurrentkeyresponse.mdx deleted file mode 100644 index fbf716a3..00000000 --- a/client-sdks/typescript/api-reference/operations/getcurrentkeyresponse.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: GetCurrentKeyResponse - TypeScript SDK -sidebarTitle: GetCurrentKeyResponse -description: GetCurrentKeyResponse type definition -seoTitle: GetCurrentKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getcurrentkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyResponse%20-%20TypeScript%20SDK&description=GetCurrentKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key details - -## Example Usage - -```typescript expandable lines -import { GetCurrentKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyResponse = { - data: { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - includeByokInLimit: false, - isFreeTier: false, - isManagementKey: false, - isProvisioningKey: false, - label: "sk-or-v1-au7...890", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - rateLimit: { - interval: "1h", - note: "This field is deprecated and safe to ignore.", - requests: 1000, - }, - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetCurrentKeyData](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/getgenerationglobals.mdx b/client-sdks/typescript/api-reference/operations/getgenerationglobals.mdx deleted file mode 100644 index 129838a1..00000000 --- a/client-sdks/typescript/api-reference/operations/getgenerationglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetGenerationGlobals - TypeScript SDK -sidebarTitle: GetGenerationGlobals -description: GetGenerationGlobals type definition -seoTitle: GetGenerationGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getgenerationglobals -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetGenerationGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationGlobals%20-%20TypeScript%20SDK&description=GetGenerationGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGenerationGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetGenerationGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getgenerationrequest.mdx b/client-sdks/typescript/api-reference/operations/getgenerationrequest.mdx deleted file mode 100644 index c26149ed..00000000 --- a/client-sdks/typescript/api-reference/operations/getgenerationrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetGenerationRequest - TypeScript SDK -sidebarTitle: GetGenerationRequest -description: GetGenerationRequest type definition -seoTitle: GetGenerationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getgenerationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetGenerationRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationRequest%20-%20TypeScript%20SDK&description=GetGenerationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGenerationRequest } from "@openrouter/sdk/models/operations"; - -let value: GetGenerationRequest = { - id: "gen-1234567890", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/getguardrailglobals.mdx deleted file mode 100644 index 45309354..00000000 --- a/client-sdks/typescript/api-reference/operations/getguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetGuardrailGlobals - TypeScript SDK -sidebarTitle: GetGuardrailGlobals -description: GetGuardrailGlobals type definition -seoTitle: GetGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailGlobals%20-%20TypeScript%20SDK&description=GetGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/getguardrailrequest.mdx deleted file mode 100644 index 8b55b0d3..00000000 --- a/client-sdks/typescript/api-reference/operations/getguardrailrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetGuardrailRequest - TypeScript SDK -sidebarTitle: GetGuardrailRequest -description: GetGuardrailRequest type definition -seoTitle: GetGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailRequest%20-%20TypeScript%20SDK&description=GetGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getkeydata.mdx b/client-sdks/typescript/api-reference/operations/getkeydata.mdx deleted file mode 100644 index 6dbe2329..00000000 --- a/client-sdks/typescript/api-reference/operations/getkeydata.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: GetKeyData - TypeScript SDK -sidebarTitle: GetKeyData -description: GetKeyData type definition -seoTitle: GetKeyData Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/getkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyData Type | OpenRouter TypeScript SDK -'og:description': >- - GetKeyData type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyData%20-%20TypeScript%20SDK&description=GetKeyData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The API key information - -## Example Usage - -```typescript expandable lines -import { GetKeyData } from "@openrouter/sdk/models/operations"; - -let value: GetKeyData = { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "sk-or-v1-0e6...1c96", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/getkeyglobals.mdx deleted file mode 100644 index 48e36d02..00000000 --- a/client-sdks/typescript/api-reference/operations/getkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetKeyGlobals - TypeScript SDK -sidebarTitle: GetKeyGlobals -description: GetKeyGlobals type definition -seoTitle: GetKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetKeyGlobals type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyGlobals%20-%20TypeScript%20SDK&description=GetKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/getkeyrequest.mdx deleted file mode 100644 index 6e0590a8..00000000 --- a/client-sdks/typescript/api-reference/operations/getkeyrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetKeyRequest - TypeScript SDK -sidebarTitle: GetKeyRequest -description: GetKeyRequest type definition -seoTitle: GetKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetKeyRequest type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyRequest%20-%20TypeScript%20SDK&description=GetKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: GetKeyRequest = { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getkeyresponse.mdx b/client-sdks/typescript/api-reference/operations/getkeyresponse.mdx deleted file mode 100644 index 233a7756..00000000 --- a/client-sdks/typescript/api-reference/operations/getkeyresponse.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: GetKeyResponse - TypeScript SDK -sidebarTitle: GetKeyResponse -description: GetKeyResponse type definition -seoTitle: GetKeyResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getkeyresponse -'og:site_name': OpenRouter Documentation -'og:title': GetKeyResponse Type | OpenRouter TypeScript SDK -'og:description': >- - GetKeyResponse type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyResponse%20-%20TypeScript%20SDK&description=GetKeyResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key details - -## Example Usage - -```typescript expandable lines -import { GetKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: GetKeyResponse = { - data: { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "Production API Key", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.GetKeyData](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/getmodelsglobals.mdx b/client-sdks/typescript/api-reference/operations/getmodelsglobals.mdx deleted file mode 100644 index 52fd4ebb..00000000 --- a/client-sdks/typescript/api-reference/operations/getmodelsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetModelsGlobals - TypeScript SDK -sidebarTitle: GetModelsGlobals -description: GetModelsGlobals type definition -seoTitle: GetModelsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': GetModelsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetModelsGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsGlobals%20-%20TypeScript%20SDK&description=GetModelsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetModelsGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetModelsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getmodelsrequest.mdx b/client-sdks/typescript/api-reference/operations/getmodelsrequest.mdx deleted file mode 100644 index 9b283851..00000000 --- a/client-sdks/typescript/api-reference/operations/getmodelsrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetModelsRequest - TypeScript SDK -sidebarTitle: GetModelsRequest -description: GetModelsRequest type definition -seoTitle: GetModelsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': GetModelsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetModelsRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsRequest%20-%20TypeScript%20SDK&description=GetModelsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetModelsRequest } from "@openrouter/sdk/models/operations"; - -let value: GetModelsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [operations.Category](/client-sdks/typescript/api-reference/operations/category) | :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 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getobservabilitydestinationglobals.mdx b/client-sdks/typescript/api-reference/operations/getobservabilitydestinationglobals.mdx deleted file mode 100644 index 996d107f..00000000 --- a/client-sdks/typescript/api-reference/operations/getobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetObservabilityDestinationGlobals - TypeScript SDK -sidebarTitle: GetObservabilityDestinationGlobals -description: GetObservabilityDestinationGlobals type definition -seoTitle: GetObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetObservabilityDestinationGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationGlobals%20-%20TypeScript%20SDK&description=GetObservabilityDestinationGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetObservabilityDestinationGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetObservabilityDestinationGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/operations/getobservabilitydestinationrequest.mdx deleted file mode 100644 index 16d2721e..00000000 --- a/client-sdks/typescript/api-reference/operations/getobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: GetObservabilityDestinationRequest -description: GetObservabilityDestinationRequest type definition -seoTitle: GetObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': GetObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=GetObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetObservabilityDestinationRequest } from "@openrouter/sdk/models/operations"; - -let value: GetObservabilityDestinationRequest = { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getrankingsdailyglobals.mdx b/client-sdks/typescript/api-reference/operations/getrankingsdailyglobals.mdx deleted file mode 100644 index 537ed234..00000000 --- a/client-sdks/typescript/api-reference/operations/getrankingsdailyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetRankingsDailyGlobals - TypeScript SDK -sidebarTitle: GetRankingsDailyGlobals -description: GetRankingsDailyGlobals type definition -seoTitle: GetRankingsDailyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getrankingsdailyglobals -'og:site_name': OpenRouter Documentation -'og:title': GetRankingsDailyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetRankingsDailyGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetRankingsDailyGlobals%20-%20TypeScript%20SDK&description=GetRankingsDailyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetRankingsDailyGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetRankingsDailyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getrankingsdailyrequest.mdx b/client-sdks/typescript/api-reference/operations/getrankingsdailyrequest.mdx deleted file mode 100644 index 50969f97..00000000 --- a/client-sdks/typescript/api-reference/operations/getrankingsdailyrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: GetRankingsDailyRequest - TypeScript SDK -sidebarTitle: GetRankingsDailyRequest -description: GetRankingsDailyRequest type definition -seoTitle: GetRankingsDailyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getrankingsdailyrequest -'og:site_name': OpenRouter Documentation -'og:title': GetRankingsDailyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetRankingsDailyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetRankingsDailyRequest%20-%20TypeScript%20SDK&description=GetRankingsDailyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetRankingsDailyRequest } from "@openrouter/sdk/models/operations"; - -let value: GetRankingsDailyRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `startDate` | *string* | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `endDate` | *string* | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getuseractivityglobals.mdx b/client-sdks/typescript/api-reference/operations/getuseractivityglobals.mdx deleted file mode 100644 index a44ab722..00000000 --- a/client-sdks/typescript/api-reference/operations/getuseractivityglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetUserActivityGlobals - TypeScript SDK -sidebarTitle: GetUserActivityGlobals -description: GetUserActivityGlobals type definition -seoTitle: GetUserActivityGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getuseractivityglobals -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetUserActivityGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityGlobals%20-%20TypeScript%20SDK&description=GetUserActivityGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetUserActivityGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetUserActivityGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getuseractivityrequest.mdx b/client-sdks/typescript/api-reference/operations/getuseractivityrequest.mdx deleted file mode 100644 index 27457c18..00000000 --- a/client-sdks/typescript/api-reference/operations/getuseractivityrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetUserActivityRequest - TypeScript SDK -sidebarTitle: GetUserActivityRequest -description: GetUserActivityRequest type definition -seoTitle: GetUserActivityRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getuseractivityrequest -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetUserActivityRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityRequest%20-%20TypeScript%20SDK&description=GetUserActivityRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetUserActivityRequest } from "@openrouter/sdk/models/operations"; - -let value: GetUserActivityRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date` | *string* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `apiKeyHash` | *string* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `userId` | *string* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getvideosglobals.mdx b/client-sdks/typescript/api-reference/operations/getvideosglobals.mdx deleted file mode 100644 index 7d563cd4..00000000 --- a/client-sdks/typescript/api-reference/operations/getvideosglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetVideosGlobals - TypeScript SDK -sidebarTitle: GetVideosGlobals -description: GetVideosGlobals type definition -seoTitle: GetVideosGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getvideosglobals -'og:site_name': OpenRouter Documentation -'og:title': GetVideosGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetVideosGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetVideosGlobals%20-%20TypeScript%20SDK&description=GetVideosGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetVideosGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetVideosGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getvideosrequest.mdx b/client-sdks/typescript/api-reference/operations/getvideosrequest.mdx deleted file mode 100644 index 88a1ae6a..00000000 --- a/client-sdks/typescript/api-reference/operations/getvideosrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetVideosRequest - TypeScript SDK -sidebarTitle: GetVideosRequest -description: GetVideosRequest type definition -seoTitle: GetVideosRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getvideosrequest -'og:site_name': OpenRouter Documentation -'og:title': GetVideosRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetVideosRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetVideosRequest%20-%20TypeScript%20SDK&description=GetVideosRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetVideosRequest } from "@openrouter/sdk/models/operations"; - -let value: GetVideosRequest = { - jobId: "job-abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `jobId` | *string* | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getworkspaceglobals.mdx b/client-sdks/typescript/api-reference/operations/getworkspaceglobals.mdx deleted file mode 100644 index 575ae33a..00000000 --- a/client-sdks/typescript/api-reference/operations/getworkspaceglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetWorkspaceGlobals - TypeScript SDK -sidebarTitle: GetWorkspaceGlobals -description: GetWorkspaceGlobals type definition -seoTitle: GetWorkspaceGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - GetWorkspaceGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceGlobals%20-%20TypeScript%20SDK&description=GetWorkspaceGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetWorkspaceGlobals } from "@openrouter/sdk/models/operations"; - -let value: GetWorkspaceGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/getworkspacerequest.mdx b/client-sdks/typescript/api-reference/operations/getworkspacerequest.mdx deleted file mode 100644 index 9cb05aa5..00000000 --- a/client-sdks/typescript/api-reference/operations/getworkspacerequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetWorkspaceRequest - TypeScript SDK -sidebarTitle: GetWorkspaceRequest -description: GetWorkspaceRequest type definition -seoTitle: GetWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/getworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': GetWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - GetWorkspaceRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetWorkspaceRequest%20-%20TypeScript%20SDK&description=GetWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetWorkspaceRequest } from "@openrouter/sdk/models/operations"; - -let value: GetWorkspaceRequest = { - id: "production", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/headquarters.mdx b/client-sdks/typescript/api-reference/operations/headquarters.mdx deleted file mode 100644 index ef06288a..00000000 --- a/client-sdks/typescript/api-reference/operations/headquarters.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Headquarters - TypeScript SDK -sidebarTitle: Headquarters -description: Headquarters type definition -seoTitle: Headquarters Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/headquarters -'og:site_name': OpenRouter Documentation -'og:title': Headquarters Type | OpenRouter TypeScript SDK -'og:description': >- - Headquarters type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Headquarters%20-%20TypeScript%20SDK&description=Headquarters%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -ISO 3166-1 Alpha-2 country code of the provider headquarters - -## Example Usage - -```typescript lines -import { Headquarters } from "@openrouter/sdk/models/operations"; - -let value: Headquarters = "US"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/imageurl.mdx b/client-sdks/typescript/api-reference/operations/imageurl.mdx deleted file mode 100644 index 8fc6bd47..00000000 --- a/client-sdks/typescript/api-reference/operations/imageurl.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ImageUrl - TypeScript SDK -sidebarTitle: ImageUrl -description: ImageUrl type definition -seoTitle: ImageUrl Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageUrl Type | OpenRouter TypeScript SDK -'og:description': >- - ImageUrl type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageUrl%20-%20TypeScript%20SDK&description=ImageUrl%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageUrl } from "@openrouter/sdk/models/operations"; - -let value: ImageUrl = { - url: "https://sinful-meal.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/input.mdx b/client-sdks/typescript/api-reference/operations/input.mdx deleted file mode 100644 index 83b78ee6..00000000 --- a/client-sdks/typescript/api-reference/operations/input.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Input - TypeScript SDK -sidebarTitle: Input -description: Input type definition -seoTitle: Input Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/input' -'og:site_name': OpenRouter Documentation -'og:title': Input Type | OpenRouter TypeScript SDK -'og:description': >- - Input type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input%20-%20TypeScript%20SDK&description=Input%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Input } from "@openrouter/sdk/models/operations"; - -let value: Input = { - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `content` | *operations.Content*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/inputunion.mdx b/client-sdks/typescript/api-reference/operations/inputunion.mdx deleted file mode 100644 index 6ad587a0..00000000 --- a/client-sdks/typescript/api-reference/operations/inputunion.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: InputUnion - TypeScript SDK -sidebarTitle: InputUnion -description: InputUnion type definition -seoTitle: InputUnion Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion Type | OpenRouter TypeScript SDK -'og:description': >- - InputUnion type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20TypeScript%20SDK&description=InputUnion%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text, token, or multimodal input(s) to embed - -## Supported Types - -### `string` - -```typescript lines -const value: string = "The quick brown fox jumps over the lazy dog"; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` - -### `number[]` - -```typescript lines -const value: number[] = [ - 3390.48, - 1336.21, - 9437.99, -]; -``` - -### `number[][]` - -```typescript lines -const value: number[][] = [ - [ - 6206.15, - ], - [ - 8419.72, - 5863.71, - ], - [ - 2540.22, - ], -]; -``` - -### `operations.Input[]` - -```typescript lines -const value: operations.Input[] = [ - { - content: [], - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listbyokkeysglobals.mdx b/client-sdks/typescript/api-reference/operations/listbyokkeysglobals.mdx deleted file mode 100644 index 23718baa..00000000 --- a/client-sdks/typescript/api-reference/operations/listbyokkeysglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListBYOKKeysGlobals - TypeScript SDK -sidebarTitle: ListBYOKKeysGlobals -description: ListBYOKKeysGlobals type definition -seoTitle: ListBYOKKeysGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listbyokkeysglobals -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListBYOKKeysGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysGlobals%20-%20TypeScript%20SDK&description=ListBYOKKeysGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListBYOKKeysGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListBYOKKeysGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listbyokkeysrequest.mdx b/client-sdks/typescript/api-reference/operations/listbyokkeysrequest.mdx deleted file mode 100644 index 60936f2d..00000000 --- a/client-sdks/typescript/api-reference/operations/listbyokkeysrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ListBYOKKeysRequest - TypeScript SDK -sidebarTitle: ListBYOKKeysRequest -description: ListBYOKKeysRequest type definition -seoTitle: ListBYOKKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listbyokkeysrequest -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListBYOKKeysRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysRequest%20-%20TypeScript%20SDK&description=ListBYOKKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListBYOKKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: ListBYOKKeysRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [operations.Provider](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/listbyokkeysresponse.mdx b/client-sdks/typescript/api-reference/operations/listbyokkeysresponse.mdx deleted file mode 100644 index 8ec28641..00000000 --- a/client-sdks/typescript/api-reference/operations/listbyokkeysresponse.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: ListBYOKKeysResponse - TypeScript SDK -sidebarTitle: ListBYOKKeysResponse -description: ListBYOKKeysResponse type definition -seoTitle: ListBYOKKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listbyokkeysresponse -'og:site_name': OpenRouter Documentation -'og:title': ListBYOKKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListBYOKKeysResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListBYOKKeysResponse%20-%20TypeScript%20SDK&description=ListBYOKKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListBYOKKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: ListBYOKKeysResponse = { - result: { - data: [ - { - allowedApiKeyHashes: null, - allowedModels: null, - allowedUserIds: null, - createdAt: "2025-08-24T10:30:00Z", - disabled: false, - id: "11111111-2222-3333-4444-555555555555", - isFallback: false, - label: "sk-...AbCd", - provider: "openai", - sortOrder: 0, - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListBYOKKeysResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listdata.mdx b/client-sdks/typescript/api-reference/operations/listdata.mdx deleted file mode 100644 index 4d880667..00000000 --- a/client-sdks/typescript/api-reference/operations/listdata.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: ListData - TypeScript SDK -sidebarTitle: ListData -description: ListData type definition -seoTitle: ListData Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/listdata' -'og:site_name': OpenRouter Documentation -'og:title': ListData Type | OpenRouter TypeScript SDK -'og:description': >- - ListData type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListData%20-%20TypeScript%20SDK&description=ListData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListData } from "@openrouter/sdk/models/operations"; - -let value: ListData = { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "sk-or-v1-0e6...1c96", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listembeddingsmodelsglobals.mdx b/client-sdks/typescript/api-reference/operations/listembeddingsmodelsglobals.mdx deleted file mode 100644 index bdf4b523..00000000 --- a/client-sdks/typescript/api-reference/operations/listembeddingsmodelsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEmbeddingsModelsGlobals - TypeScript SDK -sidebarTitle: ListEmbeddingsModelsGlobals -description: ListEmbeddingsModelsGlobals type definition -seoTitle: ListEmbeddingsModelsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listembeddingsmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEmbeddingsModelsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListEmbeddingsModelsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEmbeddingsModelsGlobals%20-%20TypeScript%20SDK&description=ListEmbeddingsModelsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEmbeddingsModelsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListEmbeddingsModelsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listembeddingsmodelsrequest.mdx b/client-sdks/typescript/api-reference/operations/listembeddingsmodelsrequest.mdx deleted file mode 100644 index d3f6256a..00000000 --- a/client-sdks/typescript/api-reference/operations/listembeddingsmodelsrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEmbeddingsModelsRequest - TypeScript SDK -sidebarTitle: ListEmbeddingsModelsRequest -description: ListEmbeddingsModelsRequest type definition -seoTitle: ListEmbeddingsModelsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listembeddingsmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEmbeddingsModelsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListEmbeddingsModelsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEmbeddingsModelsRequest%20-%20TypeScript%20SDK&description=ListEmbeddingsModelsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEmbeddingsModelsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListEmbeddingsModelsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listendpointsglobals.mdx b/client-sdks/typescript/api-reference/operations/listendpointsglobals.mdx deleted file mode 100644 index 4493a5d7..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEndpointsGlobals - TypeScript SDK -sidebarTitle: ListEndpointsGlobals -description: ListEndpointsGlobals type definition -seoTitle: ListEndpointsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsGlobals%20-%20TypeScript%20SDK&description=ListEndpointsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEndpointsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listendpointsrequest.mdx b/client-sdks/typescript/api-reference/operations/listendpointsrequest.mdx deleted file mode 100644 index 5c20f8f2..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointsrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ListEndpointsRequest - TypeScript SDK -sidebarTitle: ListEndpointsRequest -description: ListEndpointsRequest type definition -seoTitle: ListEndpointsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsRequest%20-%20TypeScript%20SDK&description=ListEndpointsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEndpointsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsRequest = { - author: "openai", - slug: "gpt-4", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *string* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *string* | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listendpointsresponse.mdx b/client-sdks/typescript/api-reference/operations/listendpointsresponse.mdx deleted file mode 100644 index be519b32..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointsresponse.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: ListEndpointsResponse - TypeScript SDK -sidebarTitle: ListEndpointsResponse -description: ListEndpointsResponse type definition -seoTitle: ListEndpointsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20TypeScript%20SDK&description=ListEndpointsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Example Usage - -```typescript expandable lines -import { ListEndpointsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsResponse = { - data: { - architecture: { - inputModalities: [ - "text", - ], - instructType: "chatml", - modality: "text->text", - outputModalities: [ - "text", - ], - tokenizer: "GPT", - }, - created: 1692901234, - description: - "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", - endpoints: [ - { - contextLength: 8192, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - modelId: "openai/gpt-4", - modelName: "GPT-4", - name: "OpenAI: GPT-4", - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - providerName: "OpenAI", - quantization: "fp16", - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - supportsImplicitCaching: true, - tag: "openai", - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - uptimeLast1d: 99.8, - uptimeLast30m: 99.5, - uptimeLast5m: 100, - }, - ], - id: "openai/gpt-4", - name: "GPT-4", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ListEndpointsResponse](/client-sdks/typescript/api-reference/models/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_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": `{"completion": "0.00006","image": "0","prompt": "0.00003","request": "0"}`,
"provider_name": "OpenAI",
"quantization": "fp16",
"status": "default",
"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/client-sdks/typescript/api-reference/operations/listendpointszdrglobals.mdx b/client-sdks/typescript/api-reference/operations/listendpointszdrglobals.mdx deleted file mode 100644 index afa5c48a..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointszdrglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEndpointsZdrGlobals - TypeScript SDK -sidebarTitle: ListEndpointsZdrGlobals -description: ListEndpointsZdrGlobals type definition -seoTitle: ListEndpointsZdrGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointszdrglobals -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsZdrGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrGlobals%20-%20TypeScript%20SDK&description=ListEndpointsZdrGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEndpointsZdrGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsZdrGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listendpointszdrrequest.mdx b/client-sdks/typescript/api-reference/operations/listendpointszdrrequest.mdx deleted file mode 100644 index 12ed28db..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointszdrrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEndpointsZdrRequest - TypeScript SDK -sidebarTitle: ListEndpointsZdrRequest -description: ListEndpointsZdrRequest type definition -seoTitle: ListEndpointsZdrRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointszdrrequest -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsZdrRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrRequest%20-%20TypeScript%20SDK&description=ListEndpointsZdrRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEndpointsZdrRequest } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsZdrRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listendpointszdrresponse.mdx b/client-sdks/typescript/api-reference/operations/listendpointszdrresponse.mdx deleted file mode 100644 index f540b6f4..00000000 --- a/client-sdks/typescript/api-reference/operations/listendpointszdrresponse.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: ListEndpointsZdrResponse - TypeScript SDK -sidebarTitle: ListEndpointsZdrResponse -description: ListEndpointsZdrResponse type definition -seoTitle: ListEndpointsZdrResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listendpointszdrresponse -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsZdrResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrResponse%20-%20TypeScript%20SDK&description=ListEndpointsZdrResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Example Usage - -```typescript expandable lines -import { ListEndpointsZdrResponse } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsZdrResponse = { - data: [ - { - contextLength: 8192, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - modelId: "openai/gpt-4", - modelName: "GPT-4", - name: "OpenAI: GPT-4", - pricing: { - completion: "0.00006", - prompt: "0.00003", - }, - providerName: "OpenAI", - quantization: "fp16", - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - supportsImplicitCaching: true, - tag: "openai", - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - uptimeLast1d: 99.8, - uptimeLast30m: 99.5, - uptimeLast5m: 100, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `data` | [models.PublicEndpoint](/client-sdks/typescript/api-reference/models/publicendpoint)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listgenerationcontentglobals.mdx b/client-sdks/typescript/api-reference/operations/listgenerationcontentglobals.mdx deleted file mode 100644 index 31c5c011..00000000 --- a/client-sdks/typescript/api-reference/operations/listgenerationcontentglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListGenerationContentGlobals - TypeScript SDK -sidebarTitle: ListGenerationContentGlobals -description: ListGenerationContentGlobals type definition -seoTitle: ListGenerationContentGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listgenerationcontentglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGenerationContentGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListGenerationContentGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGenerationContentGlobals%20-%20TypeScript%20SDK&description=ListGenerationContentGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGenerationContentGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListGenerationContentGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listgenerationcontentrequest.mdx b/client-sdks/typescript/api-reference/operations/listgenerationcontentrequest.mdx deleted file mode 100644 index 0a565f57..00000000 --- a/client-sdks/typescript/api-reference/operations/listgenerationcontentrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListGenerationContentRequest - TypeScript SDK -sidebarTitle: ListGenerationContentRequest -description: ListGenerationContentRequest type definition -seoTitle: ListGenerationContentRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listgenerationcontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGenerationContentRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListGenerationContentRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGenerationContentRequest%20-%20TypeScript%20SDK&description=ListGenerationContentRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGenerationContentRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGenerationContentRequest = { - id: "gen-1234567890", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listglobals.mdx b/client-sdks/typescript/api-reference/operations/listglobals.mdx deleted file mode 100644 index 961ab58b..00000000 --- a/client-sdks/typescript/api-reference/operations/listglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListGlobals - TypeScript SDK -sidebarTitle: ListGlobals -description: ListGlobals type definition -seoTitle: ListGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListGlobals type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGlobals%20-%20TypeScript%20SDK&description=ListGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsglobals.mdx b/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsglobals.mdx deleted file mode 100644 index 4dce5524..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsGlobals - TypeScript SDK -sidebarTitle: ListGuardrailKeyAssignmentsGlobals -description: ListGuardrailKeyAssignmentsGlobals type definition -seoTitle: ListGuardrailKeyAssignmentsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailkeyassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsGlobals%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsrequest.mdx b/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsrequest.mdx deleted file mode 100644 index 5a71b443..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsRequest - TypeScript SDK -sidebarTitle: ListGuardrailKeyAssignmentsRequest -description: ListGuardrailKeyAssignmentsRequest type definition -seoTitle: ListGuardrailKeyAssignmentsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsRequest%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsresponse.mdx b/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsresponse.mdx deleted file mode 100644 index ffe66d80..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailkeyassignmentsresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsResponse - TypeScript SDK -sidebarTitle: ListGuardrailKeyAssignmentsResponse -description: ListGuardrailKeyAssignmentsResponse type definition -seoTitle: ListGuardrailKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsResponse%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsResponse = { - result: { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - keyLabel: "prod-key", - keyName: "Production Key", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsglobals.mdx b/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsglobals.mdx deleted file mode 100644 index 1ad08233..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsGlobals - TypeScript SDK -sidebarTitle: ListGuardrailMemberAssignmentsGlobals -description: ListGuardrailMemberAssignmentsGlobals type definition -seoTitle: ListGuardrailMemberAssignmentsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailmemberassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsGlobals%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsrequest.mdx b/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsrequest.mdx deleted file mode 100644 index 24aca1ba..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsRequest - TypeScript SDK -sidebarTitle: ListGuardrailMemberAssignmentsRequest -description: ListGuardrailMemberAssignmentsRequest type definition -seoTitle: ListGuardrailMemberAssignmentsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsRequest%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsresponse.mdx b/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsresponse.mdx deleted file mode 100644 index 39ec4904..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailmemberassignmentsresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsResponse - TypeScript SDK -sidebarTitle: ListGuardrailMemberAssignmentsResponse -description: ListGuardrailMemberAssignmentsResponse type definition -seoTitle: ListGuardrailMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsResponse%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsResponse = { - result: { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - organizationId: "org_xyz789", - userId: "user_abc123", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listguardrailsglobals.mdx b/client-sdks/typescript/api-reference/operations/listguardrailsglobals.mdx deleted file mode 100644 index c217d637..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListGuardrailsGlobals - TypeScript SDK -sidebarTitle: ListGuardrailsGlobals -description: ListGuardrailsGlobals type definition -seoTitle: ListGuardrailsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsGlobals%20-%20TypeScript%20SDK&description=ListGuardrailsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailsrequest.mdx b/client-sdks/typescript/api-reference/operations/listguardrailsrequest.mdx deleted file mode 100644 index 3a31a7b6..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailsrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListGuardrailsRequest - TypeScript SDK -sidebarTitle: ListGuardrailsRequest -description: ListGuardrailsRequest type definition -seoTitle: ListGuardrailsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsRequest%20-%20TypeScript%20SDK&description=ListGuardrailsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listguardrailsresponse.mdx b/client-sdks/typescript/api-reference/operations/listguardrailsresponse.mdx deleted file mode 100644 index 81368676..00000000 --- a/client-sdks/typescript/api-reference/operations/listguardrailsresponse.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ListGuardrailsResponse - TypeScript SDK -sidebarTitle: ListGuardrailsResponse -description: ListGuardrailsResponse type definition -seoTitle: ListGuardrailsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listguardrailsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20TypeScript%20SDK&description=ListGuardrailsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsResponse = { - result: { - data: [ - { - createdAt: "2025-08-24T10:30:00Z", - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListGuardrailsResponse](/client-sdks/typescript/api-reference/models/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,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"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/client-sdks/typescript/api-reference/operations/listkeyassignmentsglobals.mdx b/client-sdks/typescript/api-reference/operations/listkeyassignmentsglobals.mdx deleted file mode 100644 index d29f1795..00000000 --- a/client-sdks/typescript/api-reference/operations/listkeyassignmentsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListKeyAssignmentsGlobals - TypeScript SDK -sidebarTitle: ListKeyAssignmentsGlobals -description: ListKeyAssignmentsGlobals type definition -seoTitle: ListKeyAssignmentsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listkeyassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsGlobals%20-%20TypeScript%20SDK&description=ListKeyAssignmentsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listkeyassignmentsrequest.mdx b/client-sdks/typescript/api-reference/operations/listkeyassignmentsrequest.mdx deleted file mode 100644 index d70cb051..00000000 --- a/client-sdks/typescript/api-reference/operations/listkeyassignmentsrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ListKeyAssignmentsRequest - TypeScript SDK -sidebarTitle: ListKeyAssignmentsRequest -description: ListKeyAssignmentsRequest type definition -seoTitle: ListKeyAssignmentsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsRequest%20-%20TypeScript%20SDK&description=ListKeyAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listkeyassignmentsresponse.mdx b/client-sdks/typescript/api-reference/operations/listkeyassignmentsresponse.mdx deleted file mode 100644 index 56d72442..00000000 --- a/client-sdks/typescript/api-reference/operations/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - TypeScript SDK -sidebarTitle: ListKeyAssignmentsResponse -description: ListKeyAssignmentsResponse type definition -seoTitle: ListKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20TypeScript%20SDK&description=ListKeyAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsResponse = { - result: { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - keyLabel: "prod-key", - keyName: "Production Key", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listmemberassignmentsglobals.mdx b/client-sdks/typescript/api-reference/operations/listmemberassignmentsglobals.mdx deleted file mode 100644 index b718512c..00000000 --- a/client-sdks/typescript/api-reference/operations/listmemberassignmentsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListMemberAssignmentsGlobals - TypeScript SDK -sidebarTitle: ListMemberAssignmentsGlobals -description: ListMemberAssignmentsGlobals type definition -seoTitle: ListMemberAssignmentsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmemberassignmentsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsGlobals%20-%20TypeScript%20SDK&description=ListMemberAssignmentsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmemberassignmentsrequest.mdx b/client-sdks/typescript/api-reference/operations/listmemberassignmentsrequest.mdx deleted file mode 100644 index fd9e2370..00000000 --- a/client-sdks/typescript/api-reference/operations/listmemberassignmentsrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ListMemberAssignmentsRequest - TypeScript SDK -sidebarTitle: ListMemberAssignmentsRequest -description: ListMemberAssignmentsRequest type definition -seoTitle: ListMemberAssignmentsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsRequest%20-%20TypeScript%20SDK&description=ListMemberAssignmentsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmemberassignmentsresponse.mdx b/client-sdks/typescript/api-reference/operations/listmemberassignmentsresponse.mdx deleted file mode 100644 index 9edff276..00000000 --- a/client-sdks/typescript/api-reference/operations/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - TypeScript SDK -sidebarTitle: ListMemberAssignmentsResponse -description: ListMemberAssignmentsResponse type definition -seoTitle: ListMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20TypeScript%20SDK&description=ListMemberAssignmentsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsResponse = { - result: { - data: [ - { - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - id: "550e8400-e29b-41d4-a716-446655440000", - organizationId: "org_xyz789", - userId: "user_abc123", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listmodelscountglobals.mdx b/client-sdks/typescript/api-reference/operations/listmodelscountglobals.mdx deleted file mode 100644 index 2808ac57..00000000 --- a/client-sdks/typescript/api-reference/operations/listmodelscountglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListModelsCountGlobals - TypeScript SDK -sidebarTitle: ListModelsCountGlobals -description: ListModelsCountGlobals type definition -seoTitle: ListModelsCountGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmodelscountglobals -'og:site_name': OpenRouter Documentation -'og:title': ListModelsCountGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListModelsCountGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsCountGlobals%20-%20TypeScript%20SDK&description=ListModelsCountGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsCountGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListModelsCountGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmodelscountrequest.mdx b/client-sdks/typescript/api-reference/operations/listmodelscountrequest.mdx deleted file mode 100644 index ff38dd4e..00000000 --- a/client-sdks/typescript/api-reference/operations/listmodelscountrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ListModelsCountRequest - TypeScript SDK -sidebarTitle: ListModelsCountRequest -description: ListModelsCountRequest type definition -seoTitle: ListModelsCountRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmodelscountrequest -'og:site_name': OpenRouter Documentation -'og:title': ListModelsCountRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListModelsCountRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsCountRequest%20-%20TypeScript%20SDK&description=ListModelsCountRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsCountRequest } from "@openrouter/sdk/models/operations"; - -let value: ListModelsCountRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `outputModalities` | *string* | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmodelsuserglobals.mdx b/client-sdks/typescript/api-reference/operations/listmodelsuserglobals.mdx deleted file mode 100644 index 60b67fdb..00000000 --- a/client-sdks/typescript/api-reference/operations/listmodelsuserglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListModelsUserGlobals - TypeScript SDK -sidebarTitle: ListModelsUserGlobals -description: ListModelsUserGlobals type definition -seoTitle: ListModelsUserGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmodelsuserglobals -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListModelsUserGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserGlobals%20-%20TypeScript%20SDK&description=ListModelsUserGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsUserGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListModelsUserGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmodelsuserrequest.mdx b/client-sdks/typescript/api-reference/operations/listmodelsuserrequest.mdx deleted file mode 100644 index ec0fd308..00000000 --- a/client-sdks/typescript/api-reference/operations/listmodelsuserrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListModelsUserRequest - TypeScript SDK -sidebarTitle: ListModelsUserRequest -description: ListModelsUserRequest type definition -seoTitle: ListModelsUserRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmodelsuserrequest -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListModelsUserRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserRequest%20-%20TypeScript%20SDK&description=ListModelsUserRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsUserRequest } from "@openrouter/sdk/models/operations"; - -let value: ListModelsUserRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listmodelsusersecurity.mdx b/client-sdks/typescript/api-reference/operations/listmodelsusersecurity.mdx deleted file mode 100644 index ce84bf46..00000000 --- a/client-sdks/typescript/api-reference/operations/listmodelsusersecurity.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListModelsUserSecurity - TypeScript SDK -sidebarTitle: ListModelsUserSecurity -description: ListModelsUserSecurity type definition -seoTitle: ListModelsUserSecurity Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listmodelsusersecurity -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserSecurity Type | OpenRouter TypeScript SDK -'og:description': >- - ListModelsUserSecurity type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserSecurity%20-%20TypeScript%20SDK&description=ListModelsUserSecurity%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsUserSecurity } from "@openrouter/sdk/models/operations"; - -let value: ListModelsUserSecurity = { - bearer: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsglobals.mdx b/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsglobals.mdx deleted file mode 100644 index 1fb49d6d..00000000 --- a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListObservabilityDestinationsGlobals - TypeScript SDK -sidebarTitle: ListObservabilityDestinationsGlobals -description: ListObservabilityDestinationsGlobals type definition -seoTitle: ListObservabilityDestinationsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listobservabilitydestinationsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListObservabilityDestinationsGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsGlobals%20-%20TypeScript%20SDK&description=ListObservabilityDestinationsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListObservabilityDestinationsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListObservabilityDestinationsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsrequest.mdx b/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsrequest.mdx deleted file mode 100644 index 58a5f024..00000000 --- a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListObservabilityDestinationsRequest - TypeScript SDK -sidebarTitle: ListObservabilityDestinationsRequest -description: ListObservabilityDestinationsRequest type definition -seoTitle: ListObservabilityDestinationsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listobservabilitydestinationsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListObservabilityDestinationsRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsRequest%20-%20TypeScript%20SDK&description=ListObservabilityDestinationsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListObservabilityDestinationsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListObservabilityDestinationsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsresponse.mdx b/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsresponse.mdx deleted file mode 100644 index 6f5faea5..00000000 --- a/client-sdks/typescript/api-reference/operations/listobservabilitydestinationsresponse.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: ListObservabilityDestinationsResponse - TypeScript SDK -sidebarTitle: ListObservabilityDestinationsResponse -description: ListObservabilityDestinationsResponse type definition -seoTitle: ListObservabilityDestinationsResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listobservabilitydestinationsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListObservabilityDestinationsResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListObservabilityDestinationsResponse type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListObservabilityDestinationsResponse%20-%20TypeScript%20SDK&description=ListObservabilityDestinationsResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListObservabilityDestinationsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListObservabilityDestinationsResponse = { - result: { - data: [ - { - apiKeyHashes: null, - config: { - baseUrl: "https://us.cloud.langfuse.com", - publicKey: "pk-l...EfGh", - secretKey: "sk-l...AbCd", - }, - createdAt: "2025-08-24T10:30:00Z", - enabled: true, - filterRules: null, - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - name: "Production Langfuse", - privacyMode: false, - samplingRate: 1, - type: "langfuse", - updatedAt: "2025-08-24T15:45:00Z", - workspaceId: "550e8400-e29b-41d4-a716-446655440000", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListObservabilityDestinationsResponse](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/listorganizationmembersdata.mdx b/client-sdks/typescript/api-reference/operations/listorganizationmembersdata.mdx deleted file mode 100644 index 40ae63bb..00000000 --- a/client-sdks/typescript/api-reference/operations/listorganizationmembersdata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ListOrganizationMembersData - TypeScript SDK -sidebarTitle: ListOrganizationMembersData -description: ListOrganizationMembersData type definition -seoTitle: ListOrganizationMembersData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/listorganizationmembersdata -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersData Type | OpenRouter TypeScript SDK -'og:description': >- - ListOrganizationMembersData type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersData%20-%20TypeScript%20SDK&description=ListOrganizationMembersData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListOrganizationMembersData } from "@openrouter/sdk/models/operations"; - -let value: ListOrganizationMembersData = { - email: "jane.doe@example.com", - firstName: "Jane", - id: "user_2dHFtVWx2n56w6HkM0000000000", - lastName: "Doe", - role: "org:member", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `email` | *string* | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `firstName` | *string* | :heavy_check_mark: | First name of the member | Jane | -| `id` | *string* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `lastName` | *string* | :heavy_check_mark: | Last name of the member | Doe | -| `role` | [operations.Role](/client-sdks/typescript/api-reference/operations/role) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listorganizationmembersglobals.mdx b/client-sdks/typescript/api-reference/operations/listorganizationmembersglobals.mdx deleted file mode 100644 index 5909b7d1..00000000 --- a/client-sdks/typescript/api-reference/operations/listorganizationmembersglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListOrganizationMembersGlobals - TypeScript SDK -sidebarTitle: ListOrganizationMembersGlobals -description: ListOrganizationMembersGlobals type definition -seoTitle: ListOrganizationMembersGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listorganizationmembersglobals -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListOrganizationMembersGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersGlobals%20-%20TypeScript%20SDK&description=ListOrganizationMembersGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListOrganizationMembersGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListOrganizationMembersGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listorganizationmembersrequest.mdx b/client-sdks/typescript/api-reference/operations/listorganizationmembersrequest.mdx deleted file mode 100644 index 24150f7a..00000000 --- a/client-sdks/typescript/api-reference/operations/listorganizationmembersrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ListOrganizationMembersRequest - TypeScript SDK -sidebarTitle: ListOrganizationMembersRequest -description: ListOrganizationMembersRequest type definition -seoTitle: ListOrganizationMembersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listorganizationmembersrequest -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListOrganizationMembersRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersRequest%20-%20TypeScript%20SDK&description=ListOrganizationMembersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListOrganizationMembersRequest } from "@openrouter/sdk/models/operations"; - -let value: ListOrganizationMembersRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listorganizationmembersresponse.mdx b/client-sdks/typescript/api-reference/operations/listorganizationmembersresponse.mdx deleted file mode 100644 index 22eb9808..00000000 --- a/client-sdks/typescript/api-reference/operations/listorganizationmembersresponse.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListOrganizationMembersResponse - TypeScript SDK -sidebarTitle: ListOrganizationMembersResponse -description: ListOrganizationMembersResponse type definition -seoTitle: ListOrganizationMembersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listorganizationmembersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListOrganizationMembersResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponse%20-%20TypeScript%20SDK&description=ListOrganizationMembersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListOrganizationMembersResponse } from "@openrouter/sdk/models/operations"; - -let value: ListOrganizationMembersResponse = { - result: { - data: [], - totalCount: 25, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `result` | [operations.ListOrganizationMembersResponseBody](/client-sdks/typescript/api-reference/operations/listorganizationmembersresponsebody) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listorganizationmembersresponsebody.mdx b/client-sdks/typescript/api-reference/operations/listorganizationmembersresponsebody.mdx deleted file mode 100644 index 3401b1f0..00000000 --- a/client-sdks/typescript/api-reference/operations/listorganizationmembersresponsebody.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ListOrganizationMembersResponseBody - TypeScript SDK -sidebarTitle: ListOrganizationMembersResponseBody -description: ListOrganizationMembersResponseBody type definition -seoTitle: ListOrganizationMembersResponseBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listorganizationmembersresponsebody -'og:site_name': OpenRouter Documentation -'og:title': ListOrganizationMembersResponseBody Type | OpenRouter TypeScript SDK -'og:description': >- - ListOrganizationMembersResponseBody type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListOrganizationMembersResponseBody%20-%20TypeScript%20SDK&description=ListOrganizationMembersResponseBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of organization members - -## Example Usage - -```typescript lines -import { ListOrganizationMembersResponseBody } from "@openrouter/sdk/models/operations"; - -let value: ListOrganizationMembersResponseBody = { - data: [], - totalCount: 25, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | [operations.ListOrganizationMembersData](/client-sdks/typescript/api-reference/operations/listorganizationmembersdata)[] | :heavy_check_mark: | List of organization members | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listprovidersdata.mdx b/client-sdks/typescript/api-reference/operations/listprovidersdata.mdx deleted file mode 100644 index abf505bb..00000000 --- a/client-sdks/typescript/api-reference/operations/listprovidersdata.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ListProvidersData - TypeScript SDK -sidebarTitle: ListProvidersData -description: ListProvidersData type definition -seoTitle: ListProvidersData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listprovidersdata -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersData Type | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersData type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersData%20-%20TypeScript%20SDK&description=ListProvidersData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListProvidersData } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersData = { - name: "OpenAI", - privacyPolicyUrl: "https://openai.com/privacy", - slug: "openai", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `datacenters` | [operations.Datacenter](/client-sdks/typescript/api-reference/operations/datacenter)[] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [operations.Headquarters](/client-sdks/typescript/api-reference/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 | -| `statusPageUrl` | *string* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `termsOfServiceUrl` | *string* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listprovidersglobals.mdx b/client-sdks/typescript/api-reference/operations/listprovidersglobals.mdx deleted file mode 100644 index 1a196f9b..00000000 --- a/client-sdks/typescript/api-reference/operations/listprovidersglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListProvidersGlobals - TypeScript SDK -sidebarTitle: ListProvidersGlobals -description: ListProvidersGlobals type definition -seoTitle: ListProvidersGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listprovidersglobals -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersGlobals%20-%20TypeScript%20SDK&description=ListProvidersGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListProvidersGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listprovidersrequest.mdx b/client-sdks/typescript/api-reference/operations/listprovidersrequest.mdx deleted file mode 100644 index afba3d3b..00000000 --- a/client-sdks/typescript/api-reference/operations/listprovidersrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListProvidersRequest - TypeScript SDK -sidebarTitle: ListProvidersRequest -description: ListProvidersRequest type definition -seoTitle: ListProvidersRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listprovidersrequest -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersRequest%20-%20TypeScript%20SDK&description=ListProvidersRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListProvidersRequest } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listprovidersresponse.mdx b/client-sdks/typescript/api-reference/operations/listprovidersresponse.mdx deleted file mode 100644 index a32b8a6b..00000000 --- a/client-sdks/typescript/api-reference/operations/listprovidersresponse.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ListProvidersResponse - TypeScript SDK -sidebarTitle: ListProvidersResponse -description: ListProvidersResponse type definition -seoTitle: ListProvidersResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listprovidersresponse -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersResponse%20-%20TypeScript%20SDK&description=ListProvidersResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of providers - -## Example Usage - -```typescript lines -import { ListProvidersResponse } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersResponse = { - data: [ - { - name: "OpenAI", - privacyPolicyUrl: "https://openai.com/privacy", - slug: "openai", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [operations.ListProvidersData](/client-sdks/typescript/api-reference/operations/listprovidersdata)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listrequest.mdx b/client-sdks/typescript/api-reference/operations/listrequest.mdx deleted file mode 100644 index 0d3637a4..00000000 --- a/client-sdks/typescript/api-reference/operations/listrequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListRequest - TypeScript SDK -sidebarTitle: ListRequest -description: ListRequest type definition -seoTitle: ListRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listrequest -'og:site_name': OpenRouter Documentation -'og:title': ListRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListRequest type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListRequest%20-%20TypeScript%20SDK&description=ListRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListRequest } from "@openrouter/sdk/models/operations"; - -let value: ListRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `includeDisabled` | *boolean* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *number* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspaceId` | *string* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listresponse.mdx b/client-sdks/typescript/api-reference/operations/listresponse.mdx deleted file mode 100644 index 8b9d9fc6..00000000 --- a/client-sdks/typescript/api-reference/operations/listresponse.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ListResponse - TypeScript SDK -sidebarTitle: ListResponse -description: ListResponse type definition -seoTitle: ListResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listresponse -'og:site_name': OpenRouter Documentation -'og:title': ListResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListResponse type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListResponse%20-%20TypeScript%20SDK&description=ListResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of API keys - -## Example Usage - -```typescript expandable lines -import { ListResponse } from "@openrouter/sdk/models/operations"; - -let value: ListResponse = { - data: [ - { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "Production API Key", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.ListData](/client-sdks/typescript/api-reference/operations/listdata)[] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listvideoscontentglobals.mdx b/client-sdks/typescript/api-reference/operations/listvideoscontentglobals.mdx deleted file mode 100644 index ff32ed3a..00000000 --- a/client-sdks/typescript/api-reference/operations/listvideoscontentglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListVideosContentGlobals - TypeScript SDK -sidebarTitle: ListVideosContentGlobals -description: ListVideosContentGlobals type definition -seoTitle: ListVideosContentGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listvideoscontentglobals -'og:site_name': OpenRouter Documentation -'og:title': ListVideosContentGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListVideosContentGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosContentGlobals%20-%20TypeScript%20SDK&description=ListVideosContentGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListVideosContentGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListVideosContentGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listvideoscontentrequest.mdx b/client-sdks/typescript/api-reference/operations/listvideoscontentrequest.mdx deleted file mode 100644 index b3ead9d4..00000000 --- a/client-sdks/typescript/api-reference/operations/listvideoscontentrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ListVideosContentRequest - TypeScript SDK -sidebarTitle: ListVideosContentRequest -description: ListVideosContentRequest type definition -seoTitle: ListVideosContentRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listvideoscontentrequest -'og:site_name': OpenRouter Documentation -'og:title': ListVideosContentRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListVideosContentRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosContentRequest%20-%20TypeScript%20SDK&description=ListVideosContentRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListVideosContentRequest } from "@openrouter/sdk/models/operations"; - -let value: ListVideosContentRequest = { - jobId: "job-abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `jobId` | *string* | :heavy_check_mark: | N/A | job-abc123 | -| `index` | *number* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listvideosmodelsglobals.mdx b/client-sdks/typescript/api-reference/operations/listvideosmodelsglobals.mdx deleted file mode 100644 index 050fa7ba..00000000 --- a/client-sdks/typescript/api-reference/operations/listvideosmodelsglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListVideosModelsGlobals - TypeScript SDK -sidebarTitle: ListVideosModelsGlobals -description: ListVideosModelsGlobals type definition -seoTitle: ListVideosModelsGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listvideosmodelsglobals -'og:site_name': OpenRouter Documentation -'og:title': ListVideosModelsGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListVideosModelsGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosModelsGlobals%20-%20TypeScript%20SDK&description=ListVideosModelsGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListVideosModelsGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListVideosModelsGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listvideosmodelsrequest.mdx b/client-sdks/typescript/api-reference/operations/listvideosmodelsrequest.mdx deleted file mode 100644 index efa8e001..00000000 --- a/client-sdks/typescript/api-reference/operations/listvideosmodelsrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListVideosModelsRequest - TypeScript SDK -sidebarTitle: ListVideosModelsRequest -description: ListVideosModelsRequest type definition -seoTitle: ListVideosModelsRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listvideosmodelsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListVideosModelsRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListVideosModelsRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListVideosModelsRequest%20-%20TypeScript%20SDK&description=ListVideosModelsRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListVideosModelsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListVideosModelsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listworkspacesglobals.mdx b/client-sdks/typescript/api-reference/operations/listworkspacesglobals.mdx deleted file mode 100644 index f23bbb67..00000000 --- a/client-sdks/typescript/api-reference/operations/listworkspacesglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListWorkspacesGlobals - TypeScript SDK -sidebarTitle: ListWorkspacesGlobals -description: ListWorkspacesGlobals type definition -seoTitle: ListWorkspacesGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listworkspacesglobals -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - ListWorkspacesGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesGlobals%20-%20TypeScript%20SDK&description=ListWorkspacesGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListWorkspacesGlobals } from "@openrouter/sdk/models/operations"; - -let value: ListWorkspacesGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listworkspacesrequest.mdx b/client-sdks/typescript/api-reference/operations/listworkspacesrequest.mdx deleted file mode 100644 index f6682504..00000000 --- a/client-sdks/typescript/api-reference/operations/listworkspacesrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ListWorkspacesRequest - TypeScript SDK -sidebarTitle: ListWorkspacesRequest -description: ListWorkspacesRequest type definition -seoTitle: ListWorkspacesRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listworkspacesrequest -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesRequest Type | OpenRouter TypeScript SDK -'og:description': >- - ListWorkspacesRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesRequest%20-%20TypeScript%20SDK&description=ListWorkspacesRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListWorkspacesRequest } from "@openrouter/sdk/models/operations"; - -let value: ListWorkspacesRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/listworkspacesresponse.mdx b/client-sdks/typescript/api-reference/operations/listworkspacesresponse.mdx deleted file mode 100644 index 35e49a1d..00000000 --- a/client-sdks/typescript/api-reference/operations/listworkspacesresponse.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: ListWorkspacesResponse - TypeScript SDK -sidebarTitle: ListWorkspacesResponse -description: ListWorkspacesResponse type definition -seoTitle: ListWorkspacesResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/listworkspacesresponse -'og:site_name': OpenRouter Documentation -'og:title': ListWorkspacesResponse Type | OpenRouter TypeScript SDK -'og:description': >- - ListWorkspacesResponse type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListWorkspacesResponse%20-%20TypeScript%20SDK&description=ListWorkspacesResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListWorkspacesResponse } from "@openrouter/sdk/models/operations"; - -let value: ListWorkspacesResponse = { - result: { - data: [ - { - createdAt: "2025-08-24T10:30:00Z", - createdBy: "user_abc123", - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - id: "550e8400-e29b-41d4-a716-446655440000", - ioLoggingApiKeyIds: null, - ioLoggingSamplingRate: 1, - isDataDiscountLoggingEnabled: true, - isObservabilityBroadcastEnabled: false, - isObservabilityIoLoggingEnabled: false, - name: "Production", - slug: "production", - updatedAt: "2025-08-24T15:45:00Z", - }, - ], - totalCount: 1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListWorkspacesResponse](/client-sdks/typescript/api-reference/models/listworkspacesresponse) | :heavy_check_mark: | N/A | `{"data": [{"created_at": "2025-08-24T10:30:00Z","created_by": "user_abc123","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/client-sdks/typescript/api-reference/operations/objectembedding.mdx b/client-sdks/typescript/api-reference/operations/objectembedding.mdx deleted file mode 100644 index fbc157ed..00000000 --- a/client-sdks/typescript/api-reference/operations/objectembedding.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ObjectEmbedding - TypeScript SDK -sidebarTitle: ObjectEmbedding -description: ObjectEmbedding type definition -seoTitle: ObjectEmbedding Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/objectembedding -'og:site_name': OpenRouter Documentation -'og:title': ObjectEmbedding Type | OpenRouter TypeScript SDK -'og:description': >- - ObjectEmbedding type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectEmbedding%20-%20TypeScript%20SDK&description=ObjectEmbedding%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObjectEmbedding } from "@openrouter/sdk/models/operations"; - -let value: ObjectEmbedding = "embedding"; -``` - -## Values - -```typescript lines -"embedding" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/objectt.mdx b/client-sdks/typescript/api-reference/operations/objectt.mdx deleted file mode 100644 index ed0344ab..00000000 --- a/client-sdks/typescript/api-reference/operations/objectt.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ObjectT - TypeScript SDK -sidebarTitle: ObjectT -description: ObjectT type definition -seoTitle: ObjectT Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/objectt' -'og:site_name': OpenRouter Documentation -'og:title': ObjectT Type | OpenRouter TypeScript SDK -'og:description': >- - ObjectT type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectT%20-%20TypeScript%20SDK&description=ObjectT%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObjectT } from "@openrouter/sdk/models/operations"; - -let value: ObjectT = "list"; -``` - -## Values - -```typescript lines -"list" -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/prompttokensdetails.mdx b/client-sdks/typescript/api-reference/operations/prompttokensdetails.mdx deleted file mode 100644 index dc1e7dfe..00000000 --- a/client-sdks/typescript/api-reference/operations/prompttokensdetails.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PromptTokensDetails - TypeScript SDK -sidebarTitle: PromptTokensDetails -description: PromptTokensDetails type definition -seoTitle: PromptTokensDetails Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/prompttokensdetails -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails Type | OpenRouter TypeScript SDK -'og:description': >- - PromptTokensDetails type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20TypeScript%20SDK&description=PromptTokensDetails%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { PromptTokensDetails } from "@openrouter/sdk/models/operations"; - -let value: PromptTokensDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `fileTokens` | *number* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `imageTokens` | *number* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `textTokens` | *number* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `videoTokens` | *number* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/provider.mdx b/client-sdks/typescript/api-reference/operations/provider.mdx deleted file mode 100644 index 62c817c4..00000000 --- a/client-sdks/typescript/api-reference/operations/provider.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Provider - TypeScript SDK -sidebarTitle: Provider -description: Provider type definition -seoTitle: Provider Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/provider' -'og:site_name': OpenRouter Documentation -'og:title': Provider Type | OpenRouter TypeScript SDK -'og:description': >- - Provider type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Provider%20-%20TypeScript%20SDK&description=Provider%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). - -## Example Usage - -```typescript lines -import { Provider } from "@openrouter/sdk/models/operations"; - -let value: Provider = "openai"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"ai21" | "aion-labs" | "akashml" | "alibaba" | "amazon-bedrock" | "amazon-nova" | "ambient" | "anthropic" | "arcee-ai" | "atlas-cloud" | "avian" | "azure" | "baidu" | "baseten" | "black-forest-labs" | "byteplus" | "cerebras" | "chutes" | "cirrascale" | "clarifai" | "cloudflare" | "cohere" | "crusoe" | "darkbloom" | "deepinfra" | "deepseek" | "dekallm" | "digitalocean" | "featherless" | "fireworks" | "friendli" | "gmicloud" | "google-ai-studio" | "google-vertex" | "groq" | "hyperbolic" | "inception" | "inceptron" | "inference-net" | "infermatic" | "inflection" | "io-net" | "ionstream" | "liquid" | "mancer" | "mara" | "minimax" | "mistral" | "modelrun" | "modular" | "moonshotai" | "morph" | "ncompass" | "nebius" | "nex-agi" | "nextbit" | "novita" | "nvidia" | "open-inference" | "openai" | "parasail" | "perceptron" | "perplexity" | "phala" | "poolside" | "recraft" | "reka" | "relace" | "sambanova" | "seed" | "siliconflow" | "sourceful" | "stepfun" | "streamlake" | "switchpoint" | "together" | "upstage" | "venice" | "wandb" | "xai" | "xiaomi" | "z-ai" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/ratelimit.mdx b/client-sdks/typescript/api-reference/operations/ratelimit.mdx deleted file mode 100644 index ee3ea75e..00000000 --- a/client-sdks/typescript/api-reference/operations/ratelimit.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ~~RateLimit~~ - TypeScript SDK -sidebarTitle: ~~RateLimit~~ -description: ~~RateLimit~~ type definition -seoTitle: ~~RateLimit~~ Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/ratelimit' -'og:site_name': OpenRouter Documentation -'og:title': ~~RateLimit~~ Type | OpenRouter TypeScript SDK -'og:description': >- - ~~RateLimit~~ type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~RateLimit~~%20-%20TypeScript%20SDK&description=~~RateLimit~~%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Legacy rate limit information about a key. Will always return -1. - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Example Usage - -```typescript lines -import { RateLimit } from "@openrouter/sdk/models/operations"; - -let value: RateLimit = { - interval: "1h", - note: "This field is deprecated and safe to ignore.", - requests: 1000, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `interval` | *string* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *string* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `requests` | *number* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/result.mdx b/client-sdks/typescript/api-reference/operations/result.mdx deleted file mode 100644 index 1cbd86f3..00000000 --- a/client-sdks/typescript/api-reference/operations/result.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Result - TypeScript SDK -sidebarTitle: Result -description: Result type definition -seoTitle: Result Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/result' -'og:site_name': OpenRouter Documentation -'og:title': Result Type | OpenRouter TypeScript SDK -'og:description': >- - Result type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Result%20-%20TypeScript%20SDK&description=Result%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A single rerank result - -## Example Usage - -```typescript lines -import { Result } from "@openrouter/sdk/models/operations"; - -let value: Result = { - document: { - text: "Paris is the capital of France.", - }, - index: 0, - relevanceScore: 0.98, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `document` | [operations.Document](/client-sdks/typescript/api-reference/operations/document) | :heavy_check_mark: | The document object containing the original text | | -| `index` | *number* | :heavy_check_mark: | Index of the document in the original input list | 0 | -| `relevanceScore` | *number* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/role.mdx b/client-sdks/typescript/api-reference/operations/role.mdx deleted file mode 100644 index f57bfc14..00000000 --- a/client-sdks/typescript/api-reference/operations/role.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Role - TypeScript SDK -sidebarTitle: Role -description: Role type definition -seoTitle: Role Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/operations/role' -'og:site_name': OpenRouter Documentation -'og:title': Role Type | OpenRouter TypeScript SDK -'og:description': >- - Role type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Role%20-%20TypeScript%20SDK&description=Role%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Role of the member in the organization - -## Example Usage - -```typescript lines -import { Role } from "@openrouter/sdk/models/operations"; - -let value: Role = "org:member"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"org:admin" | "org:member" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestglobals.mdx b/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestglobals.mdx deleted file mode 100644 index fe978899..00000000 --- a/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: SendChatCompletionRequestGlobals - TypeScript SDK -sidebarTitle: SendChatCompletionRequestGlobals -description: SendChatCompletionRequestGlobals type definition -seoTitle: SendChatCompletionRequestGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/sendchatcompletionrequestglobals -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - SendChatCompletionRequestGlobals type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestGlobals%20-%20TypeScript%20SDK&description=SendChatCompletionRequestGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SendChatCompletionRequestGlobals } from "@openrouter/sdk/models/operations"; - -let value: SendChatCompletionRequestGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestrequest.mdx b/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestrequest.mdx deleted file mode 100644 index 2a6c96ad..00000000 --- a/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestrequest.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: SendChatCompletionRequestRequest - TypeScript SDK -sidebarTitle: SendChatCompletionRequestRequest -description: SendChatCompletionRequestRequest type definition -seoTitle: SendChatCompletionRequestRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/sendchatcompletionrequestrequest -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestRequest Type | OpenRouter TypeScript SDK -'og:description': >- - SendChatCompletionRequestRequest type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestRequest%20-%20TypeScript%20SDK&description=SendChatCompletionRequestRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SendChatCompletionRequestRequest } from "@openrouter/sdk/models/operations"; - -let value: SendChatCompletionRequestRequest = { - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "What is the capital of France?", - role: "user", - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterExperimentalMetadata` | [models.MetadataLevel](/client-sdks/typescript/api-reference/models/metadatalevel) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. | enabled | -| `chatRequest` | [models.ChatRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestresponse.mdx b/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestresponse.mdx deleted file mode 100644 index c218a053..00000000 --- a/client-sdks/typescript/api-reference/operations/sendchatcompletionrequestresponse.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: SendChatCompletionRequestResponse - TypeScript SDK -sidebarTitle: SendChatCompletionRequestResponse -description: SendChatCompletionRequestResponse type definition -seoTitle: SendChatCompletionRequestResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/sendchatcompletionrequestresponse -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestResponse Type | OpenRouter TypeScript SDK -'og:description': >- - SendChatCompletionRequestResponse type reference for the OpenRouter TypeScript - SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestResponse%20-%20TypeScript%20SDK&description=SendChatCompletionRequestResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatResult` - -```typescript lines -const value: models.ChatResult = { - choices: [ - { - finishReason: "stop", - index: 0, - message: { - role: "assistant", - }, - }, - ], - created: 1677652288, - id: "chatcmpl-123", - model: "openai/gpt-4", - object: "chat.completion", - systemFingerprint: "fp_44709d6fcb", -}; -``` - -### `EventStream` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updatebyokkeyglobals.mdx b/client-sdks/typescript/api-reference/operations/updatebyokkeyglobals.mdx deleted file mode 100644 index 45e4efc0..00000000 --- a/client-sdks/typescript/api-reference/operations/updatebyokkeyglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateBYOKKeyGlobals - TypeScript SDK -sidebarTitle: UpdateBYOKKeyGlobals -description: UpdateBYOKKeyGlobals type definition -seoTitle: UpdateBYOKKeyGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatebyokkeyglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateBYOKKeyGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyGlobals%20-%20TypeScript%20SDK&description=UpdateBYOKKeyGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateBYOKKeyGlobals } from "@openrouter/sdk/models/operations"; - -let value: UpdateBYOKKeyGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updatebyokkeyrequest.mdx b/client-sdks/typescript/api-reference/operations/updatebyokkeyrequest.mdx deleted file mode 100644 index cf26202e..00000000 --- a/client-sdks/typescript/api-reference/operations/updatebyokkeyrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateBYOKKeyRequest - TypeScript SDK -sidebarTitle: UpdateBYOKKeyRequest -description: UpdateBYOKKeyRequest type definition -seoTitle: UpdateBYOKKeyRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatebyokkeyrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateBYOKKeyRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateBYOKKeyRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateBYOKKeyRequest%20-%20TypeScript%20SDK&description=UpdateBYOKKeyRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateBYOKKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateBYOKKeyRequest = { - id: "11111111-2222-3333-4444-555555555555", - updateBYOKKeyRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [models.UpdateBYOKKeyRequest](/client-sdks/typescript/api-reference/models/updatebyokkeyrequest) | :heavy_check_mark: | N/A | `{"disabled": false,"name": "Updated OpenAI Key"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updateguardrailglobals.mdx b/client-sdks/typescript/api-reference/operations/updateguardrailglobals.mdx deleted file mode 100644 index 13749426..00000000 --- a/client-sdks/typescript/api-reference/operations/updateguardrailglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateGuardrailGlobals - TypeScript SDK -sidebarTitle: UpdateGuardrailGlobals -description: UpdateGuardrailGlobals type definition -seoTitle: UpdateGuardrailGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateguardrailglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailGlobals%20-%20TypeScript%20SDK&description=UpdateGuardrailGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailGlobals } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updateguardrailrequest.mdx b/client-sdks/typescript/api-reference/operations/updateguardrailrequest.mdx deleted file mode 100644 index 50ebde08..00000000 --- a/client-sdks/typescript/api-reference/operations/updateguardrailrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateGuardrailRequest - TypeScript SDK -sidebarTitle: UpdateGuardrailRequest -description: UpdateGuardrailRequest type definition -seoTitle: UpdateGuardrailRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20TypeScript%20SDK&description=UpdateGuardrailRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - updateGuardrailRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [models.UpdateGuardrailRequest](/client-sdks/typescript/api-reference/models/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/client-sdks/typescript/api-reference/operations/updatekeysdata.mdx b/client-sdks/typescript/api-reference/operations/updatekeysdata.mdx deleted file mode 100644 index e68922b3..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeysdata.mdx +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: UpdateKeysData - TypeScript SDK -sidebarTitle: UpdateKeysData -description: UpdateKeysData type definition -seoTitle: UpdateKeysData Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeysdata -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysData Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysData type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysData%20-%20TypeScript%20SDK&description=UpdateKeysData%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The updated API key information - -## Example Usage - -```typescript expandable lines -import { UpdateKeysData } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysData = { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: false, - label: "sk-or-v1-0e6...1c96", - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - name: "My Production Key", - updatedAt: "2025-08-24T15:45:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updatekeysglobals.mdx b/client-sdks/typescript/api-reference/operations/updatekeysglobals.mdx deleted file mode 100644 index 5954f5af..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeysglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateKeysGlobals - TypeScript SDK -sidebarTitle: UpdateKeysGlobals -description: UpdateKeysGlobals type definition -seoTitle: UpdateKeysGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeysglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysGlobals type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysGlobals%20-%20TypeScript%20SDK&description=UpdateKeysGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateKeysGlobals } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updatekeyslimitreset.mdx b/client-sdks/typescript/api-reference/operations/updatekeyslimitreset.mdx deleted file mode 100644 index 910acc5e..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeyslimitreset.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: UpdateKeysLimitReset - TypeScript SDK -sidebarTitle: UpdateKeysLimitReset -description: UpdateKeysLimitReset type definition -seoTitle: UpdateKeysLimitReset Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeyslimitreset -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysLimitReset Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysLimitReset type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysLimitReset%20-%20TypeScript%20SDK&description=UpdateKeysLimitReset%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { UpdateKeysLimitReset } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysLimitReset = "daily"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updatekeysrequest.mdx b/client-sdks/typescript/api-reference/operations/updatekeysrequest.mdx deleted file mode 100644 index fd4599b9..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeysrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateKeysRequest - TypeScript SDK -sidebarTitle: UpdateKeysRequest -description: UpdateKeysRequest type definition -seoTitle: UpdateKeysRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeysrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysRequest type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequest%20-%20TypeScript%20SDK&description=UpdateKeysRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysRequest = { - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - requestBody: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `requestBody` | [operations.UpdateKeysRequestBody](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/updatekeysrequestbody.mdx b/client-sdks/typescript/api-reference/operations/updatekeysrequestbody.mdx deleted file mode 100644 index fe114468..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeysrequestbody.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: UpdateKeysRequestBody - TypeScript SDK -sidebarTitle: UpdateKeysRequestBody -description: UpdateKeysRequestBody type definition -seoTitle: UpdateKeysRequestBody Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeysrequestbody -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequestBody Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysRequestBody type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequestBody%20-%20TypeScript%20SDK&description=UpdateKeysRequestBody%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateKeysRequestBody } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysRequestBody = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether to disable the API key | false | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *number* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limitReset` | [operations.UpdateKeysLimitReset](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/updatekeysresponse.mdx b/client-sdks/typescript/api-reference/operations/updatekeysresponse.mdx deleted file mode 100644 index 6ecee7b5..00000000 --- a/client-sdks/typescript/api-reference/operations/updatekeysresponse.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: UpdateKeysResponse - TypeScript SDK -sidebarTitle: UpdateKeysResponse -description: UpdateKeysResponse type definition -seoTitle: UpdateKeysResponse Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updatekeysresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysResponse Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysResponse type reference for the OpenRouter TypeScript SDK. Complete - type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysResponse%20-%20TypeScript%20SDK&description=UpdateKeysResponse%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key updated successfully - -## Example Usage - -```typescript expandable lines -import { UpdateKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysResponse = { - data: { - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageMonthly: 17.38, - byokUsageWeekly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - creatorUserId: "user_2dHFtVWx2n56w6HkM0000000000", - disabled: false, - hash: "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943", - includeByokInLimit: true, - label: "Updated API Key Name", - limit: 75, - limitRemaining: 49.5, - limitReset: "daily", - name: "Updated API Key Name", - updatedAt: "2025-08-24T16:00:00Z", - usage: 25.5, - usageDaily: 25.5, - usageMonthly: 25.5, - usageWeekly: 25.5, - workspaceId: "0df9e665-d932-5740-b2c7-b52af166bc11", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [operations.UpdateKeysData](/client-sdks/typescript/api-reference/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/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationglobals.mdx b/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationglobals.mdx deleted file mode 100644 index 610abb31..00000000 --- a/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateObservabilityDestinationGlobals - TypeScript SDK -sidebarTitle: UpdateObservabilityDestinationGlobals -description: UpdateObservabilityDestinationGlobals type definition -seoTitle: UpdateObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateobservabilitydestinationglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateObservabilityDestinationGlobals type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationGlobals%20-%20TypeScript%20SDK&description=UpdateObservabilityDestinationGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateObservabilityDestinationGlobals } from "@openrouter/sdk/models/operations"; - -let value: UpdateObservabilityDestinationGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationrequest.mdx b/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationrequest.mdx deleted file mode 100644 index d5d2fa87..00000000 --- a/client-sdks/typescript/api-reference/operations/updateobservabilitydestinationrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateObservabilityDestinationRequest - TypeScript SDK -sidebarTitle: UpdateObservabilityDestinationRequest -description: UpdateObservabilityDestinationRequest type definition -seoTitle: UpdateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateobservabilitydestinationrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateObservabilityDestinationRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateObservabilityDestinationRequest type reference for the OpenRouter - TypeScript SDK. Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateObservabilityDestinationRequest%20-%20TypeScript%20SDK&description=UpdateObservabilityDestinationRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateObservabilityDestinationRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateObservabilityDestinationRequest = { - id: "99999999-aaaa-bbbb-cccc-dddddddddddd", - updateObservabilityDestinationRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [models.UpdateObservabilityDestinationRequest](/client-sdks/typescript/api-reference/models/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | `{"enabled": false,"name": "Updated Langfuse"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updateworkspaceglobals.mdx b/client-sdks/typescript/api-reference/operations/updateworkspaceglobals.mdx deleted file mode 100644 index df535b4a..00000000 --- a/client-sdks/typescript/api-reference/operations/updateworkspaceglobals.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateWorkspaceGlobals - TypeScript SDK -sidebarTitle: UpdateWorkspaceGlobals -description: UpdateWorkspaceGlobals type definition -seoTitle: UpdateWorkspaceGlobals Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateworkspaceglobals -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceGlobals Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateWorkspaceGlobals type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceGlobals%20-%20TypeScript%20SDK&description=UpdateWorkspaceGlobals%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateWorkspaceGlobals } from "@openrouter/sdk/models/operations"; - -let value: UpdateWorkspaceGlobals = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/updateworkspacerequest.mdx b/client-sdks/typescript/api-reference/operations/updateworkspacerequest.mdx deleted file mode 100644 index 5bc3ab14..00000000 --- a/client-sdks/typescript/api-reference/operations/updateworkspacerequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: UpdateWorkspaceRequest - TypeScript SDK -sidebarTitle: UpdateWorkspaceRequest -description: UpdateWorkspaceRequest type definition -seoTitle: UpdateWorkspaceRequest Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/updateworkspacerequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateWorkspaceRequest Type | OpenRouter TypeScript SDK -'og:description': >- - UpdateWorkspaceRequest type reference for the OpenRouter TypeScript SDK. - Complete type definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateWorkspaceRequest%20-%20TypeScript%20SDK&description=UpdateWorkspaceRequest%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateWorkspaceRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateWorkspaceRequest = { - id: "production", - updateWorkspaceRequest: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [models.UpdateWorkspaceRequest](/client-sdks/typescript/api-reference/models/updateworkspacerequest) | :heavy_check_mark: | N/A | `{"name": "Updated Workspace","slug": "updated-workspace"}` | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/operations/usagelimittype.mdx b/client-sdks/typescript/api-reference/operations/usagelimittype.mdx deleted file mode 100644 index be25e34f..00000000 --- a/client-sdks/typescript/api-reference/operations/usagelimittype.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: UsageLimitType - TypeScript SDK -sidebarTitle: UsageLimitType -description: UsageLimitType type definition -seoTitle: UsageLimitType Type | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/api-reference/operations/usagelimittype -'og:site_name': OpenRouter Documentation -'og:title': UsageLimitType Type | OpenRouter TypeScript SDK -'og:description': >- - UsageLimitType type reference for the OpenRouter TypeScript SDK. Complete type - definition and usage examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UsageLimitType%20-%20TypeScript%20SDK&description=UsageLimitType%20type%20definition -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Optional credit limit reset interval. When set, the credit limit resets on this interval. - -## Example Usage - -```typescript lines -import { UsageLimitType } from "@openrouter/sdk/models/operations"; - -let value: UsageLimitType = "monthly"; - -// Open enum: unrecognized values are captured as Unrecognized -``` - -## Values - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/organization.mdx b/client-sdks/typescript/api-reference/organization.mdx deleted file mode 100644 index d9d232a9..00000000 --- a/client-sdks/typescript/api-reference/organization.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: Organization - TypeScript SDK -sidebarTitle: Organization -description: Organization method reference -seoTitle: Organization | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/organization' -'og:site_name': OpenRouter Documentation -'og:title': Organization | OpenRouter TypeScript SDK -'og:description': >- - Organization method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Organization%20-%20TypeScript%20SDK&description=Organization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Organization endpoints - -### Available Operations - -* [listMembers](#listmembers) - List organization members - -## listMembers - -List all members of the organization associated with the authenticated management key. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listOrganizationMembers" method="get" path="/organization/members" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.organization.listMembers(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { organizationListMembers } from "@openrouter/sdk/funcs/organizationListMembers.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await organizationListMembers(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("organizationListMembers failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListOrganizationMembersRequest](/client-sdks/typescript/api-reference/operations/listorganizationmembersrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListOrganizationMembersResponse](/client-sdks/typescript/api-reference/operations/listorganizationmembersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/presets.mdx b/client-sdks/typescript/api-reference/presets.mdx deleted file mode 100644 index b473022d..00000000 --- a/client-sdks/typescript/api-reference/presets.mdx +++ /dev/null @@ -1,353 +0,0 @@ ---- -title: Presets - TypeScript SDK -sidebarTitle: Presets -description: Presets method reference -seoTitle: Presets | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/presets' -'og:site_name': OpenRouter Documentation -'og:title': Presets | OpenRouter TypeScript SDK -'og:description': >- - Presets method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Presets%20-%20TypeScript%20SDK&description=Presets%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Presets endpoints - -### Available Operations - -* [createPresetsChatCompletions](#createpresetschatcompletions) - Create a preset from a chat-completions request body -* [createPresetsMessages](#createpresetsmessages) - Create a preset from a messages request body -* [createPresetsResponses](#createpresetsresponses) - Create a preset from a responses request body - -## createPresetsChatCompletions - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createPresetsChatCompletions" method="post" path="/presets/{slug}/chat/completions" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.presets.createPresetsChatCompletions({ - slug: "my-preset", - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "Hello!", - role: "user", - }, - ], - model: "openai/gpt-5.4", - temperature: 0.7, - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { presetsCreatePresetsChatCompletions } from "@openrouter/sdk/funcs/presetsCreatePresetsChatCompletions.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await presetsCreatePresetsChatCompletions(openRouter, { - slug: "my-preset", - chatRequest: { - messages: [ - { - content: "You are a helpful assistant.", - role: "system", - }, - { - content: "Hello!", - role: "user", - }, - ], - model: "openai/gpt-5.4", - temperature: 0.7, - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("presetsCreatePresetsChatCompletions failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsChatCompletionsRequest](/client-sdks/typescript/api-reference/operations/createpresetschatcompletionsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreatePresetFromInferenceResponse](/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## createPresetsMessages - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createPresetsMessages" method="post" path="/presets/{slug}/messages" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.presets.createPresetsMessages({ - slug: "my-preset", - messagesRequest: { - maxTokens: 1024, - messages: [ - { - content: "Hello!", - role: "user", - }, - ], - model: "anthropic/claude-4.6-sonnet", - system: "You are a helpful assistant.", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { presetsCreatePresetsMessages } from "@openrouter/sdk/funcs/presetsCreatePresetsMessages.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await presetsCreatePresetsMessages(openRouter, { - slug: "my-preset", - messagesRequest: { - maxTokens: 1024, - messages: [ - { - content: "Hello!", - role: "user", - }, - ], - model: "anthropic/claude-4.6-sonnet", - system: "You are a helpful assistant.", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("presetsCreatePresetsMessages failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsMessagesRequest](/client-sdks/typescript/api-reference/operations/createpresetsmessagesrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreatePresetFromInferenceResponse](/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## createPresetsResponses - -Creates a preset (or a new version of an existing one) from an inference request body. Only fields that overlap with the preset config are persisted; other fields (e.g. `messages`, `stream`, `prompt`) are silently ignored. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createPresetsResponses" method="post" path="/presets/{slug}/responses" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.presets.createPresetsResponses({ - slug: "my-preset", - responsesRequest: { - input: "Hello!", - instructions: "You are a helpful assistant.", - model: "openai/gpt-5.4", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { presetsCreatePresetsResponses } from "@openrouter/sdk/funcs/presetsCreatePresetsResponses.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await presetsCreatePresetsResponses(openRouter, { - slug: "my-preset", - responsesRequest: { - input: "Hello!", - instructions: "You are a helpful assistant.", - model: "openai/gpt-5.4", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("presetsCreatePresetsResponses failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsResponsesRequest](/client-sdks/typescript/api-reference/operations/createpresetsresponsesrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreatePresetFromInferenceResponse](/client-sdks/typescript/api-reference/models/createpresetfrominferenceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.ConflictResponseError | 409 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/providers.mdx b/client-sdks/typescript/api-reference/providers.mdx deleted file mode 100644 index 9d4ed7d5..00000000 --- a/client-sdks/typescript/api-reference/providers.mdx +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: Providers - TypeScript SDK -sidebarTitle: Providers -description: Providers method reference -seoTitle: Providers | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/providers' -'og:site_name': OpenRouter Documentation -'og:title': Providers | OpenRouter TypeScript SDK -'og:description': >- - Providers method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Providers%20-%20TypeScript%20SDK&description=Providers%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: cloud ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Provider information endpoints - -### Available Operations - -* [list](#list) - List all providers - -## list - -List all providers - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listProviders" method="get" path="/providers" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.providers.list(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { providersList } from "@openrouter/sdk/funcs/providersList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await providersList(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("providersList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListProvidersRequest](/client-sdks/typescript/api-reference/operations/listprovidersrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListProvidersResponse](/client-sdks/typescript/api-reference/operations/listprovidersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/rerank.mdx b/client-sdks/typescript/api-reference/rerank.mdx deleted file mode 100644 index 16a4c032..00000000 --- a/client-sdks/typescript/api-reference/rerank.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: Rerank - TypeScript SDK -sidebarTitle: Rerank -description: Rerank method reference -seoTitle: Rerank | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/rerank' -'og:site_name': OpenRouter Documentation -'og:title': Rerank | OpenRouter TypeScript SDK -'og:description': >- - Rerank method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Rerank%20-%20TypeScript%20SDK&description=Rerank%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Rerank endpoints - -### Available Operations - -* [rerank](#rerank) - Submit a rerank request - -## rerank - -Submits a rerank request to the rerank router - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createRerank" method="post" path="/rerank" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.rerank.rerank({ - requestBody: { - documents: [ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - ], - model: "cohere/rerank-v3.5", - query: "What is the capital of France?", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { rerankRerank } from "@openrouter/sdk/funcs/rerankRerank.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await rerankRerank(openRouter, { - requestBody: { - documents: [ - "Paris is the capital of France.", - "Berlin is the capital of Germany.", - ], - model: "cohere/rerank-v3.5", - query: "What is the capital of France?", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("rerankRerank failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateRerankRequest](/client-sdks/typescript/api-reference/operations/creatererankrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.CreateRerankResponse](/client-sdks/typescript/api-reference/operations/creatererankresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/responses.mdx b/client-sdks/typescript/api-reference/responses.mdx deleted file mode 100644 index 8200b299..00000000 --- a/client-sdks/typescript/api-reference/responses.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: Beta.Responses - TypeScript SDK -sidebarTitle: Beta.Responses -description: Beta.Responses method reference -seoTitle: Beta.Responses | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/responses' -'og:site_name': OpenRouter Documentation -'og:title': Beta.Responses | OpenRouter TypeScript SDK -'og:description': >- - Beta.Responses method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Beta.Responses%20-%20TypeScript%20SDK&description=Beta.Responses%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: reply ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -beta.responses endpoints - -### Available Operations - -* [send](#send) - Create a response - -## send - -Creates a streaming or non-streaming response using OpenResponses API format - -### Example Usage: guardrail-blocked - -{/* UsageSnippet language="typescript" operationID="createResponses" method="post" path="/responses" example="guardrail-blocked" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.beta.responses.send({ - responsesRequest: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { betaResponsesSend } from "@openrouter/sdk/funcs/betaResponsesSend.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaResponsesSend(openRouter, { - responsesRequest: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaResponsesSend failed:", res.error); - } -} - -run(); -``` -### Example Usage: insufficient-permissions - -{/* UsageSnippet language="typescript" operationID="createResponses" method="post" path="/responses" example="insufficient-permissions" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.beta.responses.send({ - responsesRequest: {}, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { betaResponsesSend } from "@openrouter/sdk/funcs/betaResponsesSend.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await betaResponsesSend(openRouter, { - responsesRequest: {}, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("betaResponsesSend failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateResponsesRequest](/client-sdks/typescript/api-reference/operations/createresponsesrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.CreateResponsesResponse](/client-sdks/typescript/api-reference/operations/createresponsesresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.RequestTimeoutResponseError | 408 | application/json | -| errors.PayloadTooLargeResponseError | 413 | application/json | -| errors.UnprocessableEntityResponseError | 422 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/stt.mdx b/client-sdks/typescript/api-reference/stt.mdx deleted file mode 100644 index caa64311..00000000 --- a/client-sdks/typescript/api-reference/stt.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: Transcriptions - TypeScript SDK -sidebarTitle: Transcriptions -description: Transcriptions method reference -seoTitle: Transcriptions | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/stt' -'og:site_name': OpenRouter Documentation -'og:title': Transcriptions | OpenRouter TypeScript SDK -'og:description': >- - Transcriptions method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Transcriptions%20-%20TypeScript%20SDK&description=Transcriptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Speech-to-text endpoints - -### Available Operations - -* [createTranscription](#createtranscription) - Create transcription - -## createTranscription - -Transcribes audio into text. Accepts base64-encoded audio input and returns the transcribed text. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createAudioTranscriptions" method="post" path="/audio/transcriptions" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.stt.createTranscription({ - sttRequest: { - inputAudio: { - data: "UklGRiQA...", - format: "wav", - }, - language: "en", - model: "openai/whisper-large-v3", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { sttCreateTranscription } from "@openrouter/sdk/funcs/sttCreateTranscription.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await sttCreateTranscription(openRouter, { - sttRequest: { - inputAudio: { - data: "UklGRiQA...", - format: "wav", - }, - language: "en", - model: "openai/whisper-large-v3", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("sttCreateTranscription failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioTranscriptionsRequest](/client-sdks/typescript/api-reference/operations/createaudiotranscriptionsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.STTResponse](/client-sdks/typescript/api-reference/models/sttresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/tts.mdx b/client-sdks/typescript/api-reference/tts.mdx deleted file mode 100644 index 2707a32c..00000000 --- a/client-sdks/typescript/api-reference/tts.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: Speech - TypeScript SDK -sidebarTitle: Speech -description: Speech method reference -seoTitle: Speech | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/tts' -'og:site_name': OpenRouter Documentation -'og:title': Speech | OpenRouter TypeScript SDK -'og:description': >- - Speech method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Speech%20-%20TypeScript%20SDK&description=Speech%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Text-to-speech endpoints - -### Available Operations - -* [createSpeech](#createspeech) - Create speech - -## createSpeech - -Synthesizes audio from the input text. Returns a raw audio bytestream in the requested format (e.g. mp3, pcm, wav). - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createAudioSpeech" method="post" path="/audio/speech" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.tts.createSpeech({ - speechRequest: { - input: "Hello world", - model: "elevenlabs/eleven-turbo-v2", - speed: 1, - voice: "alloy", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { ttsCreateSpeech } from "@openrouter/sdk/funcs/ttsCreateSpeech.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await ttsCreateSpeech(openRouter, { - speechRequest: { - input: "Hello world", - model: "elevenlabs/eleven-turbo-v2", - speed: 1, - voice: "alloy", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("ttsCreateSpeech failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioSpeechRequest](/client-sdks/typescript/api-reference/operations/createaudiospeechrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[`ReadableStream`](/client-sdks/typescript/api-reference/models)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.ServiceUnavailableResponseError | 503 | application/json | -| errors.EdgeNetworkTimeoutResponseError | 524 | application/json | -| errors.ProviderOverloadedResponseError | 529 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/videogeneration.mdx b/client-sdks/typescript/api-reference/videogeneration.mdx deleted file mode 100644 index f9f6098a..00000000 --- a/client-sdks/typescript/api-reference/videogeneration.mdx +++ /dev/null @@ -1,379 +0,0 @@ ---- -title: VideoGeneration - TypeScript SDK -sidebarTitle: VideoGeneration -description: VideoGeneration method reference -seoTitle: VideoGeneration | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/videogeneration' -'og:site_name': OpenRouter Documentation -'og:title': VideoGeneration | OpenRouter TypeScript SDK -'og:description': >- - VideoGeneration method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoGeneration%20-%20TypeScript%20SDK&description=VideoGeneration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Video Generation endpoints - -### Available Operations - -* [generate](#generate) - Submit a video generation request -* [getGeneration](#getgeneration) - Poll video generation status -* [getVideoContent](#getvideocontent) - Download generated video content -* [listVideosModels](#listvideosmodels) - List all video generation models - -## generate - -Submits a video generation request and returns a polling URL to check status - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createVideos" method="post" path="/videos" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.videoGeneration.generate({ - videoGenerationRequest: { - aspectRatio: "16:9", - duration: 8, - model: "google/veo-3.1", - prompt: "A serene mountain landscape at sunset", - resolution: "720p", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { videoGenerationGenerate } from "@openrouter/sdk/funcs/videoGenerationGenerate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await videoGenerationGenerate(openRouter, { - videoGenerationRequest: { - aspectRatio: "16:9", - duration: 8, - model: "google/veo-3.1", - prompt: "A serene mountain landscape at sunset", - resolution: "720p", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("videoGenerationGenerate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateVideosRequest](/client-sdks/typescript/api-reference/operations/createvideosrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.VideoGenerationResponse](/client-sdks/typescript/api-reference/models/videogenerationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.PaymentRequiredResponseError | 402 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.TooManyRequestsResponseError | 429 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## getGeneration - -Returns job status and content URLs when completed - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getVideos" method="get" path="/videos/{jobId}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.videoGeneration.getGeneration({ - jobId: "job-abc123", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { videoGenerationGetGeneration } from "@openrouter/sdk/funcs/videoGenerationGetGeneration.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await videoGenerationGetGeneration(openRouter, { - jobId: "job-abc123", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("videoGenerationGetGeneration failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetVideosRequest](/client-sdks/typescript/api-reference/operations/getvideosrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.VideoGenerationResponse](/client-sdks/typescript/api-reference/models/videogenerationresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## getVideoContent - -Streams the generated video content from the upstream provider - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listVideosContent" method="get" path="/videos/{jobId}/content" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.videoGeneration.getVideoContent({ - jobId: "job-abc123", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { videoGenerationGetVideoContent } from "@openrouter/sdk/funcs/videoGenerationGetVideoContent.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await videoGenerationGetVideoContent(openRouter, { - jobId: "job-abc123", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("videoGenerationGetVideoContent failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosContentRequest](/client-sdks/typescript/api-reference/operations/listvideoscontentrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[`ReadableStream`](/client-sdks/typescript/api-reference/models)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.BadGatewayResponseError | 502 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## listVideosModels - -Returns a list of all available video generation models and their properties - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listVideosModels" method="get" path="/videos/models" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.videoGeneration.listVideosModels(); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { videoGenerationListVideosModels } from "@openrouter/sdk/funcs/videoGenerationListVideosModels.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await videoGenerationListVideosModels(openRouter); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("videoGenerationListVideosModels failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosModelsRequest](/client-sdks/typescript/api-reference/operations/listvideosmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.VideoModelsListResponse](/client-sdks/typescript/api-reference/models/videomodelslistresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/api-reference/workspaces.mdx b/client-sdks/typescript/api-reference/workspaces.mdx deleted file mode 100644 index d90b8942..00000000 --- a/client-sdks/typescript/api-reference/workspaces.mdx +++ /dev/null @@ -1,670 +0,0 @@ ---- -title: Workspaces - TypeScript SDK -sidebarTitle: Workspaces -description: Workspaces method reference -seoTitle: Workspaces | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/api-reference/workspaces' -'og:site_name': OpenRouter Documentation -'og:title': Workspaces | OpenRouter TypeScript SDK -'og:description': >- - Workspaces method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Workspaces%20-%20TypeScript%20SDK&description=Workspaces%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: file ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Overview - -Workspaces endpoints - -### Available Operations - -* [list](#list) - List workspaces -* [create](#create) - Create a workspace -* [delete](#delete) - Delete a workspace -* [get](#get) - Get a workspace -* [update](#update) - Update a workspace -* [bulkAddMembers](#bulkaddmembers) - Bulk add members to a workspace -* [bulkRemoveMembers](#bulkremovemembers) - Bulk remove members from a workspace - -## list - -List all workspaces for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="listWorkspaces" method="get" path="/workspaces" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.list(); - - for await (const page of result) { - console.log(page); - } -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesList } from "@openrouter/sdk/funcs/workspacesList.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesList(openRouter); - if (res.ok) { - const { value: result } = res; - for await (const page of result) { - console.log(page); - } - } else { - console.log("workspacesList failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspacesRequest](/client-sdks/typescript/api-reference/operations/listworkspacesrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[operations.ListWorkspacesResponse](/client-sdks/typescript/api-reference/operations/listworkspacesresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## create - -Create a new workspace for the authenticated user. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="createWorkspace" method="post" path="/workspaces" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.create({ - createWorkspaceRequest: { - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - name: "Production", - slug: "production", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesCreate } from "@openrouter/sdk/funcs/workspacesCreate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesCreate(openRouter, { - createWorkspaceRequest: { - defaultImageModel: "openai/dall-e-3", - defaultProviderSort: "price", - defaultTextModel: "openai/gpt-4o", - description: "Production environment workspace", - name: "Production", - slug: "production", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesCreate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateWorkspaceRequest](/client-sdks/typescript/api-reference/operations/createworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.CreateWorkspaceResponse](/client-sdks/typescript/api-reference/models/createworkspaceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## delete - -Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="deleteWorkspace" method="delete" path="/workspaces/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.delete({ - id: "production", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesDelete } from "@openrouter/sdk/funcs/workspacesDelete.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesDelete(openRouter, { - id: "production", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesDelete failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteWorkspaceRequest](/client-sdks/typescript/api-reference/operations/deleteworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.DeleteWorkspaceResponse](/client-sdks/typescript/api-reference/models/deleteworkspaceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## get - -Get a single workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="getWorkspace" method="get" path="/workspaces/{id}" */} -```typescript lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.get({ - id: "production", - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesGet } from "@openrouter/sdk/funcs/workspacesGet.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesGet(openRouter, { - id: "production", - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesGet failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetWorkspaceRequest](/client-sdks/typescript/api-reference/operations/getworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.GetWorkspaceResponse](/client-sdks/typescript/api-reference/models/getworkspaceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## update - -Update an existing workspace by ID or slug. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="updateWorkspace" method="patch" path="/workspaces/{id}" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.update({ - id: "production", - updateWorkspaceRequest: { - name: "Updated Workspace", - slug: "updated-workspace", - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesUpdate } from "@openrouter/sdk/funcs/workspacesUpdate.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesUpdate(openRouter, { - id: "production", - updateWorkspaceRequest: { - name: "Updated Workspace", - slug: "updated-workspace", - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesUpdate failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateWorkspaceRequest](/client-sdks/typescript/api-reference/operations/updateworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.UpdateWorkspaceResponse](/client-sdks/typescript/api-reference/models/updateworkspaceresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkAddMembers - -Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkAddWorkspaceMembers" method="post" path="/workspaces/{id}/members/add" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.bulkAddMembers({ - id: "production", - bulkAddWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesBulkAddMembers } from "@openrouter/sdk/funcs/workspacesBulkAddMembers.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesBulkAddMembers(openRouter, { - id: "production", - bulkAddWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesBulkAddMembers failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAddWorkspaceMembersRequest](/client-sdks/typescript/api-reference/operations/bulkaddworkspacemembersrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkAddWorkspaceMembersResponse](/client-sdks/typescript/api-reference/models/bulkaddworkspacemembersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | - -## bulkRemoveMembers - -Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. [Management key](/guides/overview/auth/management-api-keys) required. - -### Example Usage - -{/* UsageSnippet language="typescript" operationID="bulkRemoveWorkspaceMembers" method="post" path="/workspaces/{id}/members/remove" */} -```typescript expandable lines -import { OpenRouter } from "@openrouter/sdk"; - -const openRouter = new OpenRouter({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const result = await openRouter.workspaces.bulkRemoveMembers({ - id: "production", - bulkRemoveWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - - console.log(result); -} - -run(); -``` - -### Standalone function - -The standalone function version of this method: - -```typescript expandable lines -import { OpenRouterCore } from "@openrouter/sdk/core.js"; -import { workspacesBulkRemoveMembers } from "@openrouter/sdk/funcs/workspacesBulkRemoveMembers.js"; - -// Use `OpenRouterCore` for best tree-shaking performance. -// You can create one instance of it to use across an application. -const openRouter = new OpenRouterCore({ - httpReferer: "", - appTitle: "", - appCategories: "", - apiKey: process.env["OPENROUTER_API_KEY"] ?? "", -}); - -async function run() { - const res = await workspacesBulkRemoveMembers(openRouter, { - id: "production", - bulkRemoveWorkspaceMembersRequest: { - userIds: [ - "user_abc123", - "user_def456", - ], - }, - }); - if (res.ok) { - const { value: result } = res; - console.log(result); - } else { - console.log("workspacesBulkRemoveMembers failed:", res.error); - } -} - -run(); -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkRemoveWorkspaceMembersRequest](/client-sdks/typescript/api-reference/operations/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](/client-sdks/typescript/api-reference/lib/retryconfig) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | - -### Response - -**Promise\<[models.BulkRemoveWorkspaceMembersResponse](/client-sdks/typescript/api-reference/models/bulkremoveworkspacemembersresponse)\>** - -### Errors - -| Error Type | Status Code | Content Type | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | -| errors.BadRequestResponseError | 400 | application/json | -| errors.UnauthorizedResponseError | 401 | application/json | -| errors.ForbiddenResponseError | 403 | application/json | -| errors.NotFoundResponseError | 404 | application/json | -| errors.InternalServerResponseError | 500 | application/json | -| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/client-sdks/typescript/assets/banner.png b/client-sdks/typescript/assets/banner.png deleted file mode 100644 index c970d60d..00000000 Binary files a/client-sdks/typescript/assets/banner.png and /dev/null differ diff --git a/client-sdks/typescript/assets/logo.svg b/client-sdks/typescript/assets/logo.svg deleted file mode 100644 index f4e6ea17..00000000 --- a/client-sdks/typescript/assets/logo.svg +++ /dev/null @@ -1,10 +0,0 @@ - - OpenRouter - - - - - - - - diff --git a/client-sdks/typescript/errors/badgatewayresponseerror.mdx b/client-sdks/typescript/errors/badgatewayresponseerror.mdx deleted file mode 100644 index 72941961..00000000 --- a/client-sdks/typescript/errors/badgatewayresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BadGatewayResponseError - TypeScript SDK -description: BadGatewayResponseError method reference -seoTitle: BadGatewayResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/badgatewayresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseError | OpenRouter TypeScript SDK -'og:description': >- - BadGatewayResponseError method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseError%20-%20TypeScript%20SDK&description=BadGatewayResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Bad Gateway - Provider/upstream API failure - -## Example Usage - -```typescript lines -import { BadGatewayResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadGatewayResponseErrorData](/client-sdks/typescript/models/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | `{"code": 502,"message": "Provider returned error"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/badrequestresponseerror.mdx b/client-sdks/typescript/errors/badrequestresponseerror.mdx deleted file mode 100644 index 719aacb1..00000000 --- a/client-sdks/typescript/errors/badrequestresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BadRequestResponseError - TypeScript SDK -description: BadRequestResponseError method reference -seoTitle: BadRequestResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/badrequestresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseError | OpenRouter TypeScript SDK -'og:description': >- - BadRequestResponseError method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseError%20-%20TypeScript%20SDK&description=BadRequestResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Bad Request - Invalid request parameters or malformed input - -## Example Usage - -```typescript lines -import { BadRequestResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadRequestResponseErrorData](/client-sdks/typescript/models/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | `{"code": 400,"message": "Invalid request parameters"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/chaterror.mdx b/client-sdks/typescript/errors/chaterror.mdx deleted file mode 100644 index 5aec7754..00000000 --- a/client-sdks/typescript/errors/chaterror.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatError - TypeScript SDK -description: ChatError method reference -seoTitle: ChatError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/chaterror' -'og:site_name': OpenRouter Documentation -'og:title': ChatError | OpenRouter TypeScript SDK -'og:description': >- - ChatError method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatError%20-%20TypeScript%20SDK&description=ChatError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `error` | [models.ChatErrorError](/client-sdks/typescript/models/chaterrorerror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/errors/edgenetworktimeoutresponseerror.mdx b/client-sdks/typescript/errors/edgenetworktimeoutresponseerror.mdx deleted file mode 100644 index 22a452ab..00000000 --- a/client-sdks/typescript/errors/edgenetworktimeoutresponseerror.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseError - TypeScript SDK -description: EdgeNetworkTimeoutResponseError method reference -seoTitle: EdgeNetworkTimeoutResponseError | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/errors/edgenetworktimeoutresponseerror -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseError | OpenRouter TypeScript SDK -'og:description': >- - EdgeNetworkTimeoutResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseError%20-%20TypeScript%20SDK&description=EdgeNetworkTimeoutResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Infrastructure Timeout - Provider request timed out at edge network - -## Example Usage - -```typescript lines -import { EdgeNetworkTimeoutResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.EdgeNetworkTimeoutResponseErrorData](/client-sdks/typescript/models/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | `{"code": 524,"message": "Request timed out. Please try again later."}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/forbiddenresponseerror.mdx b/client-sdks/typescript/errors/forbiddenresponseerror.mdx deleted file mode 100644 index 54f8c392..00000000 --- a/client-sdks/typescript/errors/forbiddenresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ForbiddenResponseError - TypeScript SDK -description: ForbiddenResponseError method reference -seoTitle: ForbiddenResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/forbiddenresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseError | OpenRouter TypeScript SDK -'og:description': >- - ForbiddenResponseError method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseError%20-%20TypeScript%20SDK&description=ForbiddenResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Forbidden - Authentication successful but insufficient permissions - -## Example Usage - -```typescript lines -import { ForbiddenResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `error` | [models.ForbiddenResponseErrorData](/client-sdks/typescript/models/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | `{"code": 403,"message": "Only provisioning keys can perform this operation"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/internalserverresponseerror.mdx b/client-sdks/typescript/errors/internalserverresponseerror.mdx deleted file mode 100644 index 873519e8..00000000 --- a/client-sdks/typescript/errors/internalserverresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: InternalServerResponseError - TypeScript SDK -description: InternalServerResponseError method reference -seoTitle: InternalServerResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/internalserverresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseError | OpenRouter TypeScript SDK -'og:description': >- - InternalServerResponseError method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseError%20-%20TypeScript%20SDK&description=InternalServerResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Internal Server Error - Unexpected server error - -## Example Usage - -```typescript lines -import { InternalServerResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.InternalServerResponseErrorData](/client-sdks/typescript/models/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | `{"code": 500,"message": "Internal Server Error"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/notfoundresponseerror.mdx b/client-sdks/typescript/errors/notfoundresponseerror.mdx deleted file mode 100644 index 316a97de..00000000 --- a/client-sdks/typescript/errors/notfoundresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: NotFoundResponseError - TypeScript SDK -description: NotFoundResponseError method reference -seoTitle: NotFoundResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/notfoundresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseError | OpenRouter TypeScript SDK -'og:description': >- - NotFoundResponseError method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseError%20-%20TypeScript%20SDK&description=NotFoundResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Not Found - Resource does not exist - -## Example Usage - -```typescript lines -import { NotFoundResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.NotFoundResponseErrorData](/client-sdks/typescript/models/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | `{"code": 404,"message": "Resource not found"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/payloadtoolargeresponseerror.mdx b/client-sdks/typescript/errors/payloadtoolargeresponseerror.mdx deleted file mode 100644 index aa1e8ef2..00000000 --- a/client-sdks/typescript/errors/payloadtoolargeresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PayloadTooLargeResponseError - TypeScript SDK -description: PayloadTooLargeResponseError method reference -seoTitle: PayloadTooLargeResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/payloadtoolargeresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseError | OpenRouter TypeScript SDK -'og:description': >- - PayloadTooLargeResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseError%20-%20TypeScript%20SDK&description=PayloadTooLargeResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Payload Too Large - Request payload exceeds size limits - -## Example Usage - -```typescript lines -import { PayloadTooLargeResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.PayloadTooLargeResponseErrorData](/client-sdks/typescript/models/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | `{"code": 413,"message": "Request payload too large"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/paymentrequiredresponseerror.mdx b/client-sdks/typescript/errors/paymentrequiredresponseerror.mdx deleted file mode 100644 index c280184a..00000000 --- a/client-sdks/typescript/errors/paymentrequiredresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PaymentRequiredResponseError - TypeScript SDK -description: PaymentRequiredResponseError method reference -seoTitle: PaymentRequiredResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/paymentrequiredresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseError | OpenRouter TypeScript SDK -'og:description': >- - PaymentRequiredResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseError%20-%20TypeScript%20SDK&description=PaymentRequiredResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Payment Required - Insufficient credits or quota to complete request - -## Example Usage - -```typescript lines -import { PaymentRequiredResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [models.PaymentRequiredResponseErrorData](/client-sdks/typescript/models/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | `{"code": 402,"message": "Insufficient credits. Add more using https://openrouter.ai/credits"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/provideroverloadedresponseerror.mdx b/client-sdks/typescript/errors/provideroverloadedresponseerror.mdx deleted file mode 100644 index 2f47db53..00000000 --- a/client-sdks/typescript/errors/provideroverloadedresponseerror.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ProviderOverloadedResponseError - TypeScript SDK -description: ProviderOverloadedResponseError method reference -seoTitle: ProviderOverloadedResponseError | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/errors/provideroverloadedresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseError | OpenRouter TypeScript SDK -'og:description': >- - ProviderOverloadedResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseError%20-%20TypeScript%20SDK&description=ProviderOverloadedResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider Overloaded - Provider is temporarily overloaded - -## Example Usage - -```typescript lines -import { ProviderOverloadedResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ProviderOverloadedResponseErrorData](/client-sdks/typescript/models/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | `{"code": 529,"message": "Provider returned error"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/requesttimeoutresponseerror.mdx b/client-sdks/typescript/errors/requesttimeoutresponseerror.mdx deleted file mode 100644 index 75292305..00000000 --- a/client-sdks/typescript/errors/requesttimeoutresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: RequestTimeoutResponseError - TypeScript SDK -description: RequestTimeoutResponseError method reference -seoTitle: RequestTimeoutResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/requesttimeoutresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseError | OpenRouter TypeScript SDK -'og:description': >- - RequestTimeoutResponseError method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseError%20-%20TypeScript%20SDK&description=RequestTimeoutResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request Timeout - Operation exceeded time limit - -## Example Usage - -```typescript lines -import { RequestTimeoutResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.RequestTimeoutResponseErrorData](/client-sdks/typescript/models/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | `{"code": 408,"message": "Operation timed out. Please try again later."}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/serviceunavailableresponseerror.mdx b/client-sdks/typescript/errors/serviceunavailableresponseerror.mdx deleted file mode 100644 index d54be2bb..00000000 --- a/client-sdks/typescript/errors/serviceunavailableresponseerror.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ServiceUnavailableResponseError - TypeScript SDK -description: ServiceUnavailableResponseError method reference -seoTitle: ServiceUnavailableResponseError | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/errors/serviceunavailableresponseerror -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseError | OpenRouter TypeScript SDK -'og:description': >- - ServiceUnavailableResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseError%20-%20TypeScript%20SDK&description=ServiceUnavailableResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Service Unavailable - Service temporarily unavailable - -## Example Usage - -```typescript lines -import { ServiceUnavailableResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ServiceUnavailableResponseErrorData](/client-sdks/typescript/models/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | `{"code": 503,"message": "Service temporarily unavailable"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/toomanyrequestsresponseerror.mdx b/client-sdks/typescript/errors/toomanyrequestsresponseerror.mdx deleted file mode 100644 index 729a5451..00000000 --- a/client-sdks/typescript/errors/toomanyrequestsresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: TooManyRequestsResponseError - TypeScript SDK -description: TooManyRequestsResponseError method reference -seoTitle: TooManyRequestsResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/toomanyrequestsresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseError | OpenRouter TypeScript SDK -'og:description': >- - TooManyRequestsResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseError%20-%20TypeScript%20SDK&description=TooManyRequestsResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Too Many Requests - Rate limit exceeded - -## Example Usage - -```typescript lines -import { TooManyRequestsResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.TooManyRequestsResponseErrorData](/client-sdks/typescript/models/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | `{"code": 429,"message": "Rate limit exceeded"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/unauthorizedresponseerror.mdx b/client-sdks/typescript/errors/unauthorizedresponseerror.mdx deleted file mode 100644 index dc38154e..00000000 --- a/client-sdks/typescript/errors/unauthorizedresponseerror.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: UnauthorizedResponseError - TypeScript SDK -description: UnauthorizedResponseError method reference -seoTitle: UnauthorizedResponseError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/errors/unauthorizedresponseerror' -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseError | OpenRouter TypeScript SDK -'og:description': >- - UnauthorizedResponseError method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseError%20-%20TypeScript%20SDK&description=UnauthorizedResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unauthorized - Authentication required or invalid credentials - -## Example Usage - -```typescript lines -import { UnauthorizedResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `error` | [models.UnauthorizedResponseErrorData](/client-sdks/typescript/models/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | `{"code": 401,"message": "Missing Authentication header"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/errors/unprocessableentityresponseerror.mdx b/client-sdks/typescript/errors/unprocessableentityresponseerror.mdx deleted file mode 100644 index cfa23ce6..00000000 --- a/client-sdks/typescript/errors/unprocessableentityresponseerror.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UnprocessableEntityResponseError - TypeScript SDK -description: UnprocessableEntityResponseError method reference -seoTitle: UnprocessableEntityResponseError | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/errors/unprocessableentityresponseerror -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseError | OpenRouter TypeScript SDK -'og:description': >- - UnprocessableEntityResponseError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseError%20-%20TypeScript%20SDK&description=UnprocessableEntityResponseError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unprocessable Entity - Semantic validation failure - -## Example Usage - -```typescript lines -import { UnprocessableEntityResponseError } from "@openrouter/sdk/models/errors"; - -// No examples available for this model -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `error` | [models.UnprocessableEntityResponseErrorData](/client-sdks/typescript/models/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | `{"code": 422,"message": "Invalid argument"}` | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/lib/retryconfig.mdx b/client-sdks/typescript/lib/retryconfig.mdx deleted file mode 100644 index b7c18f56..00000000 --- a/client-sdks/typescript/lib/retryconfig.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: RetryConfig - TypeScript SDK -description: RetryConfig method reference -seoTitle: RetryConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/lib/retryconfig' -'og:site_name': OpenRouter Documentation -'og:title': RetryConfig | OpenRouter TypeScript SDK -'og:description': >- - RetryConfig method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RetryConfig%20-%20TypeScript%20SDK&description=RetryConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies. - -## Fields - -| Name | Type | Description | Example | -| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- | -| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` | -| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | | -| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` | - -## BackoffStrategy - -The backoff strategy allows retrying a request with an exponential backoff between each retry. - -### Fields - -| Name | Type | Description | Example | -| ------------------ | ------------ | ----------------------------------------- | -------- | -| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` | -| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` | -| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` | -| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` | \ No newline at end of file diff --git a/client-sdks/typescript/models/activityitem.mdx b/client-sdks/typescript/models/activityitem.mdx deleted file mode 100644 index 072e9c80..00000000 --- a/client-sdks/typescript/models/activityitem.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: ActivityItem - TypeScript SDK -description: ActivityItem method reference -seoTitle: ActivityItem | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/activityitem' -'og:site_name': OpenRouter Documentation -'og:title': ActivityItem | OpenRouter TypeScript SDK -'og:description': >- - ActivityItem method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ActivityItem%20-%20TypeScript%20SDK&description=ActivityItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ActivityItem } from "@openrouter/sdk/models"; - -let value: ActivityItem = { - date: "2025-08-24", - model: "openai/gpt-4.1", - modelPermaslug: "openai/gpt-4.1-2025-04-14", - endpointId: "550e8400-e29b-41d4-a716-446655440000", - providerName: "OpenAI", - usage: 0.015, - byokUsageInference: 0.012, - requests: 5, - promptTokens: 50, - completionTokens: 125, - reasoningTokens: 25, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `date` | *string* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `model` | *string* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `endpointId` | *string* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `usage` | *number* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `byokUsageInference` | *number* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `requests` | *number* | :heavy_check_mark: | Number of requests made | 5 | -| `promptTokens` | *number* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `completionTokens` | *number* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `reasoningTokens` | *number* | :heavy_check_mark: | Total reasoning tokens used | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/models/architecture.mdx b/client-sdks/typescript/models/architecture.mdx deleted file mode 100644 index f0992912..00000000 --- a/client-sdks/typescript/models/architecture.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Architecture - TypeScript SDK -description: Architecture method reference -seoTitle: Architecture | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/architecture' -'og:site_name': OpenRouter Documentation -'og:title': Architecture | OpenRouter TypeScript SDK -'og:description': >- - Architecture method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Architecture%20-%20TypeScript%20SDK&description=Architecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Example Usage - -```typescript lines -import { Architecture } from "@openrouter/sdk/models"; - -let value: Architecture = { - tokenizer: "GPT", - instructType: "chatml", - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `tokenizer` | [models.Tokenizer](/client-sdks/typescript/models/tokenizer) | :heavy_check_mark: | N/A | GPT | -| `instructType` | [models.InstructType](/client-sdks/typescript/models/instructtype) | :heavy_check_mark: | Instruction format type | | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text | -| `inputModalities` | [models.InputModality](/client-sdks/typescript/models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | -| `outputModalities` | [models.OutputModality](/client-sdks/typescript/models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | \ No newline at end of file diff --git a/client-sdks/typescript/models/assistantmessage.mdx b/client-sdks/typescript/models/assistantmessage.mdx deleted file mode 100644 index da9aec0f..00000000 --- a/client-sdks/typescript/models/assistantmessage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: AssistantMessage - TypeScript SDK -description: AssistantMessage method reference -seoTitle: AssistantMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/assistantmessage' -'og:site_name': OpenRouter Documentation -'og:title': AssistantMessage | OpenRouter TypeScript SDK -'og:description': >- - AssistantMessage method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AssistantMessage%20-%20TypeScript%20SDK&description=AssistantMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { AssistantMessage } from "@openrouter/sdk/models"; - -let value: AssistantMessage = { - role: "assistant", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `role` | *"assistant"* | :heavy_check_mark: | N/A | -| `content` | *models.AssistantMessageContent* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `toolCalls` | [models.ChatMessageToolCall](/client-sdks/typescript/models/chatmessagetoolcall)[] | :heavy_minus_sign: | N/A | -| `refusal` | *string* | :heavy_minus_sign: | N/A | -| `reasoning` | *string* | :heavy_minus_sign: | N/A | -| `reasoningDetails` | *models.Schema2*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/assistantmessagecontent.mdx b/client-sdks/typescript/models/assistantmessagecontent.mdx deleted file mode 100644 index dc3964a5..00000000 --- a/client-sdks/typescript/models/assistantmessagecontent.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: AssistantMessageContent - TypeScript SDK -description: AssistantMessageContent method reference -seoTitle: AssistantMessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/assistantmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': AssistantMessageContent | OpenRouter TypeScript SDK -'og:description': >- - AssistantMessageContent method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=AssistantMessageContent%20-%20TypeScript%20SDK&description=AssistantMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatMessageContentItem[]` - -```typescript lines -const value: models.ChatMessageContentItem[] = [ - { - type: "image_url", - imageUrl: { - url: "https://pretty-reservation.org", - }, - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/badgatewayresponseerrordata.mdx b/client-sdks/typescript/models/badgatewayresponseerrordata.mdx deleted file mode 100644 index 36198fec..00000000 --- a/client-sdks/typescript/models/badgatewayresponseerrordata.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BadGatewayResponseErrorData - TypeScript SDK -description: BadGatewayResponseErrorData method reference -seoTitle: BadGatewayResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/badgatewayresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': BadGatewayResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - BadGatewayResponseErrorData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadGatewayResponseErrorData%20-%20TypeScript%20SDK&description=BadGatewayResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for BadGatewayResponse - -## Example Usage - -```typescript lines -import { BadGatewayResponseErrorData } from "@openrouter/sdk/models"; - -let value: BadGatewayResponseErrorData = { - code: 502, - message: "Provider returned error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/badrequestresponseerrordata.mdx b/client-sdks/typescript/models/badrequestresponseerrordata.mdx deleted file mode 100644 index 7a04fdde..00000000 --- a/client-sdks/typescript/models/badrequestresponseerrordata.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BadRequestResponseErrorData - TypeScript SDK -description: BadRequestResponseErrorData method reference -seoTitle: BadRequestResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/badrequestresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': BadRequestResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - BadRequestResponseErrorData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BadRequestResponseErrorData%20-%20TypeScript%20SDK&description=BadRequestResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for BadRequestResponse - -## Example Usage - -```typescript lines -import { BadRequestResponseErrorData } from "@openrouter/sdk/models"; - -let value: BadRequestResponseErrorData = { - code: 400, - message: "Invalid request parameters", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chainid.mdx b/client-sdks/typescript/models/chainid.mdx deleted file mode 100644 index 0751e729..00000000 --- a/client-sdks/typescript/models/chainid.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChainId - TypeScript SDK -description: ChainId method reference -seoTitle: ChainId | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chainid' -'og:site_name': OpenRouter Documentation -'og:title': ChainId | OpenRouter TypeScript SDK -'og:description': >- - ChainId method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChainId%20-%20TypeScript%20SDK&description=ChainId%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChainId } from "@openrouter/sdk/models"; - -let value: ChainId = 137; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -1 | 137 | 8453 | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatcompletionfinishreason.mdx b/client-sdks/typescript/models/chatcompletionfinishreason.mdx deleted file mode 100644 index 1d22a7bc..00000000 --- a/client-sdks/typescript/models/chatcompletionfinishreason.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatCompletionFinishReason - TypeScript SDK -description: ChatCompletionFinishReason method reference -seoTitle: ChatCompletionFinishReason | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatcompletionfinishreason' -'og:site_name': OpenRouter Documentation -'og:title': ChatCompletionFinishReason | OpenRouter TypeScript SDK -'og:description': >- - ChatCompletionFinishReason method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatCompletionFinishReason%20-%20TypeScript%20SDK&description=ChatCompletionFinishReason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatCompletionFinishReason } from "@openrouter/sdk/models"; - -let value: ChatCompletionFinishReason = "error"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"tool_calls" | "stop" | "length" | "content_filter" | "error" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chaterrorerror.mdx b/client-sdks/typescript/models/chaterrorerror.mdx deleted file mode 100644 index 4cabb6b1..00000000 --- a/client-sdks/typescript/models/chaterrorerror.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatErrorError - TypeScript SDK -description: ChatErrorError method reference -seoTitle: ChatErrorError | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chaterrorerror' -'og:site_name': OpenRouter Documentation -'og:title': ChatErrorError | OpenRouter TypeScript SDK -'og:description': >- - ChatErrorError method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatErrorError%20-%20TypeScript%20SDK&description=ChatErrorError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatErrorError } from "@openrouter/sdk/models"; - -let value: ChatErrorError = { - code: "", - message: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *models.Code* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `param` | *string* | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparams.mdx b/client-sdks/typescript/models/chatgenerationparams.mdx deleted file mode 100644 index fbdbd0ee..00000000 --- a/client-sdks/typescript/models/chatgenerationparams.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: ChatGenerationParams - TypeScript SDK -description: ChatGenerationParams method reference -seoTitle: ChatGenerationParams | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatgenerationparams' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParams | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParams method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParams%20-%20TypeScript%20SDK&description=ChatGenerationParams%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParams } from "@openrouter/sdk/models"; - -let value: ChatGenerationParams = { - messages: [ - { - role: "system", - content: "", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `provider` | [models.ChatGenerationParamsProvider](/client-sdks/typescript/models/chatgenerationparamsprovider) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | -| `plugins` | *models.ChatGenerationParamsPluginUnion*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | -| `route` | [models.Route](/client-sdks/typescript/models/route) | :heavy_minus_sign: | N/A | -| `user` | *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) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | -| `messages` | *models.Message*[] | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `models` | *string*[] | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `logitBias` | `Record` | :heavy_minus_sign: | N/A | -| `logprobs` | *boolean* | :heavy_minus_sign: | N/A | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `reasoning` | [models.Reasoning](/client-sdks/typescript/models/reasoning) | :heavy_minus_sign: | N/A | -| `responseFormat` | *models.ChatGenerationParamsResponseFormatUnion* | :heavy_minus_sign: | N/A | -| `seed` | *number* | :heavy_minus_sign: | N/A | -| `stop` | *models.ChatGenerationParamsStop* | :heavy_minus_sign: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `streamOptions` | [models.ChatStreamOptions](/client-sdks/typescript/models/chatstreamoptions) | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `toolChoice` | *any* | :heavy_minus_sign: | N/A | -| `tools` | [models.ToolDefinitionJson](/client-sdks/typescript/models/tooldefinitionjson)[] | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `debug` | [models.Debug](/client-sdks/typescript/models/debug) | :heavy_minus_sign: | N/A | -| `imageConfig` | `Record` | :heavy_minus_sign: | N/A | -| `modalities` | [models.Modality](/client-sdks/typescript/models/modality)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsdatacollection.mdx b/client-sdks/typescript/models/chatgenerationparamsdatacollection.mdx deleted file mode 100644 index 5ca6b862..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsdatacollection.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatGenerationParamsDataCollection - TypeScript SDK -description: ChatGenerationParamsDataCollection method reference -seoTitle: ChatGenerationParamsDataCollection | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsdatacollection -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsDataCollection | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsDataCollection method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsDataCollection%20-%20TypeScript%20SDK&description=ChatGenerationParamsDataCollection%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsDataCollection } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsDataCollection = "allow"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"deny" | "allow" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsimageconfig.mdx b/client-sdks/typescript/models/chatgenerationparamsimageconfig.mdx deleted file mode 100644 index 1975d5a1..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsimageconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatGenerationParamsImageConfig - TypeScript SDK -description: ChatGenerationParamsImageConfig method reference -seoTitle: ChatGenerationParamsImageConfig | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsimageconfig -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsImageConfig | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsImageConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsImageConfig%20-%20TypeScript%20SDK&description=ChatGenerationParamsImageConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsmaxprice.mdx b/client-sdks/typescript/models/chatgenerationparamsmaxprice.mdx deleted file mode 100644 index 4e7070b3..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsmaxprice.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatGenerationParamsMaxPrice - TypeScript SDK -description: ChatGenerationParamsMaxPrice method reference -seoTitle: ChatGenerationParamsMaxPrice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatgenerationparamsmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsMaxPrice | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsMaxPrice method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsMaxPrice%20-%20TypeScript%20SDK&description=ChatGenerationParamsMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Example Usage - -```typescript lines -import { ChatGenerationParamsMaxPrice } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsMaxPrice = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `prompt` | *any* | :heavy_minus_sign: | N/A | -| `completion` | *any* | :heavy_minus_sign: | N/A | -| `image` | *any* | :heavy_minus_sign: | N/A | -| `audio` | *any* | :heavy_minus_sign: | N/A | -| `request` | *any* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginautorouter.mdx b/client-sdks/typescript/models/chatgenerationparamspluginautorouter.mdx deleted file mode 100644 index 1f074049..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginautorouter.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatGenerationParamsPluginAutoRouter - TypeScript SDK -description: ChatGenerationParamsPluginAutoRouter method reference -seoTitle: ChatGenerationParamsPluginAutoRouter | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginautorouter -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginAutoRouter | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginAutoRouter method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginAutoRouter%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginAutoRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPluginAutoRouter } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPluginAutoRouter = { - id: "auto-router", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *"auto-router"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `allowedModels` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginfileparser.mdx b/client-sdks/typescript/models/chatgenerationparamspluginfileparser.mdx deleted file mode 100644 index fe8912e8..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginfileparser.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatGenerationParamsPluginFileParser - TypeScript SDK -description: ChatGenerationParamsPluginFileParser method reference -seoTitle: ChatGenerationParamsPluginFileParser | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginfileparser -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginFileParser | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginFileParser method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginFileParser%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginFileParser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPluginFileParser } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPluginFileParser = { - id: "file-parser", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `id` | *"file-parser"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `pdf` | [models.Pdf](/client-sdks/typescript/models/pdf) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginmoderation.mdx b/client-sdks/typescript/models/chatgenerationparamspluginmoderation.mdx deleted file mode 100644 index e5408ddf..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginmoderation.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatGenerationParamsPluginModeration - TypeScript SDK -description: ChatGenerationParamsPluginModeration method reference -seoTitle: ChatGenerationParamsPluginModeration | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginmoderation -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginModeration | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginModeration method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginModeration%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginModeration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPluginModeration } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPluginModeration = { - id: "moderation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *"moderation"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginresponsehealing.mdx b/client-sdks/typescript/models/chatgenerationparamspluginresponsehealing.mdx deleted file mode 100644 index a3cbb748..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginresponsehealing.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatGenerationParamsPluginResponseHealing - TypeScript SDK -description: ChatGenerationParamsPluginResponseHealing method reference -seoTitle: ChatGenerationParamsPluginResponseHealing | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginresponsehealing -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginResponseHealing | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginResponseHealing method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginResponseHealing%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginResponseHealing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPluginResponseHealing } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPluginResponseHealing = { - id: "response-healing", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------- | -------------------- | -------------------- | -------------------- | -| `id` | *"response-healing"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginunion.mdx b/client-sdks/typescript/models/chatgenerationparamspluginunion.mdx deleted file mode 100644 index f85cf48e..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginunion.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ChatGenerationParamsPluginUnion - TypeScript SDK -description: ChatGenerationParamsPluginUnion method reference -seoTitle: ChatGenerationParamsPluginUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginUnion | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginUnion%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatGenerationParamsPluginAutoRouter` - -```typescript lines -const value: models.ChatGenerationParamsPluginAutoRouter = { - id: "auto-router", -}; -``` - -### `models.ChatGenerationParamsPluginModeration` - -```typescript lines -const value: models.ChatGenerationParamsPluginModeration = { - id: "moderation", -}; -``` - -### `models.ChatGenerationParamsPluginWeb` - -```typescript lines -const value: models.ChatGenerationParamsPluginWeb = { - id: "web", -}; -``` - -### `models.ChatGenerationParamsPluginFileParser` - -```typescript lines -const value: models.ChatGenerationParamsPluginFileParser = { - id: "file-parser", -}; -``` - -### `models.ChatGenerationParamsPluginResponseHealing` - -```typescript lines -const value: models.ChatGenerationParamsPluginResponseHealing = { - id: "response-healing", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspluginweb.mdx b/client-sdks/typescript/models/chatgenerationparamspluginweb.mdx deleted file mode 100644 index 4eb6e8b6..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspluginweb.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatGenerationParamsPluginWeb - TypeScript SDK -description: ChatGenerationParamsPluginWeb method reference -seoTitle: ChatGenerationParamsPluginWeb | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspluginweb -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPluginWeb | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPluginWeb method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPluginWeb%20-%20TypeScript%20SDK&description=ChatGenerationParamsPluginWeb%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPluginWeb } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPluginWeb = { - id: "web", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *"web"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `maxResults` | *number* | :heavy_minus_sign: | N/A | -| `searchPrompt` | *string* | :heavy_minus_sign: | N/A | -| `engine` | [models.Engine](/client-sdks/typescript/models/engine) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatency.mdx b/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatency.mdx deleted file mode 100644 index 822b81c5..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatency.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMaxLatency - TypeScript SDK -description: ChatGenerationParamsPreferredMaxLatency method reference -seoTitle: ChatGenerationParamsPreferredMaxLatency | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspreferredmaxlatency -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMaxLatency | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPreferredMaxLatency method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMaxLatency%20-%20TypeScript%20SDK&description=ChatGenerationParamsPreferredMaxLatency%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPreferredMaxLatency } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPreferredMaxLatency = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `p50` | *number* | :heavy_minus_sign: | N/A | -| `p75` | *number* | :heavy_minus_sign: | N/A | -| `p90` | *number* | :heavy_minus_sign: | N/A | -| `p99` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatencyunion.mdx b/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatencyunion.mdx deleted file mode 100644 index a8a85a28..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspreferredmaxlatencyunion.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMaxLatencyUnion - TypeScript SDK -description: ChatGenerationParamsPreferredMaxLatencyUnion method reference -seoTitle: ChatGenerationParamsPreferredMaxLatencyUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspreferredmaxlatencyunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMaxLatencyUnion | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPreferredMaxLatencyUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMaxLatencyUnion%20-%20TypeScript%20SDK&description=ChatGenerationParamsPreferredMaxLatencyUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `number` - -```typescript lines -const value: number = 1284.03; -``` - -### `models.ChatGenerationParamsPreferredMaxLatency` - -```typescript lines -const value: models.ChatGenerationParamsPreferredMaxLatency = {}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspreferredminthroughput.mdx b/client-sdks/typescript/models/chatgenerationparamspreferredminthroughput.mdx deleted file mode 100644 index 0e45f4cf..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspreferredminthroughput.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMinThroughput - TypeScript SDK -description: ChatGenerationParamsPreferredMinThroughput method reference -seoTitle: ChatGenerationParamsPreferredMinThroughput | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspreferredminthroughput -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMinThroughput | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPreferredMinThroughput method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMinThroughput%20-%20TypeScript%20SDK&description=ChatGenerationParamsPreferredMinThroughput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsPreferredMinThroughput } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsPreferredMinThroughput = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `p50` | *number* | :heavy_minus_sign: | N/A | -| `p75` | *number* | :heavy_minus_sign: | N/A | -| `p90` | *number* | :heavy_minus_sign: | N/A | -| `p99` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamspreferredminthroughputunion.mdx b/client-sdks/typescript/models/chatgenerationparamspreferredminthroughputunion.mdx deleted file mode 100644 index b87d59dd..00000000 --- a/client-sdks/typescript/models/chatgenerationparamspreferredminthroughputunion.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatGenerationParamsPreferredMinThroughputUnion - TypeScript SDK -description: ChatGenerationParamsPreferredMinThroughputUnion method reference -seoTitle: ChatGenerationParamsPreferredMinThroughputUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamspreferredminthroughputunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsPreferredMinThroughputUnion | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsPreferredMinThroughputUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsPreferredMinThroughputUnion%20-%20TypeScript%20SDK&description=ChatGenerationParamsPreferredMinThroughputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `number` - -```typescript lines -const value: number = 1284.03; -``` - -### `models.ChatGenerationParamsPreferredMinThroughput` - -```typescript lines -const value: models.ChatGenerationParamsPreferredMinThroughput = {}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsprovider.mdx b/client-sdks/typescript/models/chatgenerationparamsprovider.mdx deleted file mode 100644 index 9e594e9a..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsprovider.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ChatGenerationParamsProvider - TypeScript SDK -description: ChatGenerationParamsProvider method reference -seoTitle: ChatGenerationParamsProvider | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatgenerationparamsprovider' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsProvider | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsProvider method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsProvider%20-%20TypeScript%20SDK&description=ChatGenerationParamsProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsProvider } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsProvider = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve `requests
`- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| -| `requireParameters` | *boolean* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | -| `dataCollection` | [models.ChatGenerationParamsDataCollection](/client-sdks/typescript/models/chatgenerationparamsdatacollection) | :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. | -| `zdr` | *boolean* | :heavy_minus_sign: | N/A | -| `enforceDistillableText` | *boolean* | :heavy_minus_sign: | N/A | -| `order` | *models.Schema0*[] | :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. | -| `only` | *models.Schema0*[] | :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. | -| `ignore` | *models.Schema0*[] | :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. | -| `quantizations` | [models.Quantizations](/client-sdks/typescript/models/quantizations)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | -| `sort` | *models.ProviderSortUnion* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | -| `maxPrice` | [models.ChatGenerationParamsMaxPrice](/client-sdks/typescript/models/chatgenerationparamsmaxprice) | :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. | -| `preferredMinThroughput` | *models.ChatGenerationParamsPreferredMinThroughputUnion* | :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. | -| `preferredMaxLatency` | *models.ChatGenerationParamsPreferredMaxLatencyUnion* | :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. | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsresponseformatjsonobject.mdx b/client-sdks/typescript/models/chatgenerationparamsresponseformatjsonobject.mdx deleted file mode 100644 index 42805381..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsresponseformatjsonobject.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatJSONObject - TypeScript SDK -description: ChatGenerationParamsResponseFormatJSONObject method reference -seoTitle: ChatGenerationParamsResponseFormatJSONObject | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsresponseformatjsonobject -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatJSONObject | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsResponseFormatJSONObject method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatJSONObject%20-%20TypeScript%20SDK&description=ChatGenerationParamsResponseFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsResponseFormatJSONObject } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsResponseFormatJSONObject = { - type: "json_object", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsresponseformatpython.mdx b/client-sdks/typescript/models/chatgenerationparamsresponseformatpython.mdx deleted file mode 100644 index aafb967f..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsresponseformatpython.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatPython - TypeScript SDK -description: ChatGenerationParamsResponseFormatPython method reference -seoTitle: ChatGenerationParamsResponseFormatPython | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsresponseformatpython -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatPython | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsResponseFormatPython method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatPython%20-%20TypeScript%20SDK&description=ChatGenerationParamsResponseFormatPython%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsResponseFormatPython } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsResponseFormatPython = { - type: "python", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"python"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsresponseformattext.mdx b/client-sdks/typescript/models/chatgenerationparamsresponseformattext.mdx deleted file mode 100644 index b70b03af..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsresponseformattext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatText - TypeScript SDK -description: ChatGenerationParamsResponseFormatText method reference -seoTitle: ChatGenerationParamsResponseFormatText | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsresponseformattext -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatText | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsResponseFormatText method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatText%20-%20TypeScript%20SDK&description=ChatGenerationParamsResponseFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationParamsResponseFormatText } from "@openrouter/sdk/models"; - -let value: ChatGenerationParamsResponseFormatText = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsresponseformatunion.mdx b/client-sdks/typescript/models/chatgenerationparamsresponseformatunion.mdx deleted file mode 100644 index 22cca988..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsresponseformatunion.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: ChatGenerationParamsResponseFormatUnion - TypeScript SDK -description: ChatGenerationParamsResponseFormatUnion method reference -seoTitle: ChatGenerationParamsResponseFormatUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatgenerationparamsresponseformatunion -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsResponseFormatUnion | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsResponseFormatUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsResponseFormatUnion%20-%20TypeScript%20SDK&description=ChatGenerationParamsResponseFormatUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatGenerationParamsResponseFormatText` - -```typescript lines -const value: models.ChatGenerationParamsResponseFormatText = { - type: "text", -}; -``` - -### `models.ChatGenerationParamsResponseFormatJSONObject` - -```typescript lines -const value: models.ChatGenerationParamsResponseFormatJSONObject = { - type: "json_object", -}; -``` - -### `models.ResponseFormatJSONSchema` - -```typescript lines -const value: models.ResponseFormatJSONSchema = { - type: "json_schema", - jsonSchema: { - name: "", - }, -}; -``` - -### `models.ResponseFormatTextGrammar` - -```typescript lines -const value: models.ResponseFormatTextGrammar = { - type: "grammar", - grammar: "", -}; -``` - -### `models.ChatGenerationParamsResponseFormatPython` - -```typescript lines -const value: models.ChatGenerationParamsResponseFormatPython = { - type: "python", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationparamsstop.mdx b/client-sdks/typescript/models/chatgenerationparamsstop.mdx deleted file mode 100644 index a2f3e2d5..00000000 --- a/client-sdks/typescript/models/chatgenerationparamsstop.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatGenerationParamsStop - TypeScript SDK -description: ChatGenerationParamsStop method reference -seoTitle: ChatGenerationParamsStop | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatgenerationparamsstop' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationParamsStop | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationParamsStop method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationParamsStop%20-%20TypeScript%20SDK&description=ChatGenerationParamsStop%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatgenerationtokenusage.mdx b/client-sdks/typescript/models/chatgenerationtokenusage.mdx deleted file mode 100644 index e017371d..00000000 --- a/client-sdks/typescript/models/chatgenerationtokenusage.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ChatGenerationTokenUsage - TypeScript SDK -description: ChatGenerationTokenUsage method reference -seoTitle: ChatGenerationTokenUsage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatgenerationtokenusage' -'og:site_name': OpenRouter Documentation -'og:title': ChatGenerationTokenUsage | OpenRouter TypeScript SDK -'og:description': >- - ChatGenerationTokenUsage method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatGenerationTokenUsage%20-%20TypeScript%20SDK&description=ChatGenerationTokenUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatGenerationTokenUsage } from "@openrouter/sdk/models"; - -let value: ChatGenerationTokenUsage = { - completionTokens: 9399.77, - promptTokens: 9559.6, - totalTokens: 7060.03, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | N/A | -| `promptTokens` | *number* | :heavy_check_mark: | N/A | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | -| `completionTokensDetails` | [models.CompletionTokensDetails](/client-sdks/typescript/models/completiontokensdetails) | :heavy_minus_sign: | N/A | -| `promptTokensDetails` | [models.PromptTokensDetails](/client-sdks/typescript/models/prompttokensdetails) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitem.mdx b/client-sdks/typescript/models/chatmessagecontentitem.mdx deleted file mode 100644 index a7be8ae5..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitem.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: ChatMessageContentItem - TypeScript SDK -description: ChatMessageContentItem method reference -seoTitle: ChatMessageContentItem | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagecontentitem' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItem | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItem method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItem%20-%20TypeScript%20SDK&description=ChatMessageContentItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatMessageContentItemText` - -```typescript lines -const value: models.ChatMessageContentItemText = { - type: "text", - text: "", -}; -``` - -### `models.ChatMessageContentItemImage` - -```typescript lines -const value: models.ChatMessageContentItemImage = { - type: "image_url", - imageUrl: { - url: "https://pretty-reservation.org", - }, -}; -``` - -### `models.ChatMessageContentItemAudio` - -```typescript lines -const value: models.ChatMessageContentItemAudio = { - type: "input_audio", - inputAudio: { - data: "", - format: "", - }, -}; -``` - -### `models.ChatMessageContentItemVideo` - -```typescript lines -const value: models.ChatMessageContentItemVideo = { - type: "video_url", - videoUrl: { - url: "https://palatable-subexpression.com/", - }, -}; -``` - -### `models.ChatMessageContentItemVideo` - -```typescript lines -const value: models.ChatMessageContentItemVideo = { - type: "video_url", - videoUrl: { - url: "https://palatable-subexpression.com/", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemaudio.mdx b/client-sdks/typescript/models/chatmessagecontentitemaudio.mdx deleted file mode 100644 index e6d5ea4b..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemaudio.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatMessageContentItemAudio - TypeScript SDK -description: ChatMessageContentItemAudio method reference -seoTitle: ChatMessageContentItemAudio | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagecontentitemaudio' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemAudio | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemAudio method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemAudio%20-%20TypeScript%20SDK&description=ChatMessageContentItemAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemAudio } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemAudio = { - type: "input_audio", - inputAudio: { - data: "", - format: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | -| `inputAudio` | [models.ChatMessageContentItemAudioInputAudio](/client-sdks/typescript/models/chatmessagecontentitemaudioinputaudio) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemaudioinputaudio.mdx b/client-sdks/typescript/models/chatmessagecontentitemaudioinputaudio.mdx deleted file mode 100644 index 096baf52..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemaudioinputaudio.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatMessageContentItemAudioInputAudio - TypeScript SDK -description: ChatMessageContentItemAudioInputAudio method reference -seoTitle: ChatMessageContentItemAudioInputAudio | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagecontentitemaudioinputaudio -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemAudioInputAudio | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemAudioInputAudio method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemAudioInputAudio%20-%20TypeScript%20SDK&description=ChatMessageContentItemAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemAudioInputAudio } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemAudioInputAudio = { - data: "", - format: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemcachecontrol.mdx b/client-sdks/typescript/models/chatmessagecontentitemcachecontrol.mdx deleted file mode 100644 index 0c7e1735..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemcachecontrol.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatMessageContentItemCacheControl - TypeScript SDK -description: ChatMessageContentItemCacheControl method reference -seoTitle: ChatMessageContentItemCacheControl | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagecontentitemcachecontrol -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemCacheControl | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemCacheControl method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemCacheControl%20-%20TypeScript%20SDK&description=ChatMessageContentItemCacheControl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemCacheControl } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemCacheControl = { - type: "ephemeral", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `type` | *"ephemeral"* | :heavy_check_mark: | N/A | -| `ttl` | [models.Ttl](/client-sdks/typescript/models/ttl) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemimage.mdx b/client-sdks/typescript/models/chatmessagecontentitemimage.mdx deleted file mode 100644 index 141327c2..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemimage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ChatMessageContentItemImage - TypeScript SDK -description: ChatMessageContentItemImage method reference -seoTitle: ChatMessageContentItemImage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagecontentitemimage' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemImage | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemImage method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemImage%20-%20TypeScript%20SDK&description=ChatMessageContentItemImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemImage } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemImage = { - type: "image_url", - imageUrl: { - url: "https://pretty-reservation.org", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | -| `imageUrl` | [models.ImageUrl](/client-sdks/typescript/models/imageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemimagedetail.mdx b/client-sdks/typescript/models/chatmessagecontentitemimagedetail.mdx deleted file mode 100644 index bf8620c3..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemimagedetail.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ChatMessageContentItemImageDetail - TypeScript SDK -description: ChatMessageContentItemImageDetail method reference -seoTitle: ChatMessageContentItemImageDetail | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagecontentitemimagedetail -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemImageDetail | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemImageDetail method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemImageDetail%20-%20TypeScript%20SDK&description=ChatMessageContentItemImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemImageDetail } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemImageDetail = "low"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "low" | "high" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemtext.mdx b/client-sdks/typescript/models/chatmessagecontentitemtext.mdx deleted file mode 100644 index 703d5767..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemtext.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatMessageContentItemText - TypeScript SDK -description: ChatMessageContentItemText method reference -seoTitle: ChatMessageContentItemText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagecontentitemtext' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemText | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemText method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemText%20-%20TypeScript%20SDK&description=ChatMessageContentItemText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemText } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemText = { - type: "text", - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | *"text"* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `cacheControl` | [models.ChatMessageContentItemCacheControl](/client-sdks/typescript/models/chatmessagecontentitemcachecontrol) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemvideo.mdx b/client-sdks/typescript/models/chatmessagecontentitemvideo.mdx deleted file mode 100644 index ad7466c7..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemvideo.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ChatMessageContentItemVideo - TypeScript SDK -description: ChatMessageContentItemVideo method reference -seoTitle: ChatMessageContentItemVideo | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagecontentitemvideo' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideo | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemVideo method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideo%20-%20TypeScript%20SDK&description=ChatMessageContentItemVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatMessageContentItemVideoInputVideo` - -```typescript lines -const value: models.ChatMessageContentItemVideoInputVideo = { - type: "input_video", - videoUrl: { - url: "https://salty-diversity.biz", - }, -}; -``` - -### `models.ChatMessageContentItemVideoVideoURL` - -```typescript lines -const value: models.ChatMessageContentItemVideoVideoURL = { - type: "video_url", - videoUrl: { - url: "https://palatable-subexpression.com/", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemvideoinputvideo.mdx b/client-sdks/typescript/models/chatmessagecontentitemvideoinputvideo.mdx deleted file mode 100644 index 022a9c12..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemvideoinputvideo.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatMessageContentItemVideoInputVideo - TypeScript SDK -description: ChatMessageContentItemVideoInputVideo method reference -seoTitle: ChatMessageContentItemVideoInputVideo | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagecontentitemvideoinputvideo -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideoInputVideo | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemVideoInputVideo method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideoInputVideo%20-%20TypeScript%20SDK&description=ChatMessageContentItemVideoInputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemVideoInputVideo } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemVideoInputVideo = { - type: "input_video", - videoUrl: { - url: "https://salty-diversity.biz", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | -| `videoUrl` | [models.VideoUrl1](/client-sdks/typescript/models/videourl1) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagecontentitemvideovideourl.mdx b/client-sdks/typescript/models/chatmessagecontentitemvideovideourl.mdx deleted file mode 100644 index 0b7e7b24..00000000 --- a/client-sdks/typescript/models/chatmessagecontentitemvideovideourl.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatMessageContentItemVideoVideoURL - TypeScript SDK -description: ChatMessageContentItemVideoVideoURL method reference -seoTitle: ChatMessageContentItemVideoVideoURL | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagecontentitemvideovideourl -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageContentItemVideoVideoURL | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageContentItemVideoVideoURL method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageContentItemVideoVideoURL%20-%20TypeScript%20SDK&description=ChatMessageContentItemVideoVideoURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageContentItemVideoVideoURL } from "@openrouter/sdk/models"; - -let value: ChatMessageContentItemVideoVideoURL = { - type: "video_url", - videoUrl: { - url: "https://palatable-subexpression.com/", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `type` | *"video_url"* | :heavy_check_mark: | N/A | -| `videoUrl` | [models.VideoUrl2](/client-sdks/typescript/models/videourl2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagetokenlogprob.mdx b/client-sdks/typescript/models/chatmessagetokenlogprob.mdx deleted file mode 100644 index 56811a6a..00000000 --- a/client-sdks/typescript/models/chatmessagetokenlogprob.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ChatMessageTokenLogprob - TypeScript SDK -description: ChatMessageTokenLogprob method reference -seoTitle: ChatMessageTokenLogprob | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagetokenlogprob' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprob | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageTokenLogprob method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprob%20-%20TypeScript%20SDK&description=ChatMessageTokenLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageTokenLogprob } from "@openrouter/sdk/models"; - -let value: ChatMessageTokenLogprob = { - token: "", - logprob: 8717.76, - bytes: [], - topLogprobs: [ - { - token: "", - logprob: 9715.54, - bytes: [ - 7041.35, - ], - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `token` | *string* | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ChatMessageTokenLogprobTopLogprob](/client-sdks/typescript/models/chatmessagetokenlogprobtoplogprob)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagetokenlogprobs.mdx b/client-sdks/typescript/models/chatmessagetokenlogprobs.mdx deleted file mode 100644 index 7268b10b..00000000 --- a/client-sdks/typescript/models/chatmessagetokenlogprobs.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ChatMessageTokenLogprobs - TypeScript SDK -description: ChatMessageTokenLogprobs method reference -seoTitle: ChatMessageTokenLogprobs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagetokenlogprobs' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprobs | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageTokenLogprobs method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprobs%20-%20TypeScript%20SDK&description=ChatMessageTokenLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ChatMessageTokenLogprobs } from "@openrouter/sdk/models"; - -let value: ChatMessageTokenLogprobs = { - content: [ - { - token: "", - logprob: 2764.68, - bytes: [ - 1199.17, - 6426.57, - ], - topLogprobs: [ - { - token: "", - logprob: 9715.54, - bytes: [ - 7041.35, - ], - }, - ], - }, - ], - refusal: [ - { - token: "", - logprob: 9280.35, - bytes: [], - topLogprobs: [], - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `content` | [models.ChatMessageTokenLogprob](/client-sdks/typescript/models/chatmessagetokenlogprob)[] | :heavy_check_mark: | N/A | -| `refusal` | [models.ChatMessageTokenLogprob](/client-sdks/typescript/models/chatmessagetokenlogprob)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagetokenlogprobtoplogprob.mdx b/client-sdks/typescript/models/chatmessagetokenlogprobtoplogprob.mdx deleted file mode 100644 index 8273eae7..00000000 --- a/client-sdks/typescript/models/chatmessagetokenlogprobtoplogprob.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatMessageTokenLogprobTopLogprob - TypeScript SDK -description: ChatMessageTokenLogprobTopLogprob method reference -seoTitle: ChatMessageTokenLogprobTopLogprob | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatmessagetokenlogprobtoplogprob -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageTokenLogprobTopLogprob | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageTokenLogprobTopLogprob method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageTokenLogprobTopLogprob%20-%20TypeScript%20SDK&description=ChatMessageTokenLogprobTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageTokenLogprobTopLogprob } from "@openrouter/sdk/models"; - -let value: ChatMessageTokenLogprobTopLogprob = { - token: "", - logprob: 6197.03, - bytes: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *string* | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagetoolcall.mdx b/client-sdks/typescript/models/chatmessagetoolcall.mdx deleted file mode 100644 index f1e80e34..00000000 --- a/client-sdks/typescript/models/chatmessagetoolcall.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatMessageToolCall - TypeScript SDK -description: ChatMessageToolCall method reference -seoTitle: ChatMessageToolCall | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagetoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageToolCall | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageToolCall method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageToolCall%20-%20TypeScript%20SDK&description=ChatMessageToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageToolCall } from "@openrouter/sdk/models"; - -let value: ChatMessageToolCall = { - id: "", - type: "function", - function: { - name: "", - arguments: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | *"function"* | :heavy_check_mark: | N/A | -| `function` | [models.ChatMessageToolCallFunction](/client-sdks/typescript/models/chatmessagetoolcallfunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatmessagetoolcallfunction.mdx b/client-sdks/typescript/models/chatmessagetoolcallfunction.mdx deleted file mode 100644 index 64b055f9..00000000 --- a/client-sdks/typescript/models/chatmessagetoolcallfunction.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ChatMessageToolCallFunction - TypeScript SDK -description: ChatMessageToolCallFunction method reference -seoTitle: ChatMessageToolCallFunction | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatmessagetoolcallfunction' -'og:site_name': OpenRouter Documentation -'og:title': ChatMessageToolCallFunction | OpenRouter TypeScript SDK -'og:description': >- - ChatMessageToolCallFunction method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatMessageToolCallFunction%20-%20TypeScript%20SDK&description=ChatMessageToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatMessageToolCallFunction } from "@openrouter/sdk/models"; - -let value: ChatMessageToolCallFunction = { - name: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatresponse.mdx b/client-sdks/typescript/models/chatresponse.mdx deleted file mode 100644 index d7f8c510..00000000 --- a/client-sdks/typescript/models/chatresponse.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ChatResponse - TypeScript SDK -description: ChatResponse method reference -seoTitle: ChatResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatresponse' -'og:site_name': OpenRouter Documentation -'og:title': ChatResponse | OpenRouter TypeScript SDK -'og:description': >- - ChatResponse method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResponse%20-%20TypeScript%20SDK&description=ChatResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatResponse } from "@openrouter/sdk/models"; - -let value: ChatResponse = { - id: "", - choices: [], - created: 9184.01, - model: "Focus", - object: "chat.completion", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `choices` | [models.ChatResponseChoice](/client-sdks/typescript/models/chatresponsechoice)[] | :heavy_check_mark: | N/A | -| `created` | *number* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `object` | *"chat.completion"* | :heavy_check_mark: | N/A | -| `systemFingerprint` | *string* | :heavy_minus_sign: | N/A | -| `usage` | [models.ChatGenerationTokenUsage](/client-sdks/typescript/models/chatgenerationtokenusage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatresponsechoice.mdx b/client-sdks/typescript/models/chatresponsechoice.mdx deleted file mode 100644 index bffebb5d..00000000 --- a/client-sdks/typescript/models/chatresponsechoice.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ChatResponseChoice - TypeScript SDK -description: ChatResponseChoice method reference -seoTitle: ChatResponseChoice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatresponsechoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatResponseChoice | OpenRouter TypeScript SDK -'og:description': >- - ChatResponseChoice method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatResponseChoice%20-%20TypeScript%20SDK&description=ChatResponseChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatResponseChoice } from "@openrouter/sdk/models"; - -let value: ChatResponseChoice = { - finishReason: "stop", - index: 2823.76, - message: { - role: "assistant", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `finishReason` | [models.ChatCompletionFinishReason](/client-sdks/typescript/models/chatcompletionfinishreason) | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `message` | [models.AssistantMessage](/client-sdks/typescript/models/assistantmessage) | :heavy_check_mark: | N/A | -| `logprobs` | [models.ChatMessageTokenLogprobs](/client-sdks/typescript/models/chatmessagetokenlogprobs) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingchoice.mdx b/client-sdks/typescript/models/chatstreamingchoice.mdx deleted file mode 100644 index 8884ef18..00000000 --- a/client-sdks/typescript/models/chatstreamingchoice.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ChatStreamingChoice - TypeScript SDK -description: ChatStreamingChoice method reference -seoTitle: ChatStreamingChoice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatstreamingchoice' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingChoice | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingChoice method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingChoice%20-%20TypeScript%20SDK&description=ChatStreamingChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingChoice } from "@openrouter/sdk/models"; - -let value: ChatStreamingChoice = { - delta: {}, - finishReason: "error", - index: 3511.86, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `delta` | [models.ChatStreamingMessageChunk](/client-sdks/typescript/models/chatstreamingmessagechunk) | :heavy_check_mark: | N/A | -| `finishReason` | [models.ChatCompletionFinishReason](/client-sdks/typescript/models/chatcompletionfinishreason) | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `logprobs` | [models.ChatMessageTokenLogprobs](/client-sdks/typescript/models/chatmessagetokenlogprobs) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingmessagechunk.mdx b/client-sdks/typescript/models/chatstreamingmessagechunk.mdx deleted file mode 100644 index 7cdff498..00000000 --- a/client-sdks/typescript/models/chatstreamingmessagechunk.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamingMessageChunk - TypeScript SDK -description: ChatStreamingMessageChunk method reference -seoTitle: ChatStreamingMessageChunk | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatstreamingmessagechunk' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageChunk | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingMessageChunk method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageChunk%20-%20TypeScript%20SDK&description=ChatStreamingMessageChunk%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingMessageChunk } from "@openrouter/sdk/models"; - -let value: ChatStreamingMessageChunk = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `role` | [models.ChatStreamingMessageChunkRole](/client-sdks/typescript/models/chatstreamingmessagechunkrole) | :heavy_minus_sign: | N/A | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `reasoning` | *string* | :heavy_minus_sign: | N/A | -| `refusal` | *string* | :heavy_minus_sign: | N/A | -| `toolCalls` | [models.ChatStreamingMessageToolCall](/client-sdks/typescript/models/chatstreamingmessagetoolcall)[] | :heavy_minus_sign: | N/A | -| `reasoningDetails` | *models.Schema2*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingmessagechunkrole.mdx b/client-sdks/typescript/models/chatstreamingmessagechunkrole.mdx deleted file mode 100644 index 9b8194fe..00000000 --- a/client-sdks/typescript/models/chatstreamingmessagechunkrole.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ChatStreamingMessageChunkRole - TypeScript SDK -description: ChatStreamingMessageChunkRole method reference -seoTitle: ChatStreamingMessageChunkRole | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatstreamingmessagechunkrole -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageChunkRole | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingMessageChunkRole method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageChunkRole%20-%20TypeScript%20SDK&description=ChatStreamingMessageChunkRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingMessageChunkRole } from "@openrouter/sdk/models"; - -let value: ChatStreamingMessageChunkRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingmessagetoolcall.mdx b/client-sdks/typescript/models/chatstreamingmessagetoolcall.mdx deleted file mode 100644 index 26ddc500..00000000 --- a/client-sdks/typescript/models/chatstreamingmessagetoolcall.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamingMessageToolCall - TypeScript SDK -description: ChatStreamingMessageToolCall method reference -seoTitle: ChatStreamingMessageToolCall | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatstreamingmessagetoolcall' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageToolCall | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingMessageToolCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageToolCall%20-%20TypeScript%20SDK&description=ChatStreamingMessageToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingMessageToolCall } from "@openrouter/sdk/models"; - -let value: ChatStreamingMessageToolCall = { - index: 3974.82, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `index` | *number* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"function"* | :heavy_minus_sign: | N/A | -| `function` | [models.ChatStreamingMessageToolCallFunction](/client-sdks/typescript/models/chatstreamingmessagetoolcallfunction) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingmessagetoolcallfunction.mdx b/client-sdks/typescript/models/chatstreamingmessagetoolcallfunction.mdx deleted file mode 100644 index b86a7548..00000000 --- a/client-sdks/typescript/models/chatstreamingmessagetoolcallfunction.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ChatStreamingMessageToolCallFunction - TypeScript SDK -description: ChatStreamingMessageToolCallFunction method reference -seoTitle: ChatStreamingMessageToolCallFunction | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatstreamingmessagetoolcallfunction -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingMessageToolCallFunction | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingMessageToolCallFunction method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingMessageToolCallFunction%20-%20TypeScript%20SDK&description=ChatStreamingMessageToolCallFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingMessageToolCallFunction } from "@openrouter/sdk/models"; - -let value: ChatStreamingMessageToolCallFunction = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_minus_sign: | N/A | -| `arguments` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingresponsechunk.mdx b/client-sdks/typescript/models/chatstreamingresponsechunk.mdx deleted file mode 100644 index 3d861ac2..00000000 --- a/client-sdks/typescript/models/chatstreamingresponsechunk.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatStreamingResponseChunk - TypeScript SDK -description: ChatStreamingResponseChunk method reference -seoTitle: ChatStreamingResponseChunk | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatstreamingresponsechunk' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunk | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingResponseChunk method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunk%20-%20TypeScript%20SDK&description=ChatStreamingResponseChunk%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingResponseChunk } from "@openrouter/sdk/models"; - -let value: ChatStreamingResponseChunk = { - data: { - id: "", - choices: [ - { - delta: {}, - finishReason: "error", - index: 3793.72, - }, - ], - created: 932.78, - model: "Ranchero", - object: "chat.completion.chunk", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `data` | [models.ChatStreamingResponseChunkData](/client-sdks/typescript/models/chatstreamingresponsechunkdata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingresponsechunkdata.mdx b/client-sdks/typescript/models/chatstreamingresponsechunkdata.mdx deleted file mode 100644 index ce94c81d..00000000 --- a/client-sdks/typescript/models/chatstreamingresponsechunkdata.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ChatStreamingResponseChunkData - TypeScript SDK -description: ChatStreamingResponseChunkData method reference -seoTitle: ChatStreamingResponseChunkData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatstreamingresponsechunkdata -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunkData | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingResponseChunkData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunkData%20-%20TypeScript%20SDK&description=ChatStreamingResponseChunkData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingResponseChunkData } from "@openrouter/sdk/models"; - -let value: ChatStreamingResponseChunkData = { - id: "", - choices: [], - created: 3957.6, - model: "F-150", - object: "chat.completion.chunk", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `choices` | [models.ChatStreamingChoice](/client-sdks/typescript/models/chatstreamingchoice)[] | :heavy_check_mark: | N/A | -| `created` | *number* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `object` | *"chat.completion.chunk"* | :heavy_check_mark: | N/A | -| `systemFingerprint` | *string* | :heavy_minus_sign: | N/A | -| `error` | [models.ChatStreamingResponseChunkError](/client-sdks/typescript/models/chatstreamingresponsechunkerror) | :heavy_minus_sign: | N/A | -| `usage` | [models.ChatGenerationTokenUsage](/client-sdks/typescript/models/chatgenerationtokenusage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamingresponsechunkerror.mdx b/client-sdks/typescript/models/chatstreamingresponsechunkerror.mdx deleted file mode 100644 index 23d7571e..00000000 --- a/client-sdks/typescript/models/chatstreamingresponsechunkerror.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ChatStreamingResponseChunkError - TypeScript SDK -description: ChatStreamingResponseChunkError method reference -seoTitle: ChatStreamingResponseChunkError | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/chatstreamingresponsechunkerror -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamingResponseChunkError | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamingResponseChunkError method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamingResponseChunkError%20-%20TypeScript%20SDK&description=ChatStreamingResponseChunkError%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamingResponseChunkError } from "@openrouter/sdk/models"; - -let value: ChatStreamingResponseChunkError = { - message: "", - code: 669.92, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *string* | :heavy_check_mark: | N/A | -| `code` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/chatstreamoptions.mdx b/client-sdks/typescript/models/chatstreamoptions.mdx deleted file mode 100644 index 0308db4c..00000000 --- a/client-sdks/typescript/models/chatstreamoptions.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ChatStreamOptions - TypeScript SDK -description: ChatStreamOptions method reference -seoTitle: ChatStreamOptions | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/chatstreamoptions' -'og:site_name': OpenRouter Documentation -'og:title': ChatStreamOptions | OpenRouter TypeScript SDK -'og:description': >- - ChatStreamOptions method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ChatStreamOptions%20-%20TypeScript%20SDK&description=ChatStreamOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ChatStreamOptions } from "@openrouter/sdk/models"; - -let value: ChatStreamOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `includeUsage` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/code.mdx b/client-sdks/typescript/models/code.mdx deleted file mode 100644 index e45a207a..00000000 --- a/client-sdks/typescript/models/code.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Code - TypeScript SDK -description: Code method reference -seoTitle: Code | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/code' -'og:site_name': OpenRouter Documentation -'og:title': Code | OpenRouter TypeScript SDK -'og:description': >- - Code method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Code%20-%20TypeScript%20SDK&description=Code%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/codeenum.mdx b/client-sdks/typescript/models/codeenum.mdx deleted file mode 100644 index c2f10443..00000000 --- a/client-sdks/typescript/models/codeenum.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CodeEnum - TypeScript SDK -description: CodeEnum method reference -seoTitle: CodeEnum | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/codeenum' -'og:site_name': OpenRouter Documentation -'og:title': CodeEnum | OpenRouter TypeScript SDK -'og:description': >- - CodeEnum method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CodeEnum%20-%20TypeScript%20SDK&description=CodeEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CodeEnum } from "@openrouter/sdk/models"; - -let value: CodeEnum = "unsupported_image_media_type"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"server_error" | "rate_limit_exceeded" | "invalid_prompt" | "vector_store_timeout" | "invalid_image" | "invalid_image_format" | "invalid_base64_image" | "invalid_image_url" | "image_too_large" | "image_too_small" | "image_parse_error" | "image_content_policy_violation" | "invalid_image_mode" | "image_file_too_large" | "unsupported_image_media_type" | "empty_image_file" | "failed_to_download_image" | "image_file_not_found" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/completionchoice.mdx b/client-sdks/typescript/models/completionchoice.mdx deleted file mode 100644 index 0ae98f34..00000000 --- a/client-sdks/typescript/models/completionchoice.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: CompletionChoice - TypeScript SDK -description: CompletionChoice method reference -seoTitle: CompletionChoice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completionchoice' -'og:site_name': OpenRouter Documentation -'og:title': CompletionChoice | OpenRouter TypeScript SDK -'og:description': >- - CompletionChoice method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionChoice%20-%20TypeScript%20SDK&description=CompletionChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { CompletionChoice } from "@openrouter/sdk/models"; - -let value: CompletionChoice = { - text: "", - index: 7493.1, - logprobs: { - tokens: [ - "", - ], - tokenLogprobs: [ - 7640.5, - 1771.28, - ], - topLogprobs: [], - textOffset: [ - 3937.38, - 9605.77, - ], - }, - finishReason: "length", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `logprobs` | [models.CompletionLogprobs](/client-sdks/typescript/models/completionlogprobs) | :heavy_check_mark: | N/A | -| `finishReason` | [models.CompletionFinishReason](/client-sdks/typescript/models/completionfinishreason) | :heavy_check_mark: | N/A | -| `nativeFinishReason` | *string* | :heavy_minus_sign: | N/A | -| `reasoning` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparams.mdx b/client-sdks/typescript/models/completioncreateparams.mdx deleted file mode 100644 index 6ac20a98..00000000 --- a/client-sdks/typescript/models/completioncreateparams.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: CompletionCreateParams - TypeScript SDK -description: CompletionCreateParams method reference -seoTitle: CompletionCreateParams | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completioncreateparams' -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParams | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParams method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParams%20-%20TypeScript%20SDK&description=CompletionCreateParams%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionCreateParams } from "@openrouter/sdk/models"; - -let value: CompletionCreateParams = { - prompt: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `models` | *string*[] | :heavy_minus_sign: | N/A | -| `prompt` | *models.Prompt* | :heavy_check_mark: | N/A | -| `bestOf` | *number* | :heavy_minus_sign: | N/A | -| `echo` | *boolean* | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `logitBias` | `Record` | :heavy_minus_sign: | N/A | -| `logprobs` | *number* | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `n` | *number* | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `seed` | *number* | :heavy_minus_sign: | N/A | -| `stop` | *models.CompletionCreateParamsStop* | :heavy_minus_sign: | N/A | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | -| `streamOptions` | [models.StreamOptions](/client-sdks/typescript/models/streamoptions) | :heavy_minus_sign: | N/A | -| `suffix` | *string* | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | -| `responseFormat` | *models.CompletionCreateParamsResponseFormatUnion* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparamsresponseformatjsonobject.mdx b/client-sdks/typescript/models/completioncreateparamsresponseformatjsonobject.mdx deleted file mode 100644 index a681915c..00000000 --- a/client-sdks/typescript/models/completioncreateparamsresponseformatjsonobject.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatJSONObject - TypeScript SDK -description: CompletionCreateParamsResponseFormatJSONObject method reference -seoTitle: CompletionCreateParamsResponseFormatJSONObject | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/completioncreateparamsresponseformatjsonobject -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatJSONObject | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParamsResponseFormatJSONObject method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatJSONObject%20-%20TypeScript%20SDK&description=CompletionCreateParamsResponseFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionCreateParamsResponseFormatJSONObject } from "@openrouter/sdk/models"; - -let value: CompletionCreateParamsResponseFormatJSONObject = { - type: "json_object", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparamsresponseformatpython.mdx b/client-sdks/typescript/models/completioncreateparamsresponseformatpython.mdx deleted file mode 100644 index e46e4b50..00000000 --- a/client-sdks/typescript/models/completioncreateparamsresponseformatpython.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatPython - TypeScript SDK -description: CompletionCreateParamsResponseFormatPython method reference -seoTitle: CompletionCreateParamsResponseFormatPython | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/completioncreateparamsresponseformatpython -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatPython | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParamsResponseFormatPython method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatPython%20-%20TypeScript%20SDK&description=CompletionCreateParamsResponseFormatPython%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionCreateParamsResponseFormatPython } from "@openrouter/sdk/models"; - -let value: CompletionCreateParamsResponseFormatPython = { - type: "python", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"python"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparamsresponseformattext.mdx b/client-sdks/typescript/models/completioncreateparamsresponseformattext.mdx deleted file mode 100644 index 2f9ba260..00000000 --- a/client-sdks/typescript/models/completioncreateparamsresponseformattext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatText - TypeScript SDK -description: CompletionCreateParamsResponseFormatText method reference -seoTitle: CompletionCreateParamsResponseFormatText | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/completioncreateparamsresponseformattext -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatText | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParamsResponseFormatText method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatText%20-%20TypeScript%20SDK&description=CompletionCreateParamsResponseFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionCreateParamsResponseFormatText } from "@openrouter/sdk/models"; - -let value: CompletionCreateParamsResponseFormatText = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparamsresponseformatunion.mdx b/client-sdks/typescript/models/completioncreateparamsresponseformatunion.mdx deleted file mode 100644 index 5d8a6663..00000000 --- a/client-sdks/typescript/models/completioncreateparamsresponseformatunion.mdx +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: CompletionCreateParamsResponseFormatUnion - TypeScript SDK -description: CompletionCreateParamsResponseFormatUnion method reference -seoTitle: CompletionCreateParamsResponseFormatUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/completioncreateparamsresponseformatunion -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsResponseFormatUnion | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParamsResponseFormatUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsResponseFormatUnion%20-%20TypeScript%20SDK&description=CompletionCreateParamsResponseFormatUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.CompletionCreateParamsResponseFormatText` - -```typescript lines -const value: models.CompletionCreateParamsResponseFormatText = { - type: "text", -}; -``` - -### `models.CompletionCreateParamsResponseFormatJSONObject` - -```typescript lines -const value: models.CompletionCreateParamsResponseFormatJSONObject = { - type: "json_object", -}; -``` - -### `models.ResponseFormatJSONSchema` - -```typescript lines -const value: models.ResponseFormatJSONSchema = { - type: "json_schema", - jsonSchema: { - name: "", - }, -}; -``` - -### `models.ResponseFormatTextGrammar` - -```typescript lines -const value: models.ResponseFormatTextGrammar = { - type: "grammar", - grammar: "", -}; -``` - -### `models.CompletionCreateParamsResponseFormatPython` - -```typescript lines -const value: models.CompletionCreateParamsResponseFormatPython = { - type: "python", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/completioncreateparamsstop.mdx b/client-sdks/typescript/models/completioncreateparamsstop.mdx deleted file mode 100644 index d57aa510..00000000 --- a/client-sdks/typescript/models/completioncreateparamsstop.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CompletionCreateParamsStop - TypeScript SDK -description: CompletionCreateParamsStop method reference -seoTitle: CompletionCreateParamsStop | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completioncreateparamsstop' -'og:site_name': OpenRouter Documentation -'og:title': CompletionCreateParamsStop | OpenRouter TypeScript SDK -'og:description': >- - CompletionCreateParamsStop method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionCreateParamsStop%20-%20TypeScript%20SDK&description=CompletionCreateParamsStop%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/completionfinishreason.mdx b/client-sdks/typescript/models/completionfinishreason.mdx deleted file mode 100644 index b285855e..00000000 --- a/client-sdks/typescript/models/completionfinishreason.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: CompletionFinishReason - TypeScript SDK -description: CompletionFinishReason method reference -seoTitle: CompletionFinishReason | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completionfinishreason' -'og:site_name': OpenRouter Documentation -'og:title': CompletionFinishReason | OpenRouter TypeScript SDK -'og:description': >- - CompletionFinishReason method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionFinishReason%20-%20TypeScript%20SDK&description=CompletionFinishReason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionFinishReason } from "@openrouter/sdk/models"; - -let value: CompletionFinishReason = "length"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"stop" | "length" | "content_filter" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/completionlogprobs.mdx b/client-sdks/typescript/models/completionlogprobs.mdx deleted file mode 100644 index 7694f91f..00000000 --- a/client-sdks/typescript/models/completionlogprobs.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: CompletionLogprobs - TypeScript SDK -description: CompletionLogprobs method reference -seoTitle: CompletionLogprobs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completionlogprobs' -'og:site_name': OpenRouter Documentation -'og:title': CompletionLogprobs | OpenRouter TypeScript SDK -'og:description': >- - CompletionLogprobs method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionLogprobs%20-%20TypeScript%20SDK&description=CompletionLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionLogprobs } from "@openrouter/sdk/models"; - -let value: CompletionLogprobs = { - tokens: [ - "", - "", - "", - ], - tokenLogprobs: [ - 2988.44, - 7128.75, - 8377.63, - ], - topLogprobs: null, - textOffset: [ - 1144.74, - 3297.78, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `tokens` | *string*[] | :heavy_check_mark: | N/A | -| `tokenLogprobs` | *number*[] | :heavy_check_mark: | N/A | -| `topLogprobs` | `Record`[] | :heavy_check_mark: | N/A | -| `textOffset` | *number*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completionresponse.mdx b/client-sdks/typescript/models/completionresponse.mdx deleted file mode 100644 index 1e0fc666..00000000 --- a/client-sdks/typescript/models/completionresponse.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: CompletionResponse - TypeScript SDK -description: CompletionResponse method reference -seoTitle: CompletionResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completionresponse' -'og:site_name': OpenRouter Documentation -'og:title': CompletionResponse | OpenRouter TypeScript SDK -'og:description': >- - CompletionResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionResponse%20-%20TypeScript%20SDK&description=CompletionResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionResponse } from "@openrouter/sdk/models"; - -let value: CompletionResponse = { - id: "", - object: "text_completion", - created: 7985.17, - model: "Taurus", - choices: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | *"text_completion"* | :heavy_check_mark: | N/A | -| `created` | *number* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_minus_sign: | N/A | -| `systemFingerprint` | *string* | :heavy_minus_sign: | N/A | -| `choices` | [models.CompletionChoice](/client-sdks/typescript/models/completionchoice)[] | :heavy_check_mark: | N/A | -| `usage` | [models.CompletionUsage](/client-sdks/typescript/models/completionusage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completiontokensdetails.mdx b/client-sdks/typescript/models/completiontokensdetails.mdx deleted file mode 100644 index 5f78d2b9..00000000 --- a/client-sdks/typescript/models/completiontokensdetails.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CompletionTokensDetails - TypeScript SDK -description: CompletionTokensDetails method reference -seoTitle: CompletionTokensDetails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completiontokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': CompletionTokensDetails | OpenRouter TypeScript SDK -'og:description': >- - CompletionTokensDetails method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionTokensDetails%20-%20TypeScript%20SDK&description=CompletionTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionTokensDetails } from "@openrouter/sdk/models"; - -let value: CompletionTokensDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `reasoningTokens` | *number* | :heavy_minus_sign: | N/A | -| `audioTokens` | *number* | :heavy_minus_sign: | N/A | -| `acceptedPredictionTokens` | *number* | :heavy_minus_sign: | N/A | -| `rejectedPredictionTokens` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/completionusage.mdx b/client-sdks/typescript/models/completionusage.mdx deleted file mode 100644 index bf6fcaa4..00000000 --- a/client-sdks/typescript/models/completionusage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CompletionUsage - TypeScript SDK -description: CompletionUsage method reference -seoTitle: CompletionUsage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/completionusage' -'og:site_name': OpenRouter Documentation -'og:title': CompletionUsage | OpenRouter TypeScript SDK -'og:description': >- - CompletionUsage method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CompletionUsage%20-%20TypeScript%20SDK&description=CompletionUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CompletionUsage } from "@openrouter/sdk/models"; - -let value: CompletionUsage = { - promptTokens: 3945.12, - completionTokens: 7037.32, - totalTokens: 1194.53, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `promptTokens` | *number* | :heavy_check_mark: | N/A | -| `completionTokens` | *number* | :heavy_check_mark: | N/A | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/costdetails.mdx b/client-sdks/typescript/models/costdetails.mdx deleted file mode 100644 index ca3716a1..00000000 --- a/client-sdks/typescript/models/costdetails.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: CostDetails - TypeScript SDK -description: CostDetails method reference -seoTitle: CostDetails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/costdetails' -'og:site_name': OpenRouter Documentation -'og:title': CostDetails | OpenRouter TypeScript SDK -'og:description': >- - CostDetails method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CostDetails%20-%20TypeScript%20SDK&description=CostDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CostDetails } from "@openrouter/sdk/models"; - -let value: CostDetails = { - upstreamInferenceInputCost: 5717.43, - upstreamInferenceOutputCost: 5806.85, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `upstreamInferenceCost` | *number* | :heavy_minus_sign: | N/A | -| `upstreamInferenceInputCost` | *number* | :heavy_check_mark: | N/A | -| `upstreamInferenceOutputCost` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/createchargerequest.mdx b/client-sdks/typescript/models/createchargerequest.mdx deleted file mode 100644 index 91dc440e..00000000 --- a/client-sdks/typescript/models/createchargerequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateChargeRequest - TypeScript SDK -description: CreateChargeRequest method reference -seoTitle: CreateChargeRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/createchargerequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateChargeRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateChargeRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateChargeRequest%20-%20TypeScript%20SDK&description=CreateChargeRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Create a Coinbase charge for crypto payment - -## Example Usage - -```typescript lines -import { CreateChargeRequest } from "@openrouter/sdk/models"; - -let value: CreateChargeRequest = { - amount: 100, - sender: "0x1234567890123456789012345678901234567890", - chainId: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `amount` | *number* | :heavy_check_mark: | N/A | -| `sender` | *string* | :heavy_check_mark: | N/A | -| `chainId` | [models.ChainId](/client-sdks/typescript/models/chainid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/datacollection.mdx b/client-sdks/typescript/models/datacollection.mdx deleted file mode 100644 index a5c51db1..00000000 --- a/client-sdks/typescript/models/datacollection.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: DataCollection - TypeScript SDK -description: DataCollection method reference -seoTitle: DataCollection | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/datacollection' -'og:site_name': OpenRouter Documentation -'og:title': DataCollection | OpenRouter TypeScript SDK -'og:description': >- - DataCollection method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DataCollection%20-%20TypeScript%20SDK&description=DataCollection%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { DataCollection } from "@openrouter/sdk/models"; - -let value: DataCollection = "allow"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"deny" | "allow" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/debug.mdx b/client-sdks/typescript/models/debug.mdx deleted file mode 100644 index 99c39016..00000000 --- a/client-sdks/typescript/models/debug.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Debug - TypeScript SDK -description: Debug method reference -seoTitle: Debug | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/debug' -'og:site_name': OpenRouter Documentation -'og:title': Debug | OpenRouter TypeScript SDK -'og:description': >- - Debug method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Debug%20-%20TypeScript%20SDK&description=Debug%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Debug } from "@openrouter/sdk/models"; - -let value: Debug = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `echoUpstreamBody` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/defaultparameters.mdx b/client-sdks/typescript/models/defaultparameters.mdx deleted file mode 100644 index cdb55554..00000000 --- a/client-sdks/typescript/models/defaultparameters.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DefaultParameters - TypeScript SDK -description: DefaultParameters method reference -seoTitle: DefaultParameters | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/defaultparameters' -'og:site_name': OpenRouter Documentation -'og:title': DefaultParameters | OpenRouter TypeScript SDK -'og:description': >- - DefaultParameters method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DefaultParameters%20-%20TypeScript%20SDK&description=DefaultParameters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Default parameters for this model - -## Example Usage - -```typescript lines -import { DefaultParameters } from "@openrouter/sdk/models"; - -let value: DefaultParameters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/edgenetworktimeoutresponseerrordata.mdx b/client-sdks/typescript/models/edgenetworktimeoutresponseerrordata.mdx deleted file mode 100644 index 094ac13c..00000000 --- a/client-sdks/typescript/models/edgenetworktimeoutresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: EdgeNetworkTimeoutResponseErrorData - TypeScript SDK -description: EdgeNetworkTimeoutResponseErrorData method reference -seoTitle: EdgeNetworkTimeoutResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/edgenetworktimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': EdgeNetworkTimeoutResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - EdgeNetworkTimeoutResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EdgeNetworkTimeoutResponseErrorData%20-%20TypeScript%20SDK&description=EdgeNetworkTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for EdgeNetworkTimeoutResponse - -## Example Usage - -```typescript lines -import { EdgeNetworkTimeoutResponseErrorData } from "@openrouter/sdk/models"; - -let value: EdgeNetworkTimeoutResponseErrorData = { - code: 524, - message: "Request timed out. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/effort.mdx b/client-sdks/typescript/models/effort.mdx deleted file mode 100644 index 5b8b2f8d..00000000 --- a/client-sdks/typescript/models/effort.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Effort - TypeScript SDK -description: Effort method reference -seoTitle: Effort | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/effort' -'og:site_name': OpenRouter Documentation -'og:title': Effort | OpenRouter TypeScript SDK -'og:description': >- - Effort method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Effort%20-%20TypeScript%20SDK&description=Effort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Effort } from "@openrouter/sdk/models"; - -let value: Effort = "high"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"xhigh" | "high" | "medium" | "low" | "minimal" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/endpointstatus.mdx b/client-sdks/typescript/models/endpointstatus.mdx deleted file mode 100644 index 52b2d586..00000000 --- a/client-sdks/typescript/models/endpointstatus.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EndpointStatus - TypeScript SDK -description: EndpointStatus method reference -seoTitle: EndpointStatus | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/endpointstatus' -'og:site_name': OpenRouter Documentation -'og:title': EndpointStatus | OpenRouter TypeScript SDK -'og:description': >- - EndpointStatus method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EndpointStatus%20-%20TypeScript%20SDK&description=EndpointStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EndpointStatus } from "@openrouter/sdk/models"; - -let value: EndpointStatus = 0; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -0 | -1 | -2 | -3 | -5 | -10 | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/engine.mdx b/client-sdks/typescript/models/engine.mdx deleted file mode 100644 index 7b0fa316..00000000 --- a/client-sdks/typescript/models/engine.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Engine - TypeScript SDK -description: Engine method reference -seoTitle: Engine | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/engine' -'og:site_name': OpenRouter Documentation -'og:title': Engine | OpenRouter TypeScript SDK -'og:description': >- - Engine method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Engine%20-%20TypeScript%20SDK&description=Engine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Engine } from "@openrouter/sdk/models"; - -let value: Engine = "exa"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"native" | "exa" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/filecitation.mdx b/client-sdks/typescript/models/filecitation.mdx deleted file mode 100644 index 48b64344..00000000 --- a/client-sdks/typescript/models/filecitation.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: FileCitation - TypeScript SDK -description: FileCitation method reference -seoTitle: FileCitation | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/filecitation' -'og:site_name': OpenRouter Documentation -'og:title': FileCitation | OpenRouter TypeScript SDK -'og:description': >- - FileCitation method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FileCitation%20-%20TypeScript%20SDK&description=FileCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FileCitation } from "@openrouter/sdk/models"; - -let value: FileCitation = { - type: "file_citation", - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"file_citation"* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/filepath.mdx b/client-sdks/typescript/models/filepath.mdx deleted file mode 100644 index a05eb8b2..00000000 --- a/client-sdks/typescript/models/filepath.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: FilePath - TypeScript SDK -description: FilePath method reference -seoTitle: FilePath | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/filepath' -'og:site_name': OpenRouter Documentation -'og:title': FilePath | OpenRouter TypeScript SDK -'og:description': >- - FilePath method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=FilePath%20-%20TypeScript%20SDK&description=FilePath%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { FilePath } from "@openrouter/sdk/models"; - -let value: FilePath = { - type: "file_path", - fileId: "file-xyz789", - index: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"file_path"* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/forbiddenresponseerrordata.mdx b/client-sdks/typescript/models/forbiddenresponseerrordata.mdx deleted file mode 100644 index 4060f7ec..00000000 --- a/client-sdks/typescript/models/forbiddenresponseerrordata.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ForbiddenResponseErrorData - TypeScript SDK -description: ForbiddenResponseErrorData method reference -seoTitle: ForbiddenResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/forbiddenresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': ForbiddenResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - ForbiddenResponseErrorData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ForbiddenResponseErrorData%20-%20TypeScript%20SDK&description=ForbiddenResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ForbiddenResponse - -## Example Usage - -```typescript lines -import { ForbiddenResponseErrorData } from "@openrouter/sdk/models"; - -let value: ForbiddenResponseErrorData = { - code: 403, - message: "Only provisioning keys can perform this operation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/imagegenerationstatus.mdx b/client-sdks/typescript/models/imagegenerationstatus.mdx deleted file mode 100644 index bdf297c0..00000000 --- a/client-sdks/typescript/models/imagegenerationstatus.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ImageGenerationStatus - TypeScript SDK -description: ImageGenerationStatus method reference -seoTitle: ImageGenerationStatus | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/imagegenerationstatus' -'og:site_name': OpenRouter Documentation -'og:title': ImageGenerationStatus | OpenRouter TypeScript SDK -'og:description': >- - ImageGenerationStatus method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageGenerationStatus%20-%20TypeScript%20SDK&description=ImageGenerationStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageGenerationStatus } from "@openrouter/sdk/models"; - -let value: ImageGenerationStatus = "completed"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"in_progress" | "completed" | "generating" | "failed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/imageurl.mdx b/client-sdks/typescript/models/imageurl.mdx deleted file mode 100644 index ec74b54a..00000000 --- a/client-sdks/typescript/models/imageurl.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ImageUrl - TypeScript SDK -description: ImageUrl method reference -seoTitle: ImageUrl | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageUrl | OpenRouter TypeScript SDK -'og:description': >- - ImageUrl method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageUrl%20-%20TypeScript%20SDK&description=ImageUrl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageUrl } from "@openrouter/sdk/models"; - -let value: ImageUrl = { - url: "https://sinful-meal.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | -| `detail` | [models.ChatMessageContentItemImageDetail](/client-sdks/typescript/models/chatmessagecontentitemimagedetail) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/inputmodality.mdx b/client-sdks/typescript/models/inputmodality.mdx deleted file mode 100644 index f049ca29..00000000 --- a/client-sdks/typescript/models/inputmodality.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputModality - TypeScript SDK -description: InputModality method reference -seoTitle: InputModality | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/inputmodality' -'og:site_name': OpenRouter Documentation -'og:title': InputModality | OpenRouter TypeScript SDK -'og:description': >- - InputModality method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputModality%20-%20TypeScript%20SDK&description=InputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputModality } from "@openrouter/sdk/models"; - -let value: InputModality = "text"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"text" | "image" | "file" | "audio" | "video" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/inputtokensdetails.mdx b/client-sdks/typescript/models/inputtokensdetails.mdx deleted file mode 100644 index 6ee6c445..00000000 --- a/client-sdks/typescript/models/inputtokensdetails.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: InputTokensDetails - TypeScript SDK -description: InputTokensDetails method reference -seoTitle: InputTokensDetails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/inputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': InputTokensDetails | OpenRouter TypeScript SDK -'og:description': >- - InputTokensDetails method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputTokensDetails%20-%20TypeScript%20SDK&description=InputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { InputTokensDetails } from "@openrouter/sdk/models"; - -let value: InputTokensDetails = { - cachedTokens: 229.09, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `cachedTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/instructtype.mdx b/client-sdks/typescript/models/instructtype.mdx deleted file mode 100644 index fe4b8cfa..00000000 --- a/client-sdks/typescript/models/instructtype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: InstructType - TypeScript SDK -description: InstructType method reference -seoTitle: InstructType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/instructtype' -'og:site_name': OpenRouter Documentation -'og:title': InstructType | OpenRouter TypeScript SDK -'og:description': >- - InstructType method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InstructType%20-%20TypeScript%20SDK&description=InstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```typescript lines -import { InstructType } from "@openrouter/sdk/models"; - -let value: InstructType = "claude"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"none" | "airoboros" | "alpaca" | "alpaca-modif" | "chatml" | "claude" | "code-llama" | "gemma" | "llama2" | "llama3" | "mistral" | "nemotron" | "neural" | "openchat" | "phi3" | "rwkv" | "vicuna" | "zephyr" | "deepseek-r1" | "deepseek-v3.1" | "qwq" | "qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/internalserverresponseerrordata.mdx b/client-sdks/typescript/models/internalserverresponseerrordata.mdx deleted file mode 100644 index 0bdb838d..00000000 --- a/client-sdks/typescript/models/internalserverresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: InternalServerResponseErrorData - TypeScript SDK -description: InternalServerResponseErrorData method reference -seoTitle: InternalServerResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/internalserverresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': InternalServerResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - InternalServerResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InternalServerResponseErrorData%20-%20TypeScript%20SDK&description=InternalServerResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for InternalServerResponse - -## Example Usage - -```typescript lines -import { InternalServerResponseErrorData } from "@openrouter/sdk/models"; - -let value: InternalServerResponseErrorData = { - code: 500, - message: "Internal Server Error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/jsonschemaconfig.mdx b/client-sdks/typescript/models/jsonschemaconfig.mdx deleted file mode 100644 index ef31221a..00000000 --- a/client-sdks/typescript/models/jsonschemaconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: JSONSchemaConfig - TypeScript SDK -description: JSONSchemaConfig method reference -seoTitle: JSONSchemaConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/jsonschemaconfig' -'og:site_name': OpenRouter Documentation -'og:title': JSONSchemaConfig | OpenRouter TypeScript SDK -'og:description': >- - JSONSchemaConfig method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=JSONSchemaConfig%20-%20TypeScript%20SDK&description=JSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { JSONSchemaConfig } from "@openrouter/sdk/models"; - -let value: JSONSchemaConfig = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `schema` | `Record` | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/listendpointsresponse.mdx b/client-sdks/typescript/models/listendpointsresponse.mdx deleted file mode 100644 index 8a2f0398..00000000 --- a/client-sdks/typescript/models/listendpointsresponse.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: ListEndpointsResponse - TypeScript SDK -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/listendpointsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20TypeScript%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of available endpoints for a model - -## Example Usage - -```typescript expandable lines -import { ListEndpointsResponse } from "@openrouter/sdk/models"; - -let value: ListEndpointsResponse = { - id: "openai/gpt-4", - name: "GPT-4", - created: 1692901234, - description: - "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", - architecture: { - tokenizer: "GPT", - instructType: "chatml", - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], - }, - endpoints: [ - { - name: "OpenAI: GPT-4", - modelName: "GPT-4", - contextLength: 8192, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - providerName: "OpenAI", - tag: "openai", - quantization: "fp16", - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - "frequency_penalty", - "presence_penalty", - ], - uptimeLast30m: 99.5, - supportsImplicitCaching: true, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *string* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `architecture` | [models.Architecture](/client-sdks/typescript/models/architecture) | :heavy_check_mark: | N/A | `{"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}` | -| `endpoints` | [models.PublicEndpoint](/client-sdks/typescript/models/publicendpoint)[] | :heavy_check_mark: | List of available endpoints for this model | | \ No newline at end of file diff --git a/client-sdks/typescript/models/logprob.mdx b/client-sdks/typescript/models/logprob.mdx deleted file mode 100644 index 6d058029..00000000 --- a/client-sdks/typescript/models/logprob.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Logprob - TypeScript SDK -description: Logprob method reference -seoTitle: Logprob | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/logprob' -'og:site_name': OpenRouter Documentation -'og:title': Logprob | OpenRouter TypeScript SDK -'og:description': >- - Logprob method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Logprob%20-%20TypeScript%20SDK&description=Logprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Logprob } from "@openrouter/sdk/models"; - -let value: Logprob = { - token: "", - bytes: [ - 3226.37, - ], - logprob: 2246.86, - topLogprobs: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `token` | *string* | :heavy_check_mark: | N/A | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ResponseOutputTextTopLogprob](/client-sdks/typescript/models/responseoutputtexttoplogprob)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/message.mdx b/client-sdks/typescript/models/message.mdx deleted file mode 100644 index d1a02995..00000000 --- a/client-sdks/typescript/models/message.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Message - TypeScript SDK -description: Message method reference -seoTitle: Message | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/message' -'og:site_name': OpenRouter Documentation -'og:title': Message | OpenRouter TypeScript SDK -'og:description': >- - Message method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Message%20-%20TypeScript%20SDK&description=Message%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.SystemMessage` - -```typescript lines -const value: models.SystemMessage = { - role: "system", - content: [], -}; -``` - -### `models.UserMessage` - -```typescript lines -const value: models.UserMessage = { - role: "user", - content: "", -}; -``` - -### `models.MessageDeveloper` - -```typescript lines -const value: models.MessageDeveloper = { - role: "developer", - content: [], -}; -``` - -### `models.AssistantMessage` - -```typescript lines -const value: models.AssistantMessage = { - role: "assistant", -}; -``` - -### `models.ToolResponseMessage` - -```typescript lines -const value: models.ToolResponseMessage = { - role: "tool", - content: [], - toolCallId: "", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/messagecontent.mdx b/client-sdks/typescript/models/messagecontent.mdx deleted file mode 100644 index 520a5048..00000000 --- a/client-sdks/typescript/models/messagecontent.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MessageContent - TypeScript SDK -description: MessageContent method reference -seoTitle: MessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/messagecontent' -'og:site_name': OpenRouter Documentation -'og:title': MessageContent | OpenRouter TypeScript SDK -'og:description': >- - MessageContent method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessageContent%20-%20TypeScript%20SDK&description=MessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatMessageContentItemText[]` - -```typescript lines -const value: models.ChatMessageContentItemText[] = [ - { - type: "text", - text: "", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/messagedeveloper.mdx b/client-sdks/typescript/models/messagedeveloper.mdx deleted file mode 100644 index 88f43466..00000000 --- a/client-sdks/typescript/models/messagedeveloper.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MessageDeveloper - TypeScript SDK -description: MessageDeveloper method reference -seoTitle: MessageDeveloper | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/messagedeveloper' -'og:site_name': OpenRouter Documentation -'og:title': MessageDeveloper | OpenRouter TypeScript SDK -'og:description': >- - MessageDeveloper method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=MessageDeveloper%20-%20TypeScript%20SDK&description=MessageDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { MessageDeveloper } from "@openrouter/sdk/models"; - -let value: MessageDeveloper = { - role: "developer", - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `role` | *"developer"* | :heavy_check_mark: | N/A | -| `content` | *models.MessageContent* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/modality.mdx b/client-sdks/typescript/models/modality.mdx deleted file mode 100644 index 7f054912..00000000 --- a/client-sdks/typescript/models/modality.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Modality - TypeScript SDK -description: Modality method reference -seoTitle: Modality | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modality' -'og:site_name': OpenRouter Documentation -'og:title': Modality | OpenRouter TypeScript SDK -'og:description': >- - Modality method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Modality%20-%20TypeScript%20SDK&description=Modality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Modality } from "@openrouter/sdk/models"; - -let value: Modality = "image"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"text" | "image" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/model.mdx b/client-sdks/typescript/models/model.mdx deleted file mode 100644 index 5f289189..00000000 --- a/client-sdks/typescript/models/model.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Model - TypeScript SDK -description: Model method reference -seoTitle: Model | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/model' -'og:site_name': OpenRouter Documentation -'og:title': Model | OpenRouter TypeScript SDK -'og:description': >- - Model method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Model%20-%20TypeScript%20SDK&description=Model%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about an AI model available on OpenRouter - -## Example Usage - -```typescript expandable lines -import { Model } from "@openrouter/sdk/models"; - -let value: Model = { - id: "openai/gpt-4", - canonicalSlug: "openai/gpt-4", - name: "GPT-4", - created: 1692901234, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - contextLength: 8192, - architecture: { - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], - }, - topProvider: { - isModerated: true, - }, - perRequestLimits: null, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - defaultParameters: null, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *string* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `pricing` | [models.PublicPricing](/client-sdks/typescript/models/publicpricing) | :heavy_check_mark: | Pricing information for the model | `{"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"}` | -| `contextLength` | *number* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `architecture` | [models.ModelArchitecture](/client-sdks/typescript/models/modelarchitecture) | :heavy_check_mark: | Model architecture information | `{"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}` | -| `topProvider` | [models.TopProviderInfo](/client-sdks/typescript/models/topproviderinfo) | :heavy_check_mark: | Information about the top provider for this model | `{"context_length": 8192,"max_completion_tokens": 4096,"is_moderated": true}` | -| `perRequestLimits` | [models.PerRequestLimits](/client-sdks/typescript/models/perrequestlimits) | :heavy_check_mark: | Per-request token limits | `{"prompt_tokens": 1000,"completion_tokens": 1000}` | -| `supportedParameters` | [models.Parameter](/client-sdks/typescript/models/parameter)[] | :heavy_check_mark: | List of supported parameters for this model | | -| `defaultParameters` | [models.DefaultParameters](/client-sdks/typescript/models/defaultparameters) | :heavy_check_mark: | Default parameters for this model | `{"temperature": 0.7,"top_p": 0.9,"frequency_penalty": 0}` | -| `expirationDate` | *string* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | \ No newline at end of file diff --git a/client-sdks/typescript/models/modelarchitecture.mdx b/client-sdks/typescript/models/modelarchitecture.mdx deleted file mode 100644 index 61972094..00000000 --- a/client-sdks/typescript/models/modelarchitecture.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ModelArchitecture - TypeScript SDK -description: ModelArchitecture method reference -seoTitle: ModelArchitecture | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modelarchitecture' -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitecture | OpenRouter TypeScript SDK -'og:description': >- - ModelArchitecture method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitecture%20-%20TypeScript%20SDK&description=ModelArchitecture%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model architecture information - -## Example Usage - -```typescript lines -import { ModelArchitecture } from "@openrouter/sdk/models"; - -let value: ModelArchitecture = { - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `tokenizer` | [models.ModelGroup](/client-sdks/typescript/models/modelgroup) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | -| `instructType` | [models.ModelArchitectureInstructType](/client-sdks/typescript/models/modelarchitectureinstructtype) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text->text | -| `inputModalities` | [models.InputModality](/client-sdks/typescript/models/inputmodality)[] | :heavy_check_mark: | Supported input modalities | | -| `outputModalities` | [models.OutputModality](/client-sdks/typescript/models/outputmodality)[] | :heavy_check_mark: | Supported output modalities | | \ No newline at end of file diff --git a/client-sdks/typescript/models/modelarchitectureinstructtype.mdx b/client-sdks/typescript/models/modelarchitectureinstructtype.mdx deleted file mode 100644 index 228fc52d..00000000 --- a/client-sdks/typescript/models/modelarchitectureinstructtype.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ModelArchitectureInstructType - TypeScript SDK -description: ModelArchitectureInstructType method reference -seoTitle: ModelArchitectureInstructType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/modelarchitectureinstructtype -'og:site_name': OpenRouter Documentation -'og:title': ModelArchitectureInstructType | OpenRouter TypeScript SDK -'og:description': >- - ModelArchitectureInstructType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelArchitectureInstructType%20-%20TypeScript%20SDK&description=ModelArchitectureInstructType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Instruction format type - -## Example Usage - -```typescript lines -import { ModelArchitectureInstructType } from "@openrouter/sdk/models"; - -let value: ModelArchitectureInstructType = "chatml"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"none" | "airoboros" | "alpaca" | "alpaca-modif" | "chatml" | "claude" | "code-llama" | "gemma" | "llama2" | "llama3" | "mistral" | "nemotron" | "neural" | "openchat" | "phi3" | "rwkv" | "vicuna" | "zephyr" | "deepseek-r1" | "deepseek-v3.1" | "qwq" | "qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/modelgroup.mdx b/client-sdks/typescript/models/modelgroup.mdx deleted file mode 100644 index 4d428caa..00000000 --- a/client-sdks/typescript/models/modelgroup.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ModelGroup - TypeScript SDK -description: ModelGroup method reference -seoTitle: ModelGroup | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modelgroup' -'og:site_name': OpenRouter Documentation -'og:title': ModelGroup | OpenRouter TypeScript SDK -'og:description': >- - ModelGroup method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelGroup%20-%20TypeScript%20SDK&description=ModelGroup%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```typescript lines -import { ModelGroup } from "@openrouter/sdk/models"; - -let value: ModelGroup = "GPT"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"Router" | "Media" | "Other" | "GPT" | "Claude" | "Gemini" | "Grok" | "Cohere" | "Nova" | "Qwen" | "Yi" | "DeepSeek" | "Mistral" | "Llama2" | "Llama3" | "Llama4" | "PaLM" | "RWKV" | "Qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/modelscountresponse.mdx b/client-sdks/typescript/models/modelscountresponse.mdx deleted file mode 100644 index 113e20ed..00000000 --- a/client-sdks/typescript/models/modelscountresponse.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ModelsCountResponse - TypeScript SDK -description: ModelsCountResponse method reference -seoTitle: ModelsCountResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modelscountresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponse | OpenRouter TypeScript SDK -'og:description': >- - ModelsCountResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponse%20-%20TypeScript%20SDK&description=ModelsCountResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model count data - -## Example Usage - -```typescript lines -import { ModelsCountResponse } from "@openrouter/sdk/models"; - -let value: ModelsCountResponse = { - data: { - count: 150, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.ModelsCountResponseData](/client-sdks/typescript/models/modelscountresponsedata) | :heavy_check_mark: | Model count data | `{"count": 150}` | \ No newline at end of file diff --git a/client-sdks/typescript/models/modelscountresponsedata.mdx b/client-sdks/typescript/models/modelscountresponsedata.mdx deleted file mode 100644 index 4ce9c539..00000000 --- a/client-sdks/typescript/models/modelscountresponsedata.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ModelsCountResponseData - TypeScript SDK -description: ModelsCountResponseData method reference -seoTitle: ModelsCountResponseData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modelscountresponsedata' -'og:site_name': OpenRouter Documentation -'og:title': ModelsCountResponseData | OpenRouter TypeScript SDK -'og:description': >- - ModelsCountResponseData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsCountResponseData%20-%20TypeScript%20SDK&description=ModelsCountResponseData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Model count data - -## Example Usage - -```typescript lines -import { ModelsCountResponseData } from "@openrouter/sdk/models"; - -let value: ModelsCountResponseData = { - count: 150, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *number* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file diff --git a/client-sdks/typescript/models/modelslistresponse.mdx b/client-sdks/typescript/models/modelslistresponse.mdx deleted file mode 100644 index 8757f84f..00000000 --- a/client-sdks/typescript/models/modelslistresponse.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: ModelsListResponse - TypeScript SDK -description: ModelsListResponse method reference -seoTitle: ModelsListResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/modelslistresponse' -'og:site_name': OpenRouter Documentation -'og:title': ModelsListResponse | OpenRouter TypeScript SDK -'og:description': >- - ModelsListResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ModelsListResponse%20-%20TypeScript%20SDK&description=ModelsListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of available models - -## Example Usage - -```typescript expandable lines -import { ModelsListResponse } from "@openrouter/sdk/models"; - -let value: ModelsListResponse = { - data: [ - { - id: "openai/gpt-4", - canonicalSlug: "openai/gpt-4", - name: "GPT-4", - created: 1692901234, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - contextLength: 8192, - architecture: { - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], - }, - topProvider: { - isModerated: true, - }, - perRequestLimits: null, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - "frequency_penalty", - "presence_penalty", - ], - defaultParameters: null, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `data` | [models.Model](/client-sdks/typescript/models/model)[] | :heavy_check_mark: | List of available models | \ No newline at end of file diff --git a/client-sdks/typescript/models/namedtoolchoice.mdx b/client-sdks/typescript/models/namedtoolchoice.mdx deleted file mode 100644 index 82d9999f..00000000 --- a/client-sdks/typescript/models/namedtoolchoice.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: NamedToolChoice - TypeScript SDK -description: NamedToolChoice method reference -seoTitle: NamedToolChoice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/namedtoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': NamedToolChoice | OpenRouter TypeScript SDK -'og:description': >- - NamedToolChoice method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NamedToolChoice%20-%20TypeScript%20SDK&description=NamedToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NamedToolChoice } from "@openrouter/sdk/models"; - -let value: NamedToolChoice = { - type: "function", - function: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | *"function"* | :heavy_check_mark: | N/A | -| `function` | [models.NamedToolChoiceFunction](/client-sdks/typescript/models/namedtoolchoicefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/namedtoolchoicefunction.mdx b/client-sdks/typescript/models/namedtoolchoicefunction.mdx deleted file mode 100644 index a8d17c0f..00000000 --- a/client-sdks/typescript/models/namedtoolchoicefunction.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: NamedToolChoiceFunction - TypeScript SDK -description: NamedToolChoiceFunction method reference -seoTitle: NamedToolChoiceFunction | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/namedtoolchoicefunction' -'og:site_name': OpenRouter Documentation -'og:title': NamedToolChoiceFunction | OpenRouter TypeScript SDK -'og:description': >- - NamedToolChoiceFunction method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NamedToolChoiceFunction%20-%20TypeScript%20SDK&description=NamedToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { NamedToolChoiceFunction } from "@openrouter/sdk/models"; - -let value: NamedToolChoiceFunction = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/notfoundresponseerrordata.mdx b/client-sdks/typescript/models/notfoundresponseerrordata.mdx deleted file mode 100644 index 120ffa82..00000000 --- a/client-sdks/typescript/models/notfoundresponseerrordata.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: NotFoundResponseErrorData - TypeScript SDK -description: NotFoundResponseErrorData method reference -seoTitle: NotFoundResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/notfoundresponseerrordata' -'og:site_name': OpenRouter Documentation -'og:title': NotFoundResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - NotFoundResponseErrorData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=NotFoundResponseErrorData%20-%20TypeScript%20SDK&description=NotFoundResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for NotFoundResponse - -## Example Usage - -```typescript lines -import { NotFoundResponseErrorData } from "@openrouter/sdk/models"; - -let value: NotFoundResponseErrorData = { - code: 404, - message: "Resource not found", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/objectt.mdx b/client-sdks/typescript/models/objectt.mdx deleted file mode 100644 index cc0dde01..00000000 --- a/client-sdks/typescript/models/objectt.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObjectT - TypeScript SDK -description: ObjectT method reference -seoTitle: ObjectT | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/objectt' -'og:site_name': OpenRouter Documentation -'og:title': ObjectT | OpenRouter TypeScript SDK -'og:description': >- - ObjectT method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectT%20-%20TypeScript%20SDK&description=ObjectT%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObjectT } from "@openrouter/sdk/models"; - -let value: ObjectT = "response"; -``` - -## Values - -```typescript lines -"response" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesannotation.mdx b/client-sdks/typescript/models/openairesponsesannotation.mdx deleted file mode 100644 index cb6229d6..00000000 --- a/client-sdks/typescript/models/openairesponsesannotation.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: OpenAIResponsesAnnotation - TypeScript SDK -description: OpenAIResponsesAnnotation method reference -seoTitle: OpenAIResponsesAnnotation | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesannotation' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesAnnotation | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesAnnotation method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesAnnotation%20-%20TypeScript%20SDK&description=OpenAIResponsesAnnotation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.FileCitation` - -```typescript lines -const value: models.FileCitation = { - type: "file_citation", - fileId: "file-abc123", - filename: "research_paper.pdf", - index: 0, -}; -``` - -### `models.URLCitation` - -```typescript lines -const value: models.URLCitation = { - type: "url_citation", - url: "https://openrouter.ai/docs", - title: "OpenRouter Documentation", - startIndex: 0, - endIndex: 42, -}; -``` - -### `models.FilePath` - -```typescript lines -const value: models.FilePath = { - type: "file_path", - fileId: "file-xyz789", - index: 0, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesincludable.mdx b/client-sdks/typescript/models/openairesponsesincludable.mdx deleted file mode 100644 index 069b0321..00000000 --- a/client-sdks/typescript/models/openairesponsesincludable.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesIncludable - TypeScript SDK -description: OpenAIResponsesIncludable method reference -seoTitle: OpenAIResponsesIncludable | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesincludable' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesIncludable | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesIncludable method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesIncludable%20-%20TypeScript%20SDK&description=OpenAIResponsesIncludable%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesIncludable } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesIncludable = "file_search_call.results"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"file_search_call.results" | "message.input_image.image_url" | "computer_call_output.output.image_url" | "reasoning.encrypted_content" | "code_interpreter_call.outputs" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesincompletedetails.mdx b/client-sdks/typescript/models/openairesponsesincompletedetails.mdx deleted file mode 100644 index 9ba167ec..00000000 --- a/client-sdks/typescript/models/openairesponsesincompletedetails.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesIncompleteDetails - TypeScript SDK -description: OpenAIResponsesIncompleteDetails method reference -seoTitle: OpenAIResponsesIncompleteDetails | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesincompletedetails -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesIncompleteDetails | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesIncompleteDetails method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesIncompleteDetails%20-%20TypeScript%20SDK&description=OpenAIResponsesIncompleteDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesIncompleteDetails } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesIncompleteDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `reason` | [models.Reason](/client-sdks/typescript/models/reason) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputcontent1.mdx b/client-sdks/typescript/models/openairesponsesinputcontent1.mdx deleted file mode 100644 index 957f558d..00000000 --- a/client-sdks/typescript/models/openairesponsesinputcontent1.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: OpenAIResponsesInputContent1 - TypeScript SDK -description: OpenAIResponsesInputContent1 method reference -seoTitle: OpenAIResponsesInputContent1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputcontent1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputContent1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputContent1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseInputText` - -```typescript lines -const value: models.ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -### `models.ResponseInputImage` - -```typescript lines -const value: models.ResponseInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -### `models.ResponseInputFile` - -```typescript lines -const value: models.ResponseInputFile = { - type: "input_file", -}; -``` - -### `models.ResponseInputAudio` - -```typescript lines -const value: models.ResponseInputAudio = { - type: "input_audio", - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputcontent2.mdx b/client-sdks/typescript/models/openairesponsesinputcontent2.mdx deleted file mode 100644 index d4de0c4e..00000000 --- a/client-sdks/typescript/models/openairesponsesinputcontent2.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenAIResponsesInputContent2 - TypeScript SDK -description: OpenAIResponsesInputContent2 method reference -seoTitle: OpenAIResponsesInputContent2 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputcontent2' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputContent2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputContent2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesInputContent1[]` - -```typescript lines -const value: models.OpenAIResponsesInputContent1[] = []; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputcontent3.mdx b/client-sdks/typescript/models/openairesponsesinputcontent3.mdx deleted file mode 100644 index 8a0786b0..00000000 --- a/client-sdks/typescript/models/openairesponsesinputcontent3.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: OpenAIResponsesInputContent3 - TypeScript SDK -description: OpenAIResponsesInputContent3 method reference -seoTitle: OpenAIResponsesInputContent3 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputcontent3' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputContent3 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputContent3 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputContent3%20-%20TypeScript%20SDK&description=OpenAIResponsesInputContent3%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseInputText` - -```typescript lines -const value: models.ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -### `models.ResponseInputImage` - -```typescript lines -const value: models.ResponseInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -### `models.ResponseInputFile` - -```typescript lines -const value: models.ResponseInputFile = { - type: "input_file", -}; -``` - -### `models.ResponseInputAudio` - -```typescript lines -const value: models.ResponseInputAudio = { - type: "input_audio", - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputfunctioncall.mdx b/client-sdks/typescript/models/openairesponsesinputfunctioncall.mdx deleted file mode 100644 index 88e74ced..00000000 --- a/client-sdks/typescript/models/openairesponsesinputfunctioncall.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OpenAIResponsesInputFunctionCall - TypeScript SDK -description: OpenAIResponsesInputFunctionCall method reference -seoTitle: OpenAIResponsesInputFunctionCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputfunctioncall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputFunctionCall | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputFunctionCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputFunctionCall%20-%20TypeScript%20SDK&description=OpenAIResponsesInputFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputFunctionCall } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputFunctionCall = { - type: "function_call", - callId: "", - name: "", - arguments: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.OpenAIResponsesInputTypeFunctionCall](/client-sdks/typescript/models/openairesponsesinputtypefunctioncall) | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputfunctioncalloutput.mdx b/client-sdks/typescript/models/openairesponsesinputfunctioncalloutput.mdx deleted file mode 100644 index c7a82e9e..00000000 --- a/client-sdks/typescript/models/openairesponsesinputfunctioncalloutput.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OpenAIResponsesInputFunctionCallOutput - TypeScript SDK -description: OpenAIResponsesInputFunctionCallOutput method reference -seoTitle: OpenAIResponsesInputFunctionCallOutput | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputfunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputFunctionCallOutput | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputFunctionCallOutput method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputFunctionCallOutput%20-%20TypeScript%20SDK&description=OpenAIResponsesInputFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputFunctionCallOutput } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputFunctionCallOutput = { - type: "function_call_output", - callId: "", - output: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `type` | [models.OpenAIResponsesInputTypeFunctionCallOutput](/client-sdks/typescript/models/openairesponsesinputtypefunctioncalloutput) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `output` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputmessage1.mdx b/client-sdks/typescript/models/openairesponsesinputmessage1.mdx deleted file mode 100644 index 2d7942ee..00000000 --- a/client-sdks/typescript/models/openairesponsesinputmessage1.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenAIResponsesInputMessage1 - TypeScript SDK -description: OpenAIResponsesInputMessage1 method reference -seoTitle: OpenAIResponsesInputMessage1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputmessage1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputMessage1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputMessage1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputMessage1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputMessage1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputMessage1 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputMessage1 = { - role: "assistant", - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [models.OpenAIResponsesInputTypeMessage1](/client-sdks/typescript/models/openairesponsesinputtypemessage1) | :heavy_minus_sign: | N/A | -| `role` | *models.OpenAIResponsesInputRoleUnion1* | :heavy_check_mark: | N/A | -| `content` | *models.OpenAIResponsesInputContent2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputmessage2.mdx b/client-sdks/typescript/models/openairesponsesinputmessage2.mdx deleted file mode 100644 index fe618432..00000000 --- a/client-sdks/typescript/models/openairesponsesinputmessage2.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenAIResponsesInputMessage2 - TypeScript SDK -description: OpenAIResponsesInputMessage2 method reference -seoTitle: OpenAIResponsesInputMessage2 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputmessage2' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputMessage2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputMessage2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputMessage2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputMessage2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputMessage2 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputMessage2 = { - id: "", - role: "user", - content: [ - { - type: "input_text", - text: "Hello, how can I help you?", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponsesInputTypeMessage2](/client-sdks/typescript/models/openairesponsesinputtypemessage2) | :heavy_minus_sign: | N/A | -| `role` | *models.OpenAIResponsesInputRoleUnion2* | :heavy_check_mark: | N/A | -| `content` | *models.OpenAIResponsesInputContent3*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroleassistant.mdx b/client-sdks/typescript/models/openairesponsesinputroleassistant.mdx deleted file mode 100644 index 4d1750c1..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroleassistant.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleAssistant - TypeScript SDK -description: OpenAIResponsesInputRoleAssistant method reference -seoTitle: OpenAIResponsesInputRoleAssistant | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroleassistant -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleAssistant | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleAssistant method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleAssistant%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleAssistant } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleAssistant = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroledeveloper1.mdx b/client-sdks/typescript/models/openairesponsesinputroledeveloper1.mdx deleted file mode 100644 index ac7ce9ec..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroledeveloper1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleDeveloper1 - TypeScript SDK -description: OpenAIResponsesInputRoleDeveloper1 method reference -seoTitle: OpenAIResponsesInputRoleDeveloper1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroledeveloper1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleDeveloper1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleDeveloper1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleDeveloper1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleDeveloper1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleDeveloper1 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleDeveloper1 = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroledeveloper2.mdx b/client-sdks/typescript/models/openairesponsesinputroledeveloper2.mdx deleted file mode 100644 index 4b9a2dc7..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroledeveloper2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleDeveloper2 - TypeScript SDK -description: OpenAIResponsesInputRoleDeveloper2 method reference -seoTitle: OpenAIResponsesInputRoleDeveloper2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroledeveloper2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleDeveloper2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleDeveloper2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleDeveloper2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleDeveloper2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleDeveloper2 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleDeveloper2 = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputrolesystem1.mdx b/client-sdks/typescript/models/openairesponsesinputrolesystem1.mdx deleted file mode 100644 index 1419e130..00000000 --- a/client-sdks/typescript/models/openairesponsesinputrolesystem1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleSystem1 - TypeScript SDK -description: OpenAIResponsesInputRoleSystem1 method reference -seoTitle: OpenAIResponsesInputRoleSystem1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputrolesystem1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleSystem1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleSystem1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleSystem1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleSystem1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleSystem1 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleSystem1 = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputrolesystem2.mdx b/client-sdks/typescript/models/openairesponsesinputrolesystem2.mdx deleted file mode 100644 index f904a617..00000000 --- a/client-sdks/typescript/models/openairesponsesinputrolesystem2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleSystem2 - TypeScript SDK -description: OpenAIResponsesInputRoleSystem2 method reference -seoTitle: OpenAIResponsesInputRoleSystem2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputrolesystem2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleSystem2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleSystem2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleSystem2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleSystem2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleSystem2 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleSystem2 = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroleunion1.mdx b/client-sdks/typescript/models/openairesponsesinputroleunion1.mdx deleted file mode 100644 index b9ff916a..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroleunion1.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUnion1 - TypeScript SDK -description: OpenAIResponsesInputRoleUnion1 method reference -seoTitle: OpenAIResponsesInputRoleUnion1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroleunion1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUnion1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleUnion1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUnion1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesInputRoleUser1` - -```typescript lines -const value: models.OpenAIResponsesInputRoleUser1 = "user"; -``` - -### `models.OpenAIResponsesInputRoleSystem1` - -```typescript lines -const value: models.OpenAIResponsesInputRoleSystem1 = "system"; -``` - -### `models.OpenAIResponsesInputRoleAssistant` - -```typescript lines -const value: models.OpenAIResponsesInputRoleAssistant = "assistant"; -``` - -### `models.OpenAIResponsesInputRoleDeveloper1` - -```typescript lines -const value: models.OpenAIResponsesInputRoleDeveloper1 = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroleunion2.mdx b/client-sdks/typescript/models/openairesponsesinputroleunion2.mdx deleted file mode 100644 index c1603528..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroleunion2.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUnion2 - TypeScript SDK -description: OpenAIResponsesInputRoleUnion2 method reference -seoTitle: OpenAIResponsesInputRoleUnion2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroleunion2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUnion2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleUnion2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUnion2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesInputRoleUser2` - -```typescript lines -const value: models.OpenAIResponsesInputRoleUser2 = "user"; -``` - -### `models.OpenAIResponsesInputRoleSystem2` - -```typescript lines -const value: models.OpenAIResponsesInputRoleSystem2 = "system"; -``` - -### `models.OpenAIResponsesInputRoleDeveloper2` - -```typescript lines -const value: models.OpenAIResponsesInputRoleDeveloper2 = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroleuser1.mdx b/client-sdks/typescript/models/openairesponsesinputroleuser1.mdx deleted file mode 100644 index 3602a007..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroleuser1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUser1 - TypeScript SDK -description: OpenAIResponsesInputRoleUser1 method reference -seoTitle: OpenAIResponsesInputRoleUser1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroleuser1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUser1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleUser1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUser1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleUser1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleUser1 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleUser1 = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputroleuser2.mdx b/client-sdks/typescript/models/openairesponsesinputroleuser2.mdx deleted file mode 100644 index e8834b2c..00000000 --- a/client-sdks/typescript/models/openairesponsesinputroleuser2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputRoleUser2 - TypeScript SDK -description: OpenAIResponsesInputRoleUser2 method reference -seoTitle: OpenAIResponsesInputRoleUser2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputroleuser2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputRoleUser2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputRoleUser2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputRoleUser2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputRoleUser2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputRoleUser2 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputRoleUser2 = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputtypefunctioncall.mdx b/client-sdks/typescript/models/openairesponsesinputtypefunctioncall.mdx deleted file mode 100644 index e8bf292f..00000000 --- a/client-sdks/typescript/models/openairesponsesinputtypefunctioncall.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputTypeFunctionCall - TypeScript SDK -description: OpenAIResponsesInputTypeFunctionCall method reference -seoTitle: OpenAIResponsesInputTypeFunctionCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputtypefunctioncall -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeFunctionCall | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputTypeFunctionCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeFunctionCall%20-%20TypeScript%20SDK&description=OpenAIResponsesInputTypeFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputTypeFunctionCall } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputTypeFunctionCall = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputtypefunctioncalloutput.mdx b/client-sdks/typescript/models/openairesponsesinputtypefunctioncalloutput.mdx deleted file mode 100644 index 656b8ace..00000000 --- a/client-sdks/typescript/models/openairesponsesinputtypefunctioncalloutput.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesInputTypeFunctionCallOutput - TypeScript SDK -description: OpenAIResponsesInputTypeFunctionCallOutput method reference -seoTitle: OpenAIResponsesInputTypeFunctionCallOutput | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputtypefunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeFunctionCallOutput | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputTypeFunctionCallOutput method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeFunctionCallOutput%20-%20TypeScript%20SDK&description=OpenAIResponsesInputTypeFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputTypeFunctionCallOutput } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputTypeFunctionCallOutput = "function_call_output"; -``` - -## Values - -```typescript lines -"function_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputtypemessage1.mdx b/client-sdks/typescript/models/openairesponsesinputtypemessage1.mdx deleted file mode 100644 index fb8ff0dd..00000000 --- a/client-sdks/typescript/models/openairesponsesinputtypemessage1.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputTypeMessage1 - TypeScript SDK -description: OpenAIResponsesInputTypeMessage1 method reference -seoTitle: OpenAIResponsesInputTypeMessage1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputtypemessage1 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeMessage1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputTypeMessage1 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeMessage1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputTypeMessage1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputTypeMessage1 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputTypeMessage1 = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputtypemessage2.mdx b/client-sdks/typescript/models/openairesponsesinputtypemessage2.mdx deleted file mode 100644 index 21ad1039..00000000 --- a/client-sdks/typescript/models/openairesponsesinputtypemessage2.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesInputTypeMessage2 - TypeScript SDK -description: OpenAIResponsesInputTypeMessage2 method reference -seoTitle: OpenAIResponsesInputTypeMessage2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesinputtypemessage2 -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputTypeMessage2 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputTypeMessage2 method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputTypeMessage2%20-%20TypeScript%20SDK&description=OpenAIResponsesInputTypeMessage2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesInputTypeMessage2 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesInputTypeMessage2 = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputunion.mdx b/client-sdks/typescript/models/openairesponsesinputunion.mdx deleted file mode 100644 index b989cf4c..00000000 --- a/client-sdks/typescript/models/openairesponsesinputunion.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenAIResponsesInputUnion - TypeScript SDK -description: OpenAIResponsesInputUnion method reference -seoTitle: OpenAIResponsesInputUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputunion' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputUnion method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputUnion%20-%20TypeScript%20SDK&description=OpenAIResponsesInputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.OpenAIResponsesInputUnion1[]` - -```typescript lines -const value: models.OpenAIResponsesInputUnion1[] = []; -``` - -### `any` - -```typescript lines -const value: any = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesinputunion1.mdx b/client-sdks/typescript/models/openairesponsesinputunion1.mdx deleted file mode 100644 index 83b91c55..00000000 --- a/client-sdks/typescript/models/openairesponsesinputunion1.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: OpenAIResponsesInputUnion1 - TypeScript SDK -description: OpenAIResponsesInputUnion1 method reference -seoTitle: OpenAIResponsesInputUnion1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesinputunion1' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesInputUnion1 | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesInputUnion1 method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesInputUnion1%20-%20TypeScript%20SDK&description=OpenAIResponsesInputUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesInputMessage1` - -```typescript lines -const value: models.OpenAIResponsesInputMessage1 = { - role: "assistant", - content: "", -}; -``` - -### `models.OpenAIResponsesInputMessage2` - -```typescript lines -const value: models.OpenAIResponsesInputMessage2 = { - id: "", - role: "user", - content: [ - { - type: "input_text", - text: "Hello, how can I help you?", - }, - ], -}; -``` - -### `models.OpenAIResponsesInputFunctionCallOutput` - -```typescript lines -const value: models.OpenAIResponsesInputFunctionCallOutput = { - type: "function_call_output", - callId: "", - output: "", -}; -``` - -### `models.OpenAIResponsesInputFunctionCall` - -```typescript lines -const value: models.OpenAIResponsesInputFunctionCall = { - type: "function_call", - callId: "", - name: "", - arguments: "", -}; -``` - -### `models.OutputItemImageGenerationCall` - -```typescript lines -const value: models.OutputItemImageGenerationCall = { - type: "image_generation_call", - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", -}; -``` - -### `models.OutputMessage` - -```typescript lines -const value: models.OutputMessage = { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesprompt.mdx b/client-sdks/typescript/models/openairesponsesprompt.mdx deleted file mode 100644 index 2f175747..00000000 --- a/client-sdks/typescript/models/openairesponsesprompt.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenAIResponsesPrompt - TypeScript SDK -description: OpenAIResponsesPrompt method reference -seoTitle: OpenAIResponsesPrompt | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesprompt' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesPrompt | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesPrompt method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesPrompt%20-%20TypeScript%20SDK&description=OpenAIResponsesPrompt%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesPrompt } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesPrompt = { - id: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `variables` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesreasoningconfig.mdx b/client-sdks/typescript/models/openairesponsesreasoningconfig.mdx deleted file mode 100644 index cc1c7b92..00000000 --- a/client-sdks/typescript/models/openairesponsesreasoningconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesReasoningConfig - TypeScript SDK -description: OpenAIResponsesReasoningConfig method reference -seoTitle: OpenAIResponsesReasoningConfig | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesreasoningconfig -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesReasoningConfig | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesReasoningConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesReasoningConfig%20-%20TypeScript%20SDK&description=OpenAIResponsesReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesReasoningConfig } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesReasoningConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `effort` | [models.OpenAIResponsesReasoningEffort](/client-sdks/typescript/models/openairesponsesreasoningeffort) | :heavy_minus_sign: | N/A | -| `summary` | [models.ReasoningSummaryVerbosity](/client-sdks/typescript/models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesreasoningeffort.mdx b/client-sdks/typescript/models/openairesponsesreasoningeffort.mdx deleted file mode 100644 index 89dcb5bf..00000000 --- a/client-sdks/typescript/models/openairesponsesreasoningeffort.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenAIResponsesReasoningEffort - TypeScript SDK -description: OpenAIResponsesReasoningEffort method reference -seoTitle: OpenAIResponsesReasoningEffort | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesreasoningeffort -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesReasoningEffort | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesReasoningEffort method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesReasoningEffort%20-%20TypeScript%20SDK&description=OpenAIResponsesReasoningEffort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesReasoningEffort } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesReasoningEffort = "xhigh"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"xhigh" | "high" | "medium" | "low" | "minimal" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesrefusalcontent.mdx b/client-sdks/typescript/models/openairesponsesrefusalcontent.mdx deleted file mode 100644 index 55bf67ce..00000000 --- a/client-sdks/typescript/models/openairesponsesrefusalcontent.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenAIResponsesRefusalContent - TypeScript SDK -description: OpenAIResponsesRefusalContent method reference -seoTitle: OpenAIResponsesRefusalContent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesrefusalcontent -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesRefusalContent | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesRefusalContent method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesRefusalContent%20-%20TypeScript%20SDK&description=OpenAIResponsesRefusalContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesRefusalContent } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesRefusalContent = { - type: "refusal", - refusal: "I'm sorry, I cannot assist with that request", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"refusal"* | :heavy_check_mark: | N/A | -| `refusal` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesresponsestatus.mdx b/client-sdks/typescript/models/openairesponsesresponsestatus.mdx deleted file mode 100644 index f24d57c9..00000000 --- a/client-sdks/typescript/models/openairesponsesresponsestatus.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenAIResponsesResponseStatus - TypeScript SDK -description: OpenAIResponsesResponseStatus method reference -seoTitle: OpenAIResponsesResponseStatus | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsesresponsestatus -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesResponseStatus | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesResponseStatus method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesResponseStatus%20-%20TypeScript%20SDK&description=OpenAIResponsesResponseStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesResponseStatus } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesResponseStatus = "failed"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"completed" | "incomplete" | "in_progress" | "failed" | "cancelled" | "queued" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsesservicetier.mdx b/client-sdks/typescript/models/openairesponsesservicetier.mdx deleted file mode 100644 index fa134201..00000000 --- a/client-sdks/typescript/models/openairesponsesservicetier.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesServiceTier - TypeScript SDK -description: OpenAIResponsesServiceTier method reference -seoTitle: OpenAIResponsesServiceTier | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsesservicetier' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesServiceTier | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesServiceTier method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesServiceTier%20-%20TypeScript%20SDK&description=OpenAIResponsesServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesServiceTier } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesServiceTier = "scale"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "default" | "flex" | "priority" | "scale" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoice.mdx b/client-sdks/typescript/models/openairesponsestoolchoice.mdx deleted file mode 100644 index fba304f4..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoice.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoice - TypeScript SDK -description: OpenAIResponsesToolChoice method reference -seoTitle: OpenAIResponsesToolChoice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsestoolchoice' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoice | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoice method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoice%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoice } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoice = { - type: "web_search_preview", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *models.Type* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoiceauto.mdx b/client-sdks/typescript/models/openairesponsestoolchoiceauto.mdx deleted file mode 100644 index 2d1d5d9d..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoiceauto.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceAuto - TypeScript SDK -description: OpenAIResponsesToolChoiceAuto method reference -seoTitle: OpenAIResponsesToolChoiceAuto | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoiceauto -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceAuto | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceAuto method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceAuto%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceAuto%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceAuto } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceAuto = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicefunction.mdx b/client-sdks/typescript/models/openairesponsestoolchoicefunction.mdx deleted file mode 100644 index 43c0dd2a..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicefunction.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceFunction - TypeScript SDK -description: OpenAIResponsesToolChoiceFunction method reference -seoTitle: OpenAIResponsesToolChoiceFunction | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceFunction | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceFunction method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceFunction%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceFunction } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceFunction = { - type: "function", - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](/client-sdks/typescript/models/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicenone.mdx b/client-sdks/typescript/models/openairesponsestoolchoicenone.mdx deleted file mode 100644 index 1adb52b3..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicenone.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceNone - TypeScript SDK -description: OpenAIResponsesToolChoiceNone method reference -seoTitle: OpenAIResponsesToolChoiceNone | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicenone -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceNone | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceNone method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceNone%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceNone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceNone } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceNone = "none"; -``` - -## Values - -```typescript lines -"none" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicerequired.mdx b/client-sdks/typescript/models/openairesponsestoolchoicerequired.mdx deleted file mode 100644 index 77269f65..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicerequired.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceRequired - TypeScript SDK -description: OpenAIResponsesToolChoiceRequired method reference -seoTitle: OpenAIResponsesToolChoiceRequired | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicerequired -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceRequired | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceRequired method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceRequired%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceRequired%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceRequired } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceRequired = "required"; -``` - -## Values - -```typescript lines -"required" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicetypefunction.mdx b/client-sdks/typescript/models/openairesponsestoolchoicetypefunction.mdx deleted file mode 100644 index 34a7943a..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicetypefunction.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeFunction - TypeScript SDK -description: OpenAIResponsesToolChoiceTypeFunction method reference -seoTitle: OpenAIResponsesToolChoiceTypeFunction | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicetypefunction -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeFunction | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeFunction method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeFunction%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeFunction } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeFunction = "function"; -``` - -## Values - -```typescript lines -"function" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview.mdx b/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview.mdx deleted file mode 100644 index 5549a969..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview - TypeScript SDK -description: OpenAIResponsesToolChoiceTypeWebSearchPreview method reference -seoTitle: OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceTypeWebSearchPreview | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeWebSearchPreview } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeWebSearchPreview = "web_search_preview"; -``` - -## Values - -```typescript lines -"web_search_preview" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx b/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx deleted file mode 100644 index c4bc1a03..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview20250311.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 - TypeScript SDK -description: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method reference -seoTitle: >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter TypeScript - SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoicetypewebsearchpreview20250311 -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 | OpenRouter TypeScript - SDK -'og:description': >- - OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 method documentation for - the OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceTypeWebSearchPreview20250311%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = - "web_search_preview_2025_03_11"; -``` - -## Values - -```typescript lines -"web_search_preview_2025_03_11" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestoolchoiceunion.mdx b/client-sdks/typescript/models/openairesponsestoolchoiceunion.mdx deleted file mode 100644 index 43d2fb65..00000000 --- a/client-sdks/typescript/models/openairesponsestoolchoiceunion.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: OpenAIResponsesToolChoiceUnion - TypeScript SDK -description: OpenAIResponsesToolChoiceUnion method reference -seoTitle: OpenAIResponsesToolChoiceUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openairesponsestoolchoiceunion -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesToolChoiceUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesToolChoiceUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesToolChoiceUnion%20-%20TypeScript%20SDK&description=OpenAIResponsesToolChoiceUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesToolChoiceAuto` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceAuto = "auto"; -``` - -### `models.OpenAIResponsesToolChoiceNone` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceNone = "none"; -``` - -### `models.OpenAIResponsesToolChoiceRequired` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceRequired = "required"; -``` - -### `models.OpenAIResponsesToolChoiceFunction` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceFunction = { - type: "function", - name: "", -}; -``` - -### `models.OpenAIResponsesToolChoice` - -```typescript lines -const value: models.OpenAIResponsesToolChoice = { - type: "web_search_preview", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openairesponsestruncation.mdx b/client-sdks/typescript/models/openairesponsestruncation.mdx deleted file mode 100644 index d5209061..00000000 --- a/client-sdks/typescript/models/openairesponsestruncation.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenAIResponsesTruncation - TypeScript SDK -description: OpenAIResponsesTruncation method reference -seoTitle: OpenAIResponsesTruncation | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openairesponsestruncation' -'og:site_name': OpenRouter Documentation -'og:title': OpenAIResponsesTruncation | OpenRouter TypeScript SDK -'og:description': >- - OpenAIResponsesTruncation method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenAIResponsesTruncation%20-%20TypeScript%20SDK&description=OpenAIResponsesTruncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenAIResponsesTruncation } from "@openrouter/sdk/models"; - -let value: OpenAIResponsesTruncation = "auto"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "disabled" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessage.mdx b/client-sdks/typescript/models/openresponseseasyinputmessage.mdx deleted file mode 100644 index db0b3312..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenResponsesEasyInputMessage - TypeScript SDK -description: OpenResponsesEasyInputMessage method reference -seoTitle: OpenResponsesEasyInputMessage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessage method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessage%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessage } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessage = { - role: "system", - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | [models.OpenResponsesEasyInputMessageTypeMessage](/client-sdks/typescript/models/openresponseseasyinputmessagetypemessage) | :heavy_minus_sign: | N/A | -| `role` | *models.OpenResponsesEasyInputMessageRoleUnion* | :heavy_check_mark: | N/A | -| `content` | *models.OpenResponsesEasyInputMessageContentUnion2* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagecontentinputimage.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagecontentinputimage.mdx deleted file mode 100644 index 3c69a4ef..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagecontentinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentInputImage - TypeScript SDK -description: OpenResponsesEasyInputMessageContentInputImage method reference -seoTitle: OpenResponsesEasyInputMessageContentInputImage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagecontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentInputImage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageContentInputImage method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentInputImage%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageContentInputImage } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageContentInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | -| `detail` | [models.OpenResponsesEasyInputMessageDetail](/client-sdks/typescript/models/openresponseseasyinputmessagedetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion1.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion1.mdx deleted file mode 100644 index 7ba6fead..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion1.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentUnion1 - TypeScript SDK -description: OpenResponsesEasyInputMessageContentUnion1 method reference -seoTitle: OpenResponsesEasyInputMessageContentUnion1 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagecontentunion1 -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentUnion1 | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageContentUnion1 method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentUnion1%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageContentUnion1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseInputText` - -```typescript lines -const value: models.ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -### `models.OpenResponsesEasyInputMessageContentInputImage` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageContentInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -### `models.ResponseInputFile` - -```typescript lines -const value: models.ResponseInputFile = { - type: "input_file", -}; -``` - -### `models.ResponseInputAudio` - -```typescript lines -const value: models.ResponseInputAudio = { - type: "input_audio", - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, -}; -``` - -### `models.ResponseInputVideo` - -```typescript lines -const value: models.ResponseInputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion2.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion2.mdx deleted file mode 100644 index a63ffd17..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagecontentunion2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageContentUnion2 - TypeScript SDK -description: OpenResponsesEasyInputMessageContentUnion2 method reference -seoTitle: OpenResponsesEasyInputMessageContentUnion2 | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagecontentunion2 -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageContentUnion2 | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageContentUnion2 method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageContentUnion2%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageContentUnion2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesEasyInputMessageContentUnion1[]` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageContentUnion1[] = []; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagedetail.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagedetail.mdx deleted file mode 100644 index c5f67e9a..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagedetail.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageDetail - TypeScript SDK -description: OpenResponsesEasyInputMessageDetail method reference -seoTitle: OpenResponsesEasyInputMessageDetail | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagedetail -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageDetail | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageDetail method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageDetail%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageDetail } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageDetail = "low"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "high" | "low" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessageroleassistant.mdx b/client-sdks/typescript/models/openresponseseasyinputmessageroleassistant.mdx deleted file mode 100644 index 95b7027f..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessageroleassistant.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleAssistant - TypeScript SDK -description: OpenResponsesEasyInputMessageRoleAssistant method reference -seoTitle: OpenResponsesEasyInputMessageRoleAssistant | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessageroleassistant -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleAssistant | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleAssistant method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleAssistant%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageRoleAssistant%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageRoleAssistant } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageRoleAssistant = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessageroledeveloper.mdx b/client-sdks/typescript/models/openresponseseasyinputmessageroledeveloper.mdx deleted file mode 100644 index 51ea5a93..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessageroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleDeveloper - TypeScript SDK -description: OpenResponsesEasyInputMessageRoleDeveloper method reference -seoTitle: OpenResponsesEasyInputMessageRoleDeveloper | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessageroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleDeveloper | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleDeveloper method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleDeveloper%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageRoleDeveloper } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagerolesystem.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagerolesystem.mdx deleted file mode 100644 index 0b031a71..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagerolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleSystem - TypeScript SDK -description: OpenResponsesEasyInputMessageRoleSystem method reference -seoTitle: OpenResponsesEasyInputMessageRoleSystem | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagerolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleSystem | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleSystem method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleSystem%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageRoleSystem } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessageroleunion.mdx b/client-sdks/typescript/models/openresponseseasyinputmessageroleunion.mdx deleted file mode 100644 index 71514c21..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessageroleunion.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleUnion - TypeScript SDK -description: OpenResponsesEasyInputMessageRoleUnion method reference -seoTitle: OpenResponsesEasyInputMessageRoleUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessageroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleUnion%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesEasyInputMessageRoleUser` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageRoleUser = "user"; -``` - -### `models.OpenResponsesEasyInputMessageRoleSystem` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageRoleSystem = "system"; -``` - -### `models.OpenResponsesEasyInputMessageRoleAssistant` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageRoleAssistant = "assistant"; -``` - -### `models.OpenResponsesEasyInputMessageRoleDeveloper` - -```typescript lines -const value: models.OpenResponsesEasyInputMessageRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessageroleuser.mdx b/client-sdks/typescript/models/openresponseseasyinputmessageroleuser.mdx deleted file mode 100644 index 6a6c6492..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessageroleuser.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageRoleUser - TypeScript SDK -description: OpenResponsesEasyInputMessageRoleUser method reference -seoTitle: OpenResponsesEasyInputMessageRoleUser | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessageroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageRoleUser | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageRoleUser method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageRoleUser%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageRoleUser } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseseasyinputmessagetypemessage.mdx b/client-sdks/typescript/models/openresponseseasyinputmessagetypemessage.mdx deleted file mode 100644 index 98ddb988..00000000 --- a/client-sdks/typescript/models/openresponseseasyinputmessagetypemessage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesEasyInputMessageTypeMessage - TypeScript SDK -description: OpenResponsesEasyInputMessageTypeMessage method reference -seoTitle: OpenResponsesEasyInputMessageTypeMessage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseseasyinputmessagetypemessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesEasyInputMessageTypeMessage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesEasyInputMessageTypeMessage method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesEasyInputMessageTypeMessage%20-%20TypeScript%20SDK&description=OpenResponsesEasyInputMessageTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesEasyInputMessageTypeMessage } from "@openrouter/sdk/models"; - -let value: OpenResponsesEasyInputMessageTypeMessage = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseserrorevent.mdx b/client-sdks/typescript/models/openresponseserrorevent.mdx deleted file mode 100644 index 87965d01..00000000 --- a/client-sdks/typescript/models/openresponseserrorevent.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenResponsesErrorEvent - TypeScript SDK -description: OpenResponsesErrorEvent method reference -seoTitle: OpenResponsesErrorEvent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponseserrorevent' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesErrorEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesErrorEvent method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesErrorEvent%20-%20TypeScript%20SDK&description=OpenResponsesErrorEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when an error occurs during streaming - -## Example Usage - -```typescript lines -import { OpenResponsesErrorEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesErrorEvent = { - type: "error", - code: "rate_limit_exceeded", - message: "Rate limit exceeded. Please try again later.", - param: null, - sequenceNumber: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"error"* | :heavy_check_mark: | N/A | -| `code` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `param` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesfunctioncalloutput.mdx b/client-sdks/typescript/models/openresponsesfunctioncalloutput.mdx deleted file mode 100644 index 3a29478f..00000000 --- a/client-sdks/typescript/models/openresponsesfunctioncalloutput.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OpenResponsesFunctionCallOutput - TypeScript SDK -description: OpenResponsesFunctionCallOutput method reference -seoTitle: OpenResponsesFunctionCallOutput | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesfunctioncalloutput -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionCallOutput | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesFunctionCallOutput method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionCallOutput%20-%20TypeScript%20SDK&description=OpenResponsesFunctionCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The output from a function call execution - -## Example Usage - -```typescript lines -import { OpenResponsesFunctionCallOutput } from "@openrouter/sdk/models"; - -let value: OpenResponsesFunctionCallOutput = { - type: "function_call_output", - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [models.OpenResponsesFunctionCallOutputType](/client-sdks/typescript/models/openresponsesfunctioncalloutputtype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `output` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesfunctioncalloutputtype.mdx b/client-sdks/typescript/models/openresponsesfunctioncalloutputtype.mdx deleted file mode 100644 index 9516ff6b..00000000 --- a/client-sdks/typescript/models/openresponsesfunctioncalloutputtype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesFunctionCallOutputType - TypeScript SDK -description: OpenResponsesFunctionCallOutputType method reference -seoTitle: OpenResponsesFunctionCallOutputType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesfunctioncalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionCallOutputType | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesFunctionCallOutputType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionCallOutputType%20-%20TypeScript%20SDK&description=OpenResponsesFunctionCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesFunctionCallOutputType } from "@openrouter/sdk/models"; - -let value: OpenResponsesFunctionCallOutputType = "function_call_output"; -``` - -## Values - -```typescript lines -"function_call_output" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesfunctiontoolcall.mdx b/client-sdks/typescript/models/openresponsesfunctiontoolcall.mdx deleted file mode 100644 index 72a361fd..00000000 --- a/client-sdks/typescript/models/openresponsesfunctiontoolcall.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OpenResponsesFunctionToolCall - TypeScript SDK -description: OpenResponsesFunctionToolCall method reference -seoTitle: OpenResponsesFunctionToolCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesfunctiontoolcall -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionToolCall | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesFunctionToolCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionToolCall%20-%20TypeScript%20SDK&description=OpenResponsesFunctionToolCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -A function call initiated by the model - -## Example Usage - -```typescript lines -import { OpenResponsesFunctionToolCall } from "@openrouter/sdk/models"; - -let value: OpenResponsesFunctionToolCall = { - type: "function_call", - callId: "call-abc123", - name: "get_weather", - arguments: "{\"location\":\"San Francisco\"}", - id: "call-abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `type` | [models.OpenResponsesFunctionToolCallType](/client-sdks/typescript/models/openresponsesfunctiontoolcalltype) | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](/client-sdks/typescript/models/toolcallstatus) | :heavy_minus_sign: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesfunctiontoolcalltype.mdx b/client-sdks/typescript/models/openresponsesfunctiontoolcalltype.mdx deleted file mode 100644 index 08dfea17..00000000 --- a/client-sdks/typescript/models/openresponsesfunctiontoolcalltype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesFunctionToolCallType - TypeScript SDK -description: OpenResponsesFunctionToolCallType method reference -seoTitle: OpenResponsesFunctionToolCallType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesfunctiontoolcalltype -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesFunctionToolCallType | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesFunctionToolCallType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesFunctionToolCallType%20-%20TypeScript%20SDK&description=OpenResponsesFunctionToolCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesFunctionToolCallType } from "@openrouter/sdk/models"; - -let value: OpenResponsesFunctionToolCallType = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesimagegencallcompleted.mdx b/client-sdks/typescript/models/openresponsesimagegencallcompleted.mdx deleted file mode 100644 index 95f21ea7..00000000 --- a/client-sdks/typescript/models/openresponsesimagegencallcompleted.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OpenResponsesImageGenCallCompleted - TypeScript SDK -description: OpenResponsesImageGenCallCompleted method reference -seoTitle: OpenResponsesImageGenCallCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesimagegencallcompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallCompleted | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesImageGenCallCompleted method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallCompleted%20-%20TypeScript%20SDK&description=OpenResponsesImageGenCallCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call completed - -## Example Usage - -```typescript lines -import { OpenResponsesImageGenCallCompleted } from "@openrouter/sdk/models"; - -let value: OpenResponsesImageGenCallCompleted = { - type: "response.image_generation_call.completed", - itemId: "", - outputIndex: 3469.55, - sequenceNumber: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `type` | *"response.image_generation_call.completed"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesimagegencallgenerating.mdx b/client-sdks/typescript/models/openresponsesimagegencallgenerating.mdx deleted file mode 100644 index 91ee8d74..00000000 --- a/client-sdks/typescript/models/openresponsesimagegencallgenerating.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OpenResponsesImageGenCallGenerating - TypeScript SDK -description: OpenResponsesImageGenCallGenerating method reference -seoTitle: OpenResponsesImageGenCallGenerating | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesimagegencallgenerating -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallGenerating | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesImageGenCallGenerating method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallGenerating%20-%20TypeScript%20SDK&description=OpenResponsesImageGenCallGenerating%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call is generating - -## Example Usage - -```typescript lines -import { OpenResponsesImageGenCallGenerating } from "@openrouter/sdk/models"; - -let value: OpenResponsesImageGenCallGenerating = { - type: "response.image_generation_call.generating", - itemId: "", - outputIndex: 7977.54, - sequenceNumber: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `type` | *"response.image_generation_call.generating"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesimagegencallinprogress.mdx b/client-sdks/typescript/models/openresponsesimagegencallinprogress.mdx deleted file mode 100644 index 15f28212..00000000 --- a/client-sdks/typescript/models/openresponsesimagegencallinprogress.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: OpenResponsesImageGenCallInProgress - TypeScript SDK -description: OpenResponsesImageGenCallInProgress method reference -seoTitle: OpenResponsesImageGenCallInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesimagegencallinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallInProgress | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesImageGenCallInProgress method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallInProgress%20-%20TypeScript%20SDK&description=OpenResponsesImageGenCallInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call in progress - -## Example Usage - -```typescript lines -import { OpenResponsesImageGenCallInProgress } from "@openrouter/sdk/models"; - -let value: OpenResponsesImageGenCallInProgress = { - type: "response.image_generation_call.in_progress", - itemId: "", - outputIndex: 9914.45, - sequenceNumber: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `type` | *"response.image_generation_call.in_progress"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesimagegencallpartialimage.mdx b/client-sdks/typescript/models/openresponsesimagegencallpartialimage.mdx deleted file mode 100644 index 1fa70460..00000000 --- a/client-sdks/typescript/models/openresponsesimagegencallpartialimage.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: OpenResponsesImageGenCallPartialImage - TypeScript SDK -description: OpenResponsesImageGenCallPartialImage method reference -seoTitle: OpenResponsesImageGenCallPartialImage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesimagegencallpartialimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesImageGenCallPartialImage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesImageGenCallPartialImage method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesImageGenCallPartialImage%20-%20TypeScript%20SDK&description=OpenResponsesImageGenCallPartialImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image generation call with partial image - -## Example Usage - -```typescript lines -import { OpenResponsesImageGenCallPartialImage } from "@openrouter/sdk/models"; - -let value: OpenResponsesImageGenCallPartialImage = { - type: "response.image_generation_call.partial_image", - itemId: "", - outputIndex: 2243.31, - sequenceNumber: 0, - partialImageB64: "", - partialImageIndex: 1141.42, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `type` | *"response.image_generation_call.partial_image"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `partialImageB64` | *string* | :heavy_check_mark: | N/A | -| `partialImageIndex` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinput.mdx b/client-sdks/typescript/models/openresponsesinput.mdx deleted file mode 100644 index 81544341..00000000 --- a/client-sdks/typescript/models/openresponsesinput.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenResponsesInput - TypeScript SDK -description: OpenResponsesInput method reference -seoTitle: OpenResponsesInput | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesinput' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInput | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInput method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInput%20-%20TypeScript%20SDK&description=OpenResponsesInput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Input for a response request - can be a string or array of items - -## Supported Types - -### `string` - -```typescript lines -const value: string = - "[{\"role\":\"user\",\"content\":\"What is the weather today?\"}]"; -``` - -### `models.OpenResponsesInput1[]` - -```typescript lines -const value: models.OpenResponsesInput1[] = [ - { - role: "user", - content: "What is the weather today?", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinput1.mdx b/client-sdks/typescript/models/openresponsesinput1.mdx deleted file mode 100644 index 7755f9ab..00000000 --- a/client-sdks/typescript/models/openresponsesinput1.mdx +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: OpenResponsesInput1 - TypeScript SDK -description: OpenResponsesInput1 method reference -seoTitle: OpenResponsesInput1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesinput1' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInput1 | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInput1 method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInput1%20-%20TypeScript%20SDK&description=OpenResponsesInput1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesReasoning` - -```typescript lines -const value: models.OpenResponsesReasoning = { - type: "reasoning", - id: "reasoning-abc123", - summary: [ - { - type: "summary_text", - text: "Analyzed the problem using first principles", - }, - ], -}; -``` - -### `models.OpenResponsesEasyInputMessage` - -```typescript lines -const value: models.OpenResponsesEasyInputMessage = { - role: "system", - content: "", -}; -``` - -### `models.OpenResponsesInputMessageItem` - -```typescript lines -const value: models.OpenResponsesInputMessageItem = { - role: "system", - content: [ - { - type: "input_text", - text: "Hello, how can I help you?", - }, - ], -}; -``` - -### `models.OpenResponsesFunctionToolCall` - -```typescript lines -const value: models.OpenResponsesFunctionToolCall = { - type: "function_call", - callId: "call-abc123", - name: "get_weather", - arguments: "{\"location\":\"San Francisco\"}", - id: "call-abc123", -}; -``` - -### `models.OpenResponsesFunctionCallOutput` - -```typescript lines -const value: models.OpenResponsesFunctionCallOutput = { - type: "function_call_output", - callId: "call-abc123", - output: "{\"temperature\":72,\"conditions\":\"sunny\"}", -}; -``` - -### `models.ResponsesOutputMessage` - -```typescript lines -const value: models.ResponsesOutputMessage = { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], -}; -``` - -### `models.ResponsesOutputItemReasoning` - -```typescript lines -const value: models.ResponsesOutputItemReasoning = { - type: "reasoning", - id: "reasoning-abc123", - summary: [ - { - type: "summary_text", - text: "Analyzed the problem using first principles", - }, - ], -}; -``` - -### `models.ResponsesOutputItemFunctionCall` - -```typescript lines -const value: models.ResponsesOutputItemFunctionCall = { - type: "function_call", - name: "get_weather", - arguments: "{\"location\":\"San Francisco\",\"unit\":\"celsius\"}", - callId: "call-abc123", -}; -``` - -### `models.ResponsesWebSearchCallOutput` - -```typescript lines -const value: models.ResponsesWebSearchCallOutput = { - type: "web_search_call", - id: "search-abc123", - status: "completed", -}; -``` - -### `models.ResponsesOutputItemFileSearchCall` - -```typescript lines -const value: models.ResponsesOutputItemFileSearchCall = { - type: "file_search_call", - id: "filesearch-abc123", - queries: [ - "machine learning algorithms", - "neural networks", - ], - status: "completed", -}; -``` - -### `models.ResponsesImageGenerationCall` - -```typescript lines -const value: models.ResponsesImageGenerationCall = { - type: "image_generation_call", - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitem.mdx b/client-sdks/typescript/models/openresponsesinputmessageitem.mdx deleted file mode 100644 index f041208d..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitem.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: OpenResponsesInputMessageItem - TypeScript SDK -description: OpenResponsesInputMessageItem method reference -seoTitle: OpenResponsesInputMessageItem | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItem | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItem method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItem%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItem } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItem = { - role: "system", - content: [ - { - type: "input_text", - text: "Hello, how can I help you?", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.OpenResponsesInputMessageItemTypeMessage](/client-sdks/typescript/models/openresponsesinputmessageitemtypemessage) | :heavy_minus_sign: | N/A | -| `role` | *models.OpenResponsesInputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `content` | *models.OpenResponsesInputMessageItemContentUnion*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemcontentinputimage.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemcontentinputimage.mdx deleted file mode 100644 index 7436ab73..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemcontentinputimage.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: OpenResponsesInputMessageItemContentInputImage - TypeScript SDK -description: OpenResponsesInputMessageItemContentInputImage method reference -seoTitle: OpenResponsesInputMessageItemContentInputImage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemcontentinputimage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemContentInputImage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemContentInputImage method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemContentInputImage%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemContentInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemContentInputImage } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemContentInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | -| `detail` | [models.OpenResponsesInputMessageItemDetail](/client-sdks/typescript/models/openresponsesinputmessageitemdetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemcontentunion.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemcontentunion.mdx deleted file mode 100644 index 9afcb5f4..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemcontentunion.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: OpenResponsesInputMessageItemContentUnion - TypeScript SDK -description: OpenResponsesInputMessageItemContentUnion method reference -seoTitle: OpenResponsesInputMessageItemContentUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemcontentunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemContentUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemContentUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemContentUnion%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemContentUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseInputText` - -```typescript lines -const value: models.ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -### `models.OpenResponsesInputMessageItemContentInputImage` - -```typescript lines -const value: models.OpenResponsesInputMessageItemContentInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -### `models.ResponseInputFile` - -```typescript lines -const value: models.ResponseInputFile = { - type: "input_file", -}; -``` - -### `models.ResponseInputAudio` - -```typescript lines -const value: models.ResponseInputAudio = { - type: "input_audio", - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, -}; -``` - -### `models.ResponseInputVideo` - -```typescript lines -const value: models.ResponseInputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemdetail.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemdetail.mdx deleted file mode 100644 index f00b0383..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemdetail.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesInputMessageItemDetail - TypeScript SDK -description: OpenResponsesInputMessageItemDetail method reference -seoTitle: OpenResponsesInputMessageItemDetail | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemdetail -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemDetail | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemDetail method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemDetail%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemDetail } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemDetail = "high"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "high" | "low" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemroledeveloper.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemroledeveloper.mdx deleted file mode 100644 index 020e4ffd..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemroledeveloper.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleDeveloper - TypeScript SDK -description: OpenResponsesInputMessageItemRoleDeveloper method reference -seoTitle: OpenResponsesInputMessageItemRoleDeveloper | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemroledeveloper -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleDeveloper | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemRoleDeveloper method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleDeveloper%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemRoleDeveloper%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemRoleDeveloper } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemRoleDeveloper = "developer"; -``` - -## Values - -```typescript lines -"developer" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemrolesystem.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemrolesystem.mdx deleted file mode 100644 index 8135d27f..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemrolesystem.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleSystem - TypeScript SDK -description: OpenResponsesInputMessageItemRoleSystem method reference -seoTitle: OpenResponsesInputMessageItemRoleSystem | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemrolesystem -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleSystem | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemRoleSystem method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleSystem%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemRoleSystem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemRoleSystem } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemRoleSystem = "system"; -``` - -## Values - -```typescript lines -"system" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemroleunion.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemroleunion.mdx deleted file mode 100644 index f47a9d1d..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemroleunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleUnion - TypeScript SDK -description: OpenResponsesInputMessageItemRoleUnion method reference -seoTitle: OpenResponsesInputMessageItemRoleUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemroleunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemRoleUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleUnion%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemRoleUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesInputMessageItemRoleUser` - -```typescript lines -const value: models.OpenResponsesInputMessageItemRoleUser = "user"; -``` - -### `models.OpenResponsesInputMessageItemRoleSystem` - -```typescript lines -const value: models.OpenResponsesInputMessageItemRoleSystem = "system"; -``` - -### `models.OpenResponsesInputMessageItemRoleDeveloper` - -```typescript lines -const value: models.OpenResponsesInputMessageItemRoleDeveloper = "developer"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemroleuser.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemroleuser.mdx deleted file mode 100644 index a1827d40..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemroleuser.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesInputMessageItemRoleUser - TypeScript SDK -description: OpenResponsesInputMessageItemRoleUser method reference -seoTitle: OpenResponsesInputMessageItemRoleUser | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemroleuser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemRoleUser | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemRoleUser method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemRoleUser%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemRoleUser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemRoleUser } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemRoleUser = "user"; -``` - -## Values - -```typescript lines -"user" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesinputmessageitemtypemessage.mdx b/client-sdks/typescript/models/openresponsesinputmessageitemtypemessage.mdx deleted file mode 100644 index f9e18e09..00000000 --- a/client-sdks/typescript/models/openresponsesinputmessageitemtypemessage.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesInputMessageItemTypeMessage - TypeScript SDK -description: OpenResponsesInputMessageItemTypeMessage method reference -seoTitle: OpenResponsesInputMessageItemTypeMessage | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesinputmessageitemtypemessage -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesInputMessageItemTypeMessage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesInputMessageItemTypeMessage method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesInputMessageItemTypeMessage%20-%20TypeScript%20SDK&description=OpenResponsesInputMessageItemTypeMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesInputMessageItemTypeMessage } from "@openrouter/sdk/models"; - -let value: OpenResponsesInputMessageItemTypeMessage = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseslogprobs.mdx b/client-sdks/typescript/models/openresponseslogprobs.mdx deleted file mode 100644 index 79995f88..00000000 --- a/client-sdks/typescript/models/openresponseslogprobs.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesLogProbs - TypeScript SDK -description: OpenResponsesLogProbs method reference -seoTitle: OpenResponsesLogProbs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponseslogprobs' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesLogProbs | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesLogProbs method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesLogProbs%20-%20TypeScript%20SDK&description=OpenResponsesLogProbs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Log probability information for a token - -## Example Usage - -```typescript lines -import { OpenResponsesLogProbs } from "@openrouter/sdk/models"; - -let value: OpenResponsesLogProbs = { - logprob: -0.1, - token: "world", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.OpenResponsesTopLogprobs](/client-sdks/typescript/models/openresponsestoplogprobs)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesnonstreamingresponse.mdx b/client-sdks/typescript/models/openresponsesnonstreamingresponse.mdx deleted file mode 100644 index b1cf8044..00000000 --- a/client-sdks/typescript/models/openresponsesnonstreamingresponse.mdx +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponse - TypeScript SDK -description: OpenResponsesNonStreamingResponse method reference -seoTitle: OpenResponsesNonStreamingResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesnonstreamingresponse -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponse | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesNonStreamingResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponse%20-%20TypeScript%20SDK&description=OpenResponsesNonStreamingResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Complete non-streaming response from the Responses API - -## Example Usage - -```typescript expandable lines -import { OpenResponsesNonStreamingResponse } from "@openrouter/sdk/models"; - -let value: OpenResponsesNonStreamingResponse = { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "completed", - completedAt: null, - output: [ - { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], - }, - ], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 293.66, - frequencyPenalty: 9884.38, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `object` | [models.ObjectT](/client-sdks/typescript/models/objectt) | :heavy_check_mark: | N/A | | -| `createdAt` | *number* | :heavy_check_mark: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.OpenAIResponsesResponseStatus](/client-sdks/typescript/models/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | | -| `completedAt` | *number* | :heavy_check_mark: | N/A | | -| `output` | *models.ResponsesOutputItem*[] | :heavy_check_mark: | N/A | | -| `user` | *string* | :heavy_minus_sign: | N/A | | -| `outputText` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | -| `error` | [models.ResponsesErrorField](/client-sdks/typescript/models/responseserrorfield) | :heavy_check_mark: | Error information returned from the API | `{"code": "rate_limit_exceeded","message": "Rate limit exceeded. Please try again later."}` | -| `incompleteDetails` | [models.OpenAIResponsesIncompleteDetails](/client-sdks/typescript/models/openairesponsesincompletedetails) | :heavy_check_mark: | N/A | | -| `usage` | [models.OpenResponsesUsage](/client-sdks/typescript/models/openresponsesusage) | :heavy_minus_sign: | Token usage information for the response | `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`,
"cost": 0.0012,
"cost_details": `{"upstream_inference_cost": null,"upstream_inference_input_cost": 0.0008,"upstream_inference_output_cost": 0.0004}`
} | -| `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_check_mark: | N/A | | -| `topP` | *number* | :heavy_check_mark: | N/A | | -| `presencePenalty` | *number* | :heavy_check_mark: | N/A | | -| `frequencyPenalty` | *number* | :heavy_check_mark: | N/A | | -| `instructions` | *models.OpenAIResponsesInputUnion* | :heavy_check_mark: | N/A | | -| `metadata` | `Record` | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | `{"user_id": "123","session_id": "abc-def-ghi"}` | -| `tools` | *models.OpenResponsesNonStreamingResponseToolUnion*[] | :heavy_check_mark: | N/A | | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_check_mark: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_check_mark: | N/A | | -| `prompt` | [models.OpenAIResponsesPrompt](/client-sdks/typescript/models/openairesponsesprompt) | :heavy_minus_sign: | N/A | | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `reasoning` | [models.OpenAIResponsesReasoningConfig](/client-sdks/typescript/models/openairesponsesreasoningconfig) | :heavy_minus_sign: | N/A | | -| `serviceTier` | [models.OpenAIResponsesServiceTier](/client-sdks/typescript/models/openairesponsesservicetier) | :heavy_minus_sign: | N/A | | -| `store` | *boolean* | :heavy_minus_sign: | N/A | | -| `truncation` | [models.OpenAIResponsesTruncation](/client-sdks/typescript/models/openairesponsestruncation) | :heavy_minus_sign: | N/A | | -| `text` | [models.ResponseTextConfig](/client-sdks/typescript/models/responsetextconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
} | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolfunction.mdx b/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolfunction.mdx deleted file mode 100644 index d8b0e015..00000000 --- a/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolfunction.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponseToolFunction - TypeScript SDK -description: OpenResponsesNonStreamingResponseToolFunction method reference -seoTitle: OpenResponsesNonStreamingResponseToolFunction | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesnonstreamingresponsetoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponseToolFunction | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesNonStreamingResponseToolFunction method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponseToolFunction%20-%20TypeScript%20SDK&description=OpenResponsesNonStreamingResponseToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Example Usage - -```typescript expandable lines -import { OpenResponsesNonStreamingResponseToolFunction } from "@openrouter/sdk/models"; - -let value: OpenResponsesNonStreamingResponseToolFunction = { - type: "function", - name: "get_weather", - parameters: { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The city and state", - }, - "unit": { - "type": "string", - "enum": [ - "celsius", - "fahrenheit", - ], - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `type` | *"function"* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `parameters` | `Record` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolunion.mdx b/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolunion.mdx deleted file mode 100644 index 1683e376..00000000 --- a/client-sdks/typescript/models/openresponsesnonstreamingresponsetoolunion.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: OpenResponsesNonStreamingResponseToolUnion - TypeScript SDK -description: OpenResponsesNonStreamingResponseToolUnion method reference -seoTitle: OpenResponsesNonStreamingResponseToolUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesnonstreamingresponsetoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesNonStreamingResponseToolUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesNonStreamingResponseToolUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesNonStreamingResponseToolUnion%20-%20TypeScript%20SDK&description=OpenResponsesNonStreamingResponseToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesNonStreamingResponseToolFunction` - -```typescript expandable lines -const value: models.OpenResponsesNonStreamingResponseToolFunction = { - type: "function", - name: "get_weather", - parameters: { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The city and state", - }, - "unit": { - "type": "string", - "enum": [ - "celsius", - "fahrenheit", - ], - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - }, -}; -``` - -### `models.OpenResponsesWebSearchPreviewTool` - -```typescript lines -const value: models.OpenResponsesWebSearchPreviewTool = { - type: "web_search_preview", -}; -``` - -### `models.OpenResponsesWebSearchPreview20250311Tool` - -```typescript lines -const value: models.OpenResponsesWebSearchPreview20250311Tool = { - type: "web_search_preview_2025_03_11", -}; -``` - -### `models.OpenResponsesWebSearchTool` - -```typescript lines -const value: models.OpenResponsesWebSearchTool = { - type: "web_search", -}; -``` - -### `models.OpenResponsesWebSearch20250826Tool` - -```typescript lines -const value: models.OpenResponsesWebSearch20250826Tool = { - type: "web_search_2025_08_26", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoning.mdx b/client-sdks/typescript/models/openresponsesreasoning.mdx deleted file mode 100644 index 35c765bd..00000000 --- a/client-sdks/typescript/models/openresponsesreasoning.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: OpenResponsesReasoning - TypeScript SDK -description: OpenResponsesReasoning method reference -seoTitle: OpenResponsesReasoning | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesreasoning' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoning | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoning method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoning%20-%20TypeScript%20SDK&description=OpenResponsesReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Reasoning output item with signature and format extensions - -## Example Usage - -```typescript lines -import { OpenResponsesReasoning } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoning = { - type: "reasoning", - id: "reasoning-abc123", - summary: [ - { - type: "summary_text", - text: "Analyzed the problem using first principles", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | [models.OpenResponsesReasoningType](/client-sdks/typescript/models/openresponsesreasoningtype) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `content` | [models.ReasoningTextContent](/client-sdks/typescript/models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | -| `summary` | [models.ReasoningSummaryText](/client-sdks/typescript/models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | -| `status` | *models.OpenResponsesReasoningStatusUnion* | :heavy_minus_sign: | N/A | -| `signature` | *string* | :heavy_minus_sign: | N/A | -| `format` | [models.OpenResponsesReasoningFormat](/client-sdks/typescript/models/openresponsesreasoningformat) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningconfig.mdx b/client-sdks/typescript/models/openresponsesreasoningconfig.mdx deleted file mode 100644 index a70d29ed..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningconfig.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesReasoningConfig - TypeScript SDK -description: OpenResponsesReasoningConfig method reference -seoTitle: OpenResponsesReasoningConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesreasoningconfig' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningConfig | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningConfig%20-%20TypeScript%20SDK&description=OpenResponsesReasoningConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Configuration for reasoning mode in the response - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningConfig } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `effort` | [models.OpenAIResponsesReasoningEffort](/client-sdks/typescript/models/openairesponsesreasoningeffort) | :heavy_minus_sign: | N/A | -| `summary` | [models.ReasoningSummaryVerbosity](/client-sdks/typescript/models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningdeltaevent.mdx b/client-sdks/typescript/models/openresponsesreasoningdeltaevent.mdx deleted file mode 100644 index 8a20bec9..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningdeltaevent.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: OpenResponsesReasoningDeltaEvent - TypeScript SDK -description: OpenResponsesReasoningDeltaEvent method reference -seoTitle: OpenResponsesReasoningDeltaEvent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDeltaEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningDeltaEvent method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDeltaEvent%20-%20TypeScript%20SDK&description=OpenResponsesReasoningDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text delta is streamed - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningDeltaEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningDeltaEvent = { - type: "response.reasoning_text.delta", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "First, we need", - sequenceNumber: 4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `type` | *"response.reasoning_text.delta"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningdoneevent.mdx b/client-sdks/typescript/models/openresponsesreasoningdoneevent.mdx deleted file mode 100644 index 482d32fe..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningdoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenResponsesReasoningDoneEvent - TypeScript SDK -description: OpenResponsesReasoningDoneEvent method reference -seoTitle: OpenResponsesReasoningDoneEvent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningdoneevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningDoneEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningDoneEvent method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningDoneEvent%20-%20TypeScript%20SDK&description=OpenResponsesReasoningDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning text streaming is complete - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningDoneEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningDoneEvent = { - type: "response.reasoning_text.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - text: - "First, we need to identify the key components and then combine them logically.", - sequenceNumber: 6, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `type` | *"response.reasoning_text.done"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningformat.mdx b/client-sdks/typescript/models/openresponsesreasoningformat.mdx deleted file mode 100644 index 9c507c79..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningformat.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesReasoningFormat - TypeScript SDK -description: OpenResponsesReasoningFormat method reference -seoTitle: OpenResponsesReasoningFormat | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesreasoningformat' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningFormat | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningFormat method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningFormat%20-%20TypeScript%20SDK&description=OpenResponsesReasoningFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningFormat } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningFormat = "unknown"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"unknown" | "openai-responses-v1" | "azure-openai-responses-v1" | "xai-responses-v1" | "anthropic-claude-v1" | "google-gemini-v1" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningstatuscompleted.mdx b/client-sdks/typescript/models/openresponsesreasoningstatuscompleted.mdx deleted file mode 100644 index 2fc25bae..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningstatuscompleted.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesReasoningStatusCompleted - TypeScript SDK -description: OpenResponsesReasoningStatusCompleted method reference -seoTitle: OpenResponsesReasoningStatusCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusCompleted | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningStatusCompleted method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusCompleted%20-%20TypeScript%20SDK&description=OpenResponsesReasoningStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningStatusCompleted } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningstatusincomplete.mdx b/client-sdks/typescript/models/openresponsesreasoningstatusincomplete.mdx deleted file mode 100644 index 266591d3..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningstatusincomplete.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesReasoningStatusIncomplete - TypeScript SDK -description: OpenResponsesReasoningStatusIncomplete method reference -seoTitle: OpenResponsesReasoningStatusIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusIncomplete | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningStatusIncomplete method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusIncomplete%20-%20TypeScript%20SDK&description=OpenResponsesReasoningStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningstatusinprogress.mdx b/client-sdks/typescript/models/openresponsesreasoningstatusinprogress.mdx deleted file mode 100644 index 9be3541b..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningstatusinprogress.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesReasoningStatusInProgress - TypeScript SDK -description: OpenResponsesReasoningStatusInProgress method reference -seoTitle: OpenResponsesReasoningStatusInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusInProgress | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningStatusInProgress method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusInProgress%20-%20TypeScript%20SDK&description=OpenResponsesReasoningStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningStatusInProgress } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningstatusunion.mdx b/client-sdks/typescript/models/openresponsesreasoningstatusunion.mdx deleted file mode 100644 index 7a46e95e..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningstatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesReasoningStatusUnion - TypeScript SDK -description: OpenResponsesReasoningStatusUnion method reference -seoTitle: OpenResponsesReasoningStatusUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningstatusunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningStatusUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningStatusUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningStatusUnion%20-%20TypeScript%20SDK&description=OpenResponsesReasoningStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesReasoningStatusCompleted` - -```typescript lines -const value: models.OpenResponsesReasoningStatusCompleted = "completed"; -``` - -### `models.OpenResponsesReasoningStatusIncomplete` - -```typescript lines -const value: models.OpenResponsesReasoningStatusIncomplete = "incomplete"; -``` - -### `models.OpenResponsesReasoningStatusInProgress` - -```typescript lines -const value: models.OpenResponsesReasoningStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningsummarypartaddedevent.mdx b/client-sdks/typescript/models/openresponsesreasoningsummarypartaddedevent.mdx deleted file mode 100644 index dd9931f9..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningsummarypartaddedevent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryPartAddedEvent - TypeScript SDK -description: OpenResponsesReasoningSummaryPartAddedEvent method reference -seoTitle: OpenResponsesReasoningSummaryPartAddedEvent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningsummarypartaddedevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryPartAddedEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningSummaryPartAddedEvent method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryPartAddedEvent%20-%20TypeScript%20SDK&description=OpenResponsesReasoningSummaryPartAddedEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is added - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningSummaryPartAddedEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningSummaryPartAddedEvent = { - type: "response.reasoning_summary_part.added", - outputIndex: 0, - itemId: "item-1", - summaryIndex: 0, - part: { - type: "summary_text", - text: "", - }, - sequenceNumber: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `type` | *"response.reasoning_summary_part.added"* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](/client-sdks/typescript/models/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"type": "summary_text","text": "Analyzed the problem using first principles"}` | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningsummarytextdeltaevent.mdx b/client-sdks/typescript/models/openresponsesreasoningsummarytextdeltaevent.mdx deleted file mode 100644 index 1e037032..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningsummarytextdeltaevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDeltaEvent - TypeScript SDK -description: OpenResponsesReasoningSummaryTextDeltaEvent method reference -seoTitle: OpenResponsesReasoningSummaryTextDeltaEvent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningsummarytextdeltaevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDeltaEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDeltaEvent method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDeltaEvent%20-%20TypeScript%20SDK&description=OpenResponsesReasoningSummaryTextDeltaEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text delta is streamed - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningSummaryTextDeltaEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningSummaryTextDeltaEvent = { - type: "response.reasoning_summary_text.delta", - itemId: "item-1", - outputIndex: 0, - summaryIndex: 0, - delta: "Analyzing", - sequenceNumber: 4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `type` | *"response.reasoning_summary_text.delta"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningsummarytextdoneevent.mdx b/client-sdks/typescript/models/openresponsesreasoningsummarytextdoneevent.mdx deleted file mode 100644 index 3de56dee..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningsummarytextdoneevent.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenResponsesReasoningSummaryTextDoneEvent - TypeScript SDK -description: OpenResponsesReasoningSummaryTextDoneEvent method reference -seoTitle: OpenResponsesReasoningSummaryTextDoneEvent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesreasoningsummarytextdoneevent -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningSummaryTextDoneEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningSummaryTextDoneEvent method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningSummaryTextDoneEvent%20-%20TypeScript%20SDK&description=OpenResponsesReasoningSummaryTextDoneEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when reasoning summary text streaming is complete - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningSummaryTextDoneEvent } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningSummaryTextDoneEvent = { - type: "response.reasoning_summary_text.done", - itemId: "item-1", - outputIndex: 0, - summaryIndex: 0, - text: "Analyzing the problem step by step to find the optimal solution.", - sequenceNumber: 6, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | *"response.reasoning_summary_text.done"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesreasoningtype.mdx b/client-sdks/typescript/models/openresponsesreasoningtype.mdx deleted file mode 100644 index 08f90dd3..00000000 --- a/client-sdks/typescript/models/openresponsesreasoningtype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesReasoningType - TypeScript SDK -description: OpenResponsesReasoningType method reference -seoTitle: OpenResponsesReasoningType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesreasoningtype' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesReasoningType | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesReasoningType method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesReasoningType%20-%20TypeScript%20SDK&description=OpenResponsesReasoningType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesReasoningType } from "@openrouter/sdk/models"; - -let value: OpenResponsesReasoningType = "reasoning"; -``` - -## Values - -```typescript lines -"reasoning" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequest.mdx b/client-sdks/typescript/models/openresponsesrequest.mdx deleted file mode 100644 index 73ee9435..00000000 --- a/client-sdks/typescript/models/openresponsesrequest.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: OpenResponsesRequest - TypeScript SDK -description: OpenResponsesRequest method reference -seoTitle: OpenResponsesRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequest' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequest | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequest%20-%20TypeScript%20SDK&description=OpenResponsesRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Request schema for Responses endpoint - -## Example Usage - -```typescript lines -import { OpenResponsesRequest } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | *models.OpenResponsesInput* | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
`{"role": "user","content": "What is the weather today?"}`
] | -| `instructions` | *string* | :heavy_minus_sign: | N/A | | -| `metadata` | `Record` | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | `{"user_id": "123","session_id": "abc-def-ghi"}` | -| `tools` | *models.OpenResponsesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_minus_sign: | N/A | | -| `models` | *string*[] | :heavy_minus_sign: | N/A | | -| `text` | [models.OpenResponsesResponseText](/client-sdks/typescript/models/openresponsesresponsetext) | :heavy_minus_sign: | Text output configuration including format and verbosity | `{"format": {"type": "text"}`,
"verbosity": "medium"
} | -| `reasoning` | [models.OpenResponsesReasoningConfig](/client-sdks/typescript/models/openresponsesreasoningconfig) | :heavy_minus_sign: | Configuration for reasoning mode in the response | `{"summary": "auto","enabled": true}` | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_minus_sign: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | | -| `topK` | *number* | :heavy_minus_sign: | N/A | | -| `imageConfig` | `Record` | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/features/multimodal/image-generation for more details. | `{"aspect_ratio": "16:9"}` | -| `modalities` | [models.ResponsesOutputModality](/client-sdks/typescript/models/responsesoutputmodality)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | [models.OpenAIResponsesPrompt](/client-sdks/typescript/models/openairesponsesprompt) | :heavy_minus_sign: | N/A | | -| `include` | [models.OpenAIResponsesIncludable](/client-sdks/typescript/models/openairesponsesincludable)[] | :heavy_minus_sign: | N/A | | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | -| `store` | *false* | :heavy_minus_sign: | N/A | | -| `serviceTier` | [models.ServiceTier](/client-sdks/typescript/models/servicetier) | :heavy_minus_sign: | N/A | | -| `truncation` | [models.Truncation](/client-sdks/typescript/models/truncation) | :heavy_minus_sign: | N/A | auto | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `provider` | [models.OpenResponsesRequestProvider](/client-sdks/typescript/models/openresponsesrequestprovider) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | | -| `plugins` | *models.OpenResponsesRequestPluginUnion*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `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 128 characters. | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow) for observability. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 128 characters. | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestignore.mdx b/client-sdks/typescript/models/openresponsesrequestignore.mdx deleted file mode 100644 index 93e52bba..00000000 --- a/client-sdks/typescript/models/openresponsesrequestignore.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestIgnore - TypeScript SDK -description: OpenResponsesRequestIgnore method reference -seoTitle: OpenResponsesRequestIgnore | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestignore' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestIgnore | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestIgnore method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestIgnore%20-%20TypeScript%20SDK&description=OpenResponsesRequestIgnore%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestimageconfig.mdx b/client-sdks/typescript/models/openresponsesrequestimageconfig.mdx deleted file mode 100644 index 4c8aed8b..00000000 --- a/client-sdks/typescript/models/openresponsesrequestimageconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesRequestImageConfig - TypeScript SDK -description: OpenResponsesRequestImageConfig method reference -seoTitle: OpenResponsesRequestImageConfig | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestimageconfig -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestImageConfig | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestImageConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestImageConfig%20-%20TypeScript%20SDK&description=OpenResponsesRequestImageConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `number` - -```typescript lines -const value: number = 1284.03; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestmaxprice.mdx b/client-sdks/typescript/models/openresponsesrequestmaxprice.mdx deleted file mode 100644 index 6ae253f9..00000000 --- a/client-sdks/typescript/models/openresponsesrequestmaxprice.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OpenResponsesRequestMaxPrice - TypeScript SDK -description: OpenResponsesRequestMaxPrice method reference -seoTitle: OpenResponsesRequestMaxPrice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestMaxPrice | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestMaxPrice method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestMaxPrice%20-%20TypeScript%20SDK&description=OpenResponsesRequestMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Example Usage - -```typescript lines -import { OpenResponsesRequestMaxPrice } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestMaxPrice = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `completion` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `request` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestonly.mdx b/client-sdks/typescript/models/openresponsesrequestonly.mdx deleted file mode 100644 index b187455b..00000000 --- a/client-sdks/typescript/models/openresponsesrequestonly.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestOnly - TypeScript SDK -description: OpenResponsesRequestOnly method reference -seoTitle: OpenResponsesRequestOnly | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestonly' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestOnly | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestOnly method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestOnly%20-%20TypeScript%20SDK&description=OpenResponsesRequestOnly%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestorder.mdx b/client-sdks/typescript/models/openresponsesrequestorder.mdx deleted file mode 100644 index 4979ea7a..00000000 --- a/client-sdks/typescript/models/openresponsesrequestorder.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OpenResponsesRequestOrder - TypeScript SDK -description: OpenResponsesRequestOrder method reference -seoTitle: OpenResponsesRequestOrder | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestorder' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestOrder | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestOrder method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestOrder%20-%20TypeScript%20SDK&description=OpenResponsesRequestOrder%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginautorouter.mdx b/client-sdks/typescript/models/openresponsesrequestpluginautorouter.mdx deleted file mode 100644 index 4218f47f..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginautorouter.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesRequestPluginAutoRouter - TypeScript SDK -description: OpenResponsesRequestPluginAutoRouter method reference -seoTitle: OpenResponsesRequestPluginAutoRouter | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginautorouter -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginAutoRouter | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginAutoRouter method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginAutoRouter%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginAutoRouter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesRequestPluginAutoRouter } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestPluginAutoRouter = { - id: "auto-router", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *"auto-router"* | :heavy_check_mark: | N/A | | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `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/*"
] | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginfileparser.mdx b/client-sdks/typescript/models/openresponsesrequestpluginfileparser.mdx deleted file mode 100644 index e6e50b3f..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginfileparser.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesRequestPluginFileParser - TypeScript SDK -description: OpenResponsesRequestPluginFileParser method reference -seoTitle: OpenResponsesRequestPluginFileParser | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginfileparser -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginFileParser | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginFileParser method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginFileParser%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginFileParser%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesRequestPluginFileParser } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestPluginFileParser = { - id: "file-parser", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `id` | *"file-parser"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | -| `pdf` | [models.PDFParserOptions](/client-sdks/typescript/models/pdfparseroptions) | :heavy_minus_sign: | Options for PDF parsing. | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginmoderation.mdx b/client-sdks/typescript/models/openresponsesrequestpluginmoderation.mdx deleted file mode 100644 index 07d69c60..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginmoderation.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesRequestPluginModeration - TypeScript SDK -description: OpenResponsesRequestPluginModeration method reference -seoTitle: OpenResponsesRequestPluginModeration | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginmoderation -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginModeration | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginModeration method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginModeration%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginModeration%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesRequestPluginModeration } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestPluginModeration = { - id: "moderation", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *"moderation"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginresponsehealing.mdx b/client-sdks/typescript/models/openresponsesrequestpluginresponsehealing.mdx deleted file mode 100644 index faaea5cd..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginresponsehealing.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: OpenResponsesRequestPluginResponseHealing - TypeScript SDK -description: OpenResponsesRequestPluginResponseHealing method reference -seoTitle: OpenResponsesRequestPluginResponseHealing | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginresponsehealing -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginResponseHealing | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginResponseHealing method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginResponseHealing%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginResponseHealing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesRequestPluginResponseHealing } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestPluginResponseHealing = { - id: "response-healing", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `id` | *"response-healing"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginunion.mdx b/client-sdks/typescript/models/openresponsesrequestpluginunion.mdx deleted file mode 100644 index d7d03464..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginunion.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesRequestPluginUnion - TypeScript SDK -description: OpenResponsesRequestPluginUnion method reference -seoTitle: OpenResponsesRequestPluginUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginUnion%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesRequestPluginAutoRouter` - -```typescript lines -const value: models.OpenResponsesRequestPluginAutoRouter = { - id: "auto-router", -}; -``` - -### `models.OpenResponsesRequestPluginModeration` - -```typescript lines -const value: models.OpenResponsesRequestPluginModeration = { - id: "moderation", -}; -``` - -### `models.OpenResponsesRequestPluginWeb` - -```typescript lines -const value: models.OpenResponsesRequestPluginWeb = { - id: "web", -}; -``` - -### `models.OpenResponsesRequestPluginFileParser` - -```typescript lines -const value: models.OpenResponsesRequestPluginFileParser = { - id: "file-parser", -}; -``` - -### `models.OpenResponsesRequestPluginResponseHealing` - -```typescript lines -const value: models.OpenResponsesRequestPluginResponseHealing = { - id: "response-healing", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestpluginweb.mdx b/client-sdks/typescript/models/openresponsesrequestpluginweb.mdx deleted file mode 100644 index d9f44deb..00000000 --- a/client-sdks/typescript/models/openresponsesrequestpluginweb.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesRequestPluginWeb - TypeScript SDK -description: OpenResponsesRequestPluginWeb method reference -seoTitle: OpenResponsesRequestPluginWeb | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequestpluginweb -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestPluginWeb | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestPluginWeb method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestPluginWeb%20-%20TypeScript%20SDK&description=OpenResponsesRequestPluginWeb%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesRequestPluginWeb } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestPluginWeb = { - id: "web", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `id` | *"web"* | :heavy_check_mark: | N/A | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | -| `maxResults` | *number* | :heavy_minus_sign: | N/A | -| `searchPrompt` | *string* | :heavy_minus_sign: | N/A | -| `engine` | [models.WebSearchEngine](/client-sdks/typescript/models/websearchengine) | :heavy_minus_sign: | The search engine to use for web search. | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestprovider.mdx b/client-sdks/typescript/models/openresponsesrequestprovider.mdx deleted file mode 100644 index 8c701f10..00000000 --- a/client-sdks/typescript/models/openresponsesrequestprovider.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OpenResponsesRequestProvider - TypeScript SDK -description: OpenResponsesRequestProvider method reference -seoTitle: OpenResponsesRequestProvider | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestprovider' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestProvider | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestProvider method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestProvider%20-%20TypeScript%20SDK&description=OpenResponsesRequestProvider%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -When multiple model providers are available, optionally indicate your routing preference. - -## Example Usage - -```typescript lines -import { OpenResponsesRequestProvider } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestProvider = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve `requests
`- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `requireParameters` | *boolean* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `dataCollection` | [models.DataCollection](/client-sdks/typescript/models/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 | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | -| `enforceDistillableText` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `order` | *models.OpenResponsesRequestOrder*[] | :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. | | -| `only` | *models.OpenResponsesRequestOnly*[] | :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. | | -| `ignore` | *models.OpenResponsesRequestIgnore*[] | :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. | | -| `quantizations` | [models.Quantization](/client-sdks/typescript/models/quantization)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `sort` | *models.OpenResponsesRequestSort* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `maxPrice` | [models.OpenResponsesRequestMaxPrice](/client-sdks/typescript/models/openresponsesrequestmaxprice) | :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. | | -| `preferredMinThroughput` | *models.PreferredMinThroughput* | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `preferredMaxLatency` | *models.PreferredMaxLatency* | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequestsort.mdx b/client-sdks/typescript/models/openresponsesrequestsort.mdx deleted file mode 100644 index 067772ff..00000000 --- a/client-sdks/typescript/models/openresponsesrequestsort.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenResponsesRequestSort - TypeScript SDK -description: OpenResponsesRequestSort method reference -seoTitle: OpenResponsesRequestSort | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesrequestsort' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestSort | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestSort method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestSort%20-%20TypeScript%20SDK&description=OpenResponsesRequestSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `models.ProviderSort` - -```typescript lines -const value: models.ProviderSort = "price"; -``` - -### `models.ProviderSortConfig` - -```typescript lines -const value: models.ProviderSortConfig = {}; -``` - -### `any` - -```typescript lines -const value: any = "price"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequesttoolfunction.mdx b/client-sdks/typescript/models/openresponsesrequesttoolfunction.mdx deleted file mode 100644 index 3f7d0e3a..00000000 --- a/client-sdks/typescript/models/openresponsesrequesttoolfunction.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: OpenResponsesRequestToolFunction - TypeScript SDK -description: OpenResponsesRequestToolFunction method reference -seoTitle: OpenResponsesRequestToolFunction | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequesttoolfunction -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestToolFunction | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestToolFunction method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestToolFunction%20-%20TypeScript%20SDK&description=OpenResponsesRequestToolFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Function tool definition - -## Example Usage - -```typescript expandable lines -import { OpenResponsesRequestToolFunction } from "@openrouter/sdk/models"; - -let value: OpenResponsesRequestToolFunction = { - type: "function", - name: "get_weather", - parameters: { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The city and state", - }, - "unit": { - "type": "string", - "enum": [ - "celsius", - "fahrenheit", - ], - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `type` | *"function"* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `parameters` | `Record` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesrequesttoolunion.mdx b/client-sdks/typescript/models/openresponsesrequesttoolunion.mdx deleted file mode 100644 index a1e5d704..00000000 --- a/client-sdks/typescript/models/openresponsesrequesttoolunion.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: OpenResponsesRequestToolUnion - TypeScript SDK -description: OpenResponsesRequestToolUnion method reference -seoTitle: OpenResponsesRequestToolUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesrequesttoolunion -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesRequestToolUnion | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesRequestToolUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesRequestToolUnion%20-%20TypeScript%20SDK&description=OpenResponsesRequestToolUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesRequestToolFunction` - -```typescript expandable lines -const value: models.OpenResponsesRequestToolFunction = { - type: "function", - name: "get_weather", - parameters: { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The city and state", - }, - "unit": { - "type": "string", - "enum": [ - "celsius", - "fahrenheit", - ], - "x-speakeasy-unknown-values": "allow", - }, - }, - "required": [ - "location", - ], - }, -}; -``` - -### `models.OpenResponsesWebSearchPreviewTool` - -```typescript lines -const value: models.OpenResponsesWebSearchPreviewTool = { - type: "web_search_preview", -}; -``` - -### `models.OpenResponsesWebSearchPreview20250311Tool` - -```typescript lines -const value: models.OpenResponsesWebSearchPreview20250311Tool = { - type: "web_search_preview_2025_03_11", -}; -``` - -### `models.OpenResponsesWebSearchTool` - -```typescript lines -const value: models.OpenResponsesWebSearchTool = { - type: "web_search", -}; -``` - -### `models.OpenResponsesWebSearch20250826Tool` - -```typescript lines -const value: models.OpenResponsesWebSearch20250826Tool = { - type: "web_search_2025_08_26", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesresponsetext.mdx b/client-sdks/typescript/models/openresponsesresponsetext.mdx deleted file mode 100644 index 2f85dba0..00000000 --- a/client-sdks/typescript/models/openresponsesresponsetext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesResponseText - TypeScript SDK -description: OpenResponsesResponseText method reference -seoTitle: OpenResponsesResponseText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesresponsetext' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResponseText | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResponseText method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResponseText%20-%20TypeScript%20SDK&description=OpenResponsesResponseText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Example Usage - -```typescript lines -import { OpenResponsesResponseText } from "@openrouter/sdk/models"; - -let value: OpenResponsesResponseText = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `format` | *models.ResponseFormatTextConfig* | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [models.OpenResponsesResponseTextVerbosity](/client-sdks/typescript/models/openresponsesresponsetextverbosity) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesresponsetextverbosity.mdx b/client-sdks/typescript/models/openresponsesresponsetextverbosity.mdx deleted file mode 100644 index 5ac1ceea..00000000 --- a/client-sdks/typescript/models/openresponsesresponsetextverbosity.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesResponseTextVerbosity - TypeScript SDK -description: OpenResponsesResponseTextVerbosity method reference -seoTitle: OpenResponsesResponseTextVerbosity | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesresponsetextverbosity -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesResponseTextVerbosity | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesResponseTextVerbosity method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesResponseTextVerbosity%20-%20TypeScript%20SDK&description=OpenResponsesResponseTextVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesResponseTextVerbosity } from "@openrouter/sdk/models"; - -let value: OpenResponsesResponseTextVerbosity = "low"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"high" | "low" | "medium" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreamevent.mdx b/client-sdks/typescript/models/openresponsesstreamevent.mdx deleted file mode 100644 index 0e3100ef..00000000 --- a/client-sdks/typescript/models/openresponsesstreamevent.mdx +++ /dev/null @@ -1,501 +0,0 @@ ---- -title: OpenResponsesStreamEvent - TypeScript SDK -description: OpenResponsesStreamEvent method reference -seoTitle: OpenResponsesStreamEvent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesstreamevent' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEvent | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEvent method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEvent%20-%20TypeScript%20SDK&description=OpenResponsesStreamEvent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Union of all possible event types emitted during response streaming - -## Supported Types - -### `models.OpenResponsesStreamEventResponseCreated` - -```typescript expandable lines -const value: models.OpenResponsesStreamEventResponseCreated = { - type: "response.created", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "in_progress", - completedAt: 7999.81, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 6463.74, - frequencyPenalty: null, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 0, -}; -``` - -### `models.OpenResponsesStreamEventResponseInProgress` - -```typescript expandable lines -const value: models.OpenResponsesStreamEventResponseInProgress = { - type: "response.in_progress", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "in_progress", - completedAt: 5374.05, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 6221.3, - frequencyPenalty: 1294.49, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 1, -}; -``` - -### `models.OpenResponsesStreamEventResponseCompleted` - -```typescript expandable lines -const value: models.OpenResponsesStreamEventResponseCompleted = { - type: "response.completed", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "completed", - completedAt: 3370.61, - output: [ - { - id: "item-1", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you?", - }, - ], - }, - ], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 9760.35, - frequencyPenalty: 8654.54, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 10, -}; -``` - -### `models.OpenResponsesStreamEventResponseIncomplete` - -```typescript expandable lines -const value: models.OpenResponsesStreamEventResponseIncomplete = { - type: "response.incomplete", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "incomplete", - completedAt: 1221.53, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 7501.6, - frequencyPenalty: 258.79, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 5, -}; -``` - -### `models.OpenResponsesStreamEventResponseFailed` - -```typescript expandable lines -const value: models.OpenResponsesStreamEventResponseFailed = { - type: "response.failed", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "failed", - completedAt: 257.96, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 1169.05, - frequencyPenalty: 2180.11, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 3, -}; -``` - -### `models.OpenResponsesErrorEvent` - -```typescript lines -const value: models.OpenResponsesErrorEvent = { - type: "error", - code: "rate_limit_exceeded", - message: "Rate limit exceeded. Please try again later.", - param: null, - sequenceNumber: 2, -}; -``` - -### `models.OpenResponsesStreamEventResponseOutputItemAdded` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseOutputItemAdded = { - type: "response.output_item.added", - outputIndex: 0, - item: { - id: "item-1", - role: "assistant", - type: "message", - content: [], - }, - sequenceNumber: 2, -}; -``` - -### `models.OpenResponsesStreamEventResponseOutputItemDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseOutputItemDone = { - type: "response.output_item.done", - outputIndex: 0, - item: { - id: "item-1", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you?", - }, - ], - }, - sequenceNumber: 8, -}; -``` - -### `models.OpenResponsesStreamEventResponseContentPartAdded` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseContentPartAdded = { - type: "response.content_part.added", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - part: { - type: "output_text", - text: "", - }, - sequenceNumber: 3, -}; -``` - -### `models.OpenResponsesStreamEventResponseContentPartDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseContentPartDone = { - type: "response.content_part.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - part: { - type: "output_text", - text: "Hello! How can I help you?", - }, - sequenceNumber: 7, -}; -``` - -### `models.OpenResponsesStreamEventResponseOutputTextDelta` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseOutputTextDelta = { - type: "response.output_text.delta", - logprobs: [], - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "Hello", - sequenceNumber: 4, -}; -``` - -### `models.OpenResponsesStreamEventResponseOutputTextDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseOutputTextDone = { - type: "response.output_text.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - text: "Hello! How can I help you?", - sequenceNumber: 6, - logprobs: [], -}; -``` - -### `models.OpenResponsesStreamEventResponseRefusalDelta` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseRefusalDelta = { - type: "response.refusal.delta", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "I'm sorry", - sequenceNumber: 4, -}; -``` - -### `models.OpenResponsesStreamEventResponseRefusalDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseRefusalDone = { - type: "response.refusal.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - refusal: "I'm sorry, but I can't assist with that request.", - sequenceNumber: 6, -}; -``` - -### `models.OpenResponsesStreamEventResponseOutputTextAnnotationAdded` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseOutputTextAnnotationAdded = - { - type: "response.output_text.annotation.added", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - sequenceNumber: 5, - annotationIndex: 0, - annotation: { - type: "url_citation", - url: "https://example.com", - title: "Example", - startIndex: 0, - endIndex: 7, - }, - }; -``` - -### `models.OpenResponsesStreamEventResponseFunctionCallArgumentsDelta` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseFunctionCallArgumentsDelta = - { - type: "response.function_call_arguments.delta", - itemId: "item-1", - outputIndex: 0, - delta: "{\"city\": \"San", - sequenceNumber: 4, - }; -``` - -### `models.OpenResponsesStreamEventResponseFunctionCallArgumentsDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseFunctionCallArgumentsDone = - { - type: "response.function_call_arguments.done", - itemId: "item-1", - outputIndex: 0, - name: "get_weather", - arguments: "{\"city\": \"San Francisco\", \"units\": \"celsius\"}", - sequenceNumber: 6, - }; -``` - -### `models.OpenResponsesReasoningDeltaEvent` - -```typescript lines -const value: models.OpenResponsesReasoningDeltaEvent = { - type: "response.reasoning_text.delta", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "First, we need", - sequenceNumber: 4, -}; -``` - -### `models.OpenResponsesReasoningDoneEvent` - -```typescript lines -const value: models.OpenResponsesReasoningDoneEvent = { - type: "response.reasoning_text.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - text: - "First, we need to identify the key components and then combine them logically.", - sequenceNumber: 6, -}; -``` - -### `models.OpenResponsesReasoningSummaryPartAddedEvent` - -```typescript lines -const value: models.OpenResponsesReasoningSummaryPartAddedEvent = { - type: "response.reasoning_summary_part.added", - outputIndex: 0, - itemId: "item-1", - summaryIndex: 0, - part: { - type: "summary_text", - text: "", - }, - sequenceNumber: 3, -}; -``` - -### `models.OpenResponsesStreamEventResponseReasoningSummaryPartDone` - -```typescript lines -const value: models.OpenResponsesStreamEventResponseReasoningSummaryPartDone = { - type: "response.reasoning_summary_part.done", - outputIndex: 0, - itemId: "item-1", - summaryIndex: 0, - part: { - type: "summary_text", - text: "Analyzing the problem step by step to find the optimal solution.", - }, - sequenceNumber: 7, -}; -``` - -### `models.OpenResponsesReasoningSummaryTextDeltaEvent` - -```typescript lines -const value: models.OpenResponsesReasoningSummaryTextDeltaEvent = { - type: "response.reasoning_summary_text.delta", - itemId: "item-1", - outputIndex: 0, - summaryIndex: 0, - delta: "Analyzing", - sequenceNumber: 4, -}; -``` - -### `models.OpenResponsesReasoningSummaryTextDoneEvent` - -```typescript lines -const value: models.OpenResponsesReasoningSummaryTextDoneEvent = { - type: "response.reasoning_summary_text.done", - itemId: "item-1", - outputIndex: 0, - summaryIndex: 0, - text: "Analyzing the problem step by step to find the optimal solution.", - sequenceNumber: 6, -}; -``` - -### `models.OpenResponsesImageGenCallInProgress` - -```typescript lines -const value: models.OpenResponsesImageGenCallInProgress = { - type: "response.image_generation_call.in_progress", - itemId: "", - outputIndex: 8869.44, - sequenceNumber: 0, -}; -``` - -### `models.OpenResponsesImageGenCallGenerating` - -```typescript lines -const value: models.OpenResponsesImageGenCallGenerating = { - type: "response.image_generation_call.generating", - itemId: "", - outputIndex: 1669.75, - sequenceNumber: 0, -}; -``` - -### `models.OpenResponsesImageGenCallPartialImage` - -```typescript lines -const value: models.OpenResponsesImageGenCallPartialImage = { - type: "response.image_generation_call.partial_image", - itemId: "", - outputIndex: 4078.33, - sequenceNumber: 0, - partialImageB64: "", - partialImageIndex: 6154.36, -}; -``` - -### `models.OpenResponsesImageGenCallCompleted` - -```typescript lines -const value: models.OpenResponsesImageGenCallCompleted = { - type: "response.image_generation_call.completed", - itemId: "", - outputIndex: 776.49, - sequenceNumber: 0, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsecompleted.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsecompleted.mdx deleted file mode 100644 index 4c9c0702..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsecompleted.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseCompleted - TypeScript SDK -description: OpenResponsesStreamEventResponseCompleted method reference -seoTitle: OpenResponsesStreamEventResponseCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsecompleted -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseCompleted | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseCompleted method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseCompleted%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has completed successfully - -## Example Usage - -```typescript expandable lines -import { OpenResponsesStreamEventResponseCompleted } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseCompleted = { - type: "response.completed", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "completed", - completedAt: 6756.82, - output: [ - { - id: "item-1", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you?", - }, - ], - }, - ], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 5218.67, - frequencyPenalty: 9449.97, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 10, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.completed"* | :heavy_check_mark: | N/A | | -| `response` | [models.OpenResponsesNonStreamingResponse](/client-sdks/typescript/models/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartadded.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartadded.mdx deleted file mode 100644 index 4c1a84bc..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartadded.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseContentPartAdded - TypeScript SDK -description: OpenResponsesStreamEventResponseContentPartAdded method reference -seoTitle: OpenResponsesStreamEventResponseContentPartAdded | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsecontentpartadded -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseContentPartAdded | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseContentPartAdded method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseContentPartAdded%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseContentPartAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a new content part is added to an output item - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseContentPartAdded } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseContentPartAdded = { - type: "response.content_part.added", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - part: { - type: "output_text", - text: "", - }, - sequenceNumber: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `type` | *"response.content_part.added"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.Part1* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartdone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartdone.mdx deleted file mode 100644 index 49ad3fe9..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsecontentpartdone.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseContentPartDone - TypeScript SDK -description: OpenResponsesStreamEventResponseContentPartDone method reference -seoTitle: OpenResponsesStreamEventResponseContentPartDone | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsecontentpartdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseContentPartDone | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseContentPartDone method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseContentPartDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseContentPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a content part is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseContentPartDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseContentPartDone = { - type: "response.content_part.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - part: { - type: "output_text", - text: "Hello! How can I help you?", - }, - sequenceNumber: 7, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `type` | *"response.content_part.done"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.Part2* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsecreated.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsecreated.mdx deleted file mode 100644 index 4061a04a..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsecreated.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseCreated - TypeScript SDK -description: OpenResponsesStreamEventResponseCreated method reference -seoTitle: OpenResponsesStreamEventResponseCreated | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsecreated -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseCreated | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseCreated method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseCreated%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseCreated%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is created - -## Example Usage - -```typescript expandable lines -import { OpenResponsesStreamEventResponseCreated } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseCreated = { - type: "response.created", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "in_progress", - completedAt: 1983.13, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: null, - frequencyPenalty: 3092.81, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 0, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.created"* | :heavy_check_mark: | N/A | | -| `response` | [models.OpenResponsesNonStreamingResponse](/client-sdks/typescript/models/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsefailed.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsefailed.mdx deleted file mode 100644 index 4c06406f..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsefailed.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFailed - TypeScript SDK -description: OpenResponsesStreamEventResponseFailed method reference -seoTitle: OpenResponsesStreamEventResponseFailed | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsefailed -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseFailed | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseFailed method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFailed%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseFailed%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response has failed - -## Example Usage - -```typescript expandable lines -import { OpenResponsesStreamEventResponseFailed } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseFailed = { - type: "response.failed", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "failed", - completedAt: 934.62, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 5672.21, - frequencyPenalty: null, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.failed"* | :heavy_check_mark: | N/A | | -| `response` | [models.OpenResponsesNonStreamingResponse](/client-sdks/typescript/models/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx deleted file mode 100644 index ff5e046e..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdelta.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFunctionCallArgumentsDelta - TypeScript SDK -description: OpenResponsesStreamEventResponseFunctionCallArgumentsDelta method reference -seoTitle: >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdelta -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta | OpenRouter - TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDelta method - documentation for the OpenRouter TypeScript SDK. Learn how to use this API - endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFunctionCallArgumentsDelta%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseFunctionCallArgumentsDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments are being streamed - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseFunctionCallArgumentsDelta } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseFunctionCallArgumentsDelta = { - type: "response.function_call_arguments.delta", - itemId: "item-1", - outputIndex: 0, - delta: "{\"city\": \"San", - sequenceNumber: 4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `type` | *"response.function_call_arguments.delta"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdone.mdx deleted file mode 100644 index 12a38041..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdone.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseFunctionCallArgumentsDone - TypeScript SDK -description: OpenResponsesStreamEventResponseFunctionCallArgumentsDone method reference -seoTitle: >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsefunctioncallargumentsdone -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone | OpenRouter - TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseFunctionCallArgumentsDone method documentation - for the OpenRouter TypeScript SDK. Learn how to use this API endpoint with - code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseFunctionCallArgumentsDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseFunctionCallArgumentsDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when function call arguments streaming is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseFunctionCallArgumentsDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseFunctionCallArgumentsDone = { - type: "response.function_call_arguments.done", - itemId: "item-1", - outputIndex: 0, - name: "get_weather", - arguments: "{\"city\": \"San Francisco\", \"units\": \"celsius\"}", - sequenceNumber: 6, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `type` | *"response.function_call_arguments.done"* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseincomplete.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseincomplete.mdx deleted file mode 100644 index 512d5d98..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseincomplete.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseIncomplete - TypeScript SDK -description: OpenResponsesStreamEventResponseIncomplete method reference -seoTitle: OpenResponsesStreamEventResponseIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseincomplete -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseIncomplete | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseIncomplete method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseIncomplete%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is incomplete - -## Example Usage - -```typescript expandable lines -import { OpenResponsesStreamEventResponseIncomplete } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseIncomplete = { - type: "response.incomplete", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "incomplete", - completedAt: 2472.5, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 4625.79, - frequencyPenalty: 2007.6, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 5, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.incomplete"* | :heavy_check_mark: | N/A | | -| `response` | [models.OpenResponsesNonStreamingResponse](/client-sdks/typescript/models/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseinprogress.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseinprogress.mdx deleted file mode 100644 index 320717dc..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseinprogress.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseInProgress - TypeScript SDK -description: OpenResponsesStreamEventResponseInProgress method reference -seoTitle: OpenResponsesStreamEventResponseInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseinprogress -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseInProgress | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseInProgress method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseInProgress%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a response is in progress - -## Example Usage - -```typescript expandable lines -import { OpenResponsesStreamEventResponseInProgress } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseInProgress = { - type: "response.in_progress", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "in_progress", - completedAt: 1373.8, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: null, - frequencyPenalty: 5865.18, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.in_progress"* | :heavy_check_mark: | N/A | | -| `response` | [models.OpenResponsesNonStreamingResponse](/client-sdks/typescript/models/openresponsesnonstreamingresponse) | :heavy_check_mark: | Complete non-streaming response from the Responses API | `{"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "completed","output": [{"type": "message","id": "msg-abc123","status": "completed","role": "assistant","content": [{"type": "output_text","text": "Hello! How can I help you today?","annotations": []}`
]
}
],
"usage": `{"input_tokens": 10,"output_tokens": 25,"total_tokens": 35,"input_tokens_details": {"cached_tokens": 0}`,
"output_tokens_details": `{"reasoning_tokens": 0}`
},
"tools": [],
"tool_choice": "auto",
"parallel_tool_calls": true,
"error": null,
"incomplete_details": null,
"temperature": null,
"top_p": null,
"max_output_tokens": null,
"metadata": null,
"instructions": `null
`} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemadded.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemadded.mdx deleted file mode 100644 index 9488e406..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemadded.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputItemAdded - TypeScript SDK -description: OpenResponsesStreamEventResponseOutputItemAdded method reference -seoTitle: OpenResponsesStreamEventResponseOutputItemAdded | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseoutputitemadded -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputItemAdded | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputItemAdded method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputItemAdded%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseOutputItemAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a new output item is added to the response - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseOutputItemAdded } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseOutputItemAdded = { - type: "response.output_item.added", - outputIndex: 0, - item: { - id: "item-1", - role: "assistant", - type: "message", - content: [], - }, - sequenceNumber: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.output_item.added"* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `item` | *models.ResponsesOutputItem* | :heavy_check_mark: | An output item from the response | `{"id": "msg-abc123","role": "assistant","type": "message","status": "completed","content": [{"type": "output_text","text": "Hello! How can I help you today?"}`
]
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemdone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemdone.mdx deleted file mode 100644 index 0516f7cd..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseoutputitemdone.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputItemDone - TypeScript SDK -description: OpenResponsesStreamEventResponseOutputItemDone method reference -seoTitle: OpenResponsesStreamEventResponseOutputItemDone | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseoutputitemdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputItemDone | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputItemDone method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputItemDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseOutputItemDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when an output item is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseOutputItemDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseOutputItemDone = { - type: "response.output_item.done", - outputIndex: 0, - item: { - id: "item-1", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you?", - }, - ], - }, - sequenceNumber: 8, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"response.output_item.done"* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `item` | *models.ResponsesOutputItem* | :heavy_check_mark: | An output item from the response | `{"id": "msg-abc123","role": "assistant","type": "message","status": "completed","content": [{"type": "output_text","text": "Hello! How can I help you today?"}`
]
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextannotationadded.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextannotationadded.mdx deleted file mode 100644 index ad1f461f..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextannotationadded.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextAnnotationAdded - TypeScript SDK -description: OpenResponsesStreamEventResponseOutputTextAnnotationAdded method reference -seoTitle: >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseoutputtextannotationadded -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded | OpenRouter - TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextAnnotationAdded method documentation - for the OpenRouter TypeScript SDK. Learn how to use this API endpoint with - code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextAnnotationAdded%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseOutputTextAnnotationAdded%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a text annotation is added to output - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseOutputTextAnnotationAdded } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseOutputTextAnnotationAdded = { - type: "response.output_text.annotation.added", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - sequenceNumber: 5, - annotationIndex: 0, - annotation: { - type: "url_citation", - url: "https://example.com", - title: "Example", - startIndex: 0, - endIndex: 7, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `type` | *"response.output_text.annotation.added"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `annotationIndex` | *number* | :heavy_check_mark: | N/A | -| `annotation` | *models.OpenAIResponsesAnnotation* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdelta.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdelta.mdx deleted file mode 100644 index 82a334eb..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdelta.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextDelta - TypeScript SDK -description: OpenResponsesStreamEventResponseOutputTextDelta method reference -seoTitle: OpenResponsesStreamEventResponseOutputTextDelta | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseoutputtextdelta -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputTextDelta | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextDelta method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextDelta%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseOutputTextDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a text delta is streamed - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseOutputTextDelta } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseOutputTextDelta = { - type: "response.output_text.delta", - logprobs: [], - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "Hello", - sequenceNumber: 4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `type` | *"response.output_text.delta"* | :heavy_check_mark: | N/A | -| `logprobs` | [models.OpenResponsesLogProbs](/client-sdks/typescript/models/openresponseslogprobs)[] | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdone.mdx deleted file mode 100644 index bb904896..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponseoutputtextdone.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseOutputTextDone - TypeScript SDK -description: OpenResponsesStreamEventResponseOutputTextDone method reference -seoTitle: OpenResponsesStreamEventResponseOutputTextDone | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponseoutputtextdone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseOutputTextDone | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseOutputTextDone method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseOutputTextDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseOutputTextDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when text streaming is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseOutputTextDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseOutputTextDone = { - type: "response.output_text.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - text: "Hello! How can I help you?", - sequenceNumber: 6, - logprobs: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `type` | *"response.output_text.done"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `logprobs` | [models.OpenResponsesLogProbs](/client-sdks/typescript/models/openresponseslogprobs)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponsereasoningsummarypartdone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponsereasoningsummarypartdone.mdx deleted file mode 100644 index 6f956b5d..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponsereasoningsummarypartdone.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseReasoningSummaryPartDone - TypeScript SDK -description: OpenResponsesStreamEventResponseReasoningSummaryPartDone method reference -seoTitle: >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone | OpenRouter - TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponsereasoningsummarypartdone -'og:site_name': OpenRouter Documentation -'og:title': >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone | OpenRouter - TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseReasoningSummaryPartDone method documentation - for the OpenRouter TypeScript SDK. Learn how to use this API endpoint with - code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseReasoningSummaryPartDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseReasoningSummaryPartDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a reasoning summary part is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseReasoningSummaryPartDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseReasoningSummaryPartDone = { - type: "response.reasoning_summary_part.done", - outputIndex: 0, - itemId: "item-1", - summaryIndex: 0, - part: { - type: "summary_text", - text: "Analyzing the problem step by step to find the optimal solution.", - }, - sequenceNumber: 7, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `type` | *"response.reasoning_summary_part.done"* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](/client-sdks/typescript/models/reasoningsummarytext) | :heavy_check_mark: | N/A | `{"type": "summary_text","text": "Analyzed the problem using first principles"}` | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponserefusaldelta.mdx b/client-sdks/typescript/models/openresponsesstreameventresponserefusaldelta.mdx deleted file mode 100644 index 64370ca4..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponserefusaldelta.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseRefusalDelta - TypeScript SDK -description: OpenResponsesStreamEventResponseRefusalDelta method reference -seoTitle: OpenResponsesStreamEventResponseRefusalDelta | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponserefusaldelta -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseRefusalDelta | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseRefusalDelta method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseRefusalDelta%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseRefusalDelta%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when a refusal delta is streamed - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseRefusalDelta } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseRefusalDelta = { - type: "response.refusal.delta", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - delta: "I'm sorry", - sequenceNumber: 4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `type` | *"response.refusal.delta"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesstreameventresponserefusaldone.mdx b/client-sdks/typescript/models/openresponsesstreameventresponserefusaldone.mdx deleted file mode 100644 index 58e2a4be..00000000 --- a/client-sdks/typescript/models/openresponsesstreameventresponserefusaldone.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: OpenResponsesStreamEventResponseRefusalDone - TypeScript SDK -description: OpenResponsesStreamEventResponseRefusalDone method reference -seoTitle: OpenResponsesStreamEventResponseRefusalDone | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponsesstreameventresponserefusaldone -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesStreamEventResponseRefusalDone | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesStreamEventResponseRefusalDone method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesStreamEventResponseRefusalDone%20-%20TypeScript%20SDK&description=OpenResponsesStreamEventResponseRefusalDone%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Event emitted when refusal streaming is complete - -## Example Usage - -```typescript lines -import { OpenResponsesStreamEventResponseRefusalDone } from "@openrouter/sdk/models"; - -let value: OpenResponsesStreamEventResponseRefusalDone = { - type: "response.refusal.done", - outputIndex: 0, - itemId: "item-1", - contentIndex: 0, - refusal: "I'm sorry, but I can't assist with that request.", - sequenceNumber: 6, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `type` | *"response.refusal.done"* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsestoplogprobs.mdx b/client-sdks/typescript/models/openresponsestoplogprobs.mdx deleted file mode 100644 index da13d6ab..00000000 --- a/client-sdks/typescript/models/openresponsestoplogprobs.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: OpenResponsesTopLogprobs - TypeScript SDK -description: OpenResponsesTopLogprobs method reference -seoTitle: OpenResponsesTopLogprobs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsestoplogprobs' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesTopLogprobs | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesTopLogprobs method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesTopLogprobs%20-%20TypeScript%20SDK&description=OpenResponsesTopLogprobs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Alternative token with its log probability - -## Example Usage - -```typescript lines -import { OpenResponsesTopLogprobs } from "@openrouter/sdk/models"; - -let value: OpenResponsesTopLogprobs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *string* | :heavy_minus_sign: | N/A | -| `logprob` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponsesusage.mdx b/client-sdks/typescript/models/openresponsesusage.mdx deleted file mode 100644 index b85cfb4c..00000000 --- a/client-sdks/typescript/models/openresponsesusage.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: OpenResponsesUsage - TypeScript SDK -description: OpenResponsesUsage method reference -seoTitle: OpenResponsesUsage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponsesusage' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesUsage | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesUsage method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesUsage%20-%20TypeScript%20SDK&description=OpenResponsesUsage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Token usage information for the response - -## Example Usage - -```typescript lines -import { OpenResponsesUsage } from "@openrouter/sdk/models"; - -let value: OpenResponsesUsage = { - inputTokens: 10, - inputTokensDetails: { - cachedTokens: 0, - }, - outputTokens: 25, - outputTokensDetails: { - reasoningTokens: 0, - }, - totalTokens: 35, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `inputTokens` | *number* | :heavy_check_mark: | N/A | -| `inputTokensDetails` | [models.InputTokensDetails](/client-sdks/typescript/models/inputtokensdetails) | :heavy_check_mark: | N/A | -| `outputTokens` | *number* | :heavy_check_mark: | N/A | -| `outputTokensDetails` | [models.OutputTokensDetails](/client-sdks/typescript/models/outputtokensdetails) | :heavy_check_mark: | N/A | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | -| `costDetails` | [models.CostDetails](/client-sdks/typescript/models/costdetails) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearch20250826tool.mdx b/client-sdks/typescript/models/openresponseswebsearch20250826tool.mdx deleted file mode 100644 index 581a67de..00000000 --- a/client-sdks/typescript/models/openresponseswebsearch20250826tool.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenResponsesWebSearch20250826Tool - TypeScript SDK -description: OpenResponsesWebSearch20250826Tool method reference -seoTitle: OpenResponsesWebSearch20250826Tool | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseswebsearch20250826tool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearch20250826Tool | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearch20250826Tool method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearch20250826Tool%20-%20TypeScript%20SDK&description=OpenResponsesWebSearch20250826Tool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search tool configuration (2025-08-26 version) - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearch20250826Tool } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearch20250826Tool = { - type: "web_search_2025_08_26", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"web_search_2025_08_26"* | :heavy_check_mark: | N/A | | -| `filters` | [models.OpenResponsesWebSearch20250826ToolFilters](/client-sdks/typescript/models/openresponseswebsearch20250826toolfilters) | :heavy_minus_sign: | N/A | | -| `searchContextSize` | [models.ResponsesSearchContextSize](/client-sdks/typescript/models/responsessearchcontextsize) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `userLocation` | [models.ResponsesWebSearchUserLocation](/client-sdks/typescript/models/responseswebsearchuserlocation) | :heavy_minus_sign: | User location information for web search | `{"type": "approximate","city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles"}` | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearch20250826toolfilters.mdx b/client-sdks/typescript/models/openresponseswebsearch20250826toolfilters.mdx deleted file mode 100644 index 466e4a3c..00000000 --- a/client-sdks/typescript/models/openresponseswebsearch20250826toolfilters.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OpenResponsesWebSearch20250826ToolFilters - TypeScript SDK -description: OpenResponsesWebSearch20250826ToolFilters method reference -seoTitle: OpenResponsesWebSearch20250826ToolFilters | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseswebsearch20250826toolfilters -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearch20250826ToolFilters | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearch20250826ToolFilters method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearch20250826ToolFilters%20-%20TypeScript%20SDK&description=OpenResponsesWebSearch20250826ToolFilters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearch20250826ToolFilters } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearch20250826ToolFilters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearchpreview20250311tool.mdx b/client-sdks/typescript/models/openresponseswebsearchpreview20250311tool.mdx deleted file mode 100644 index 47945af9..00000000 --- a/client-sdks/typescript/models/openresponseswebsearchpreview20250311tool.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: OpenResponsesWebSearchPreview20250311Tool - TypeScript SDK -description: OpenResponsesWebSearchPreview20250311Tool method reference -seoTitle: OpenResponsesWebSearchPreview20250311Tool | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseswebsearchpreview20250311tool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreview20250311Tool | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearchPreview20250311Tool method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreview20250311Tool%20-%20TypeScript%20SDK&description=OpenResponsesWebSearchPreview20250311Tool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration (2025-03-11 version) - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearchPreview20250311Tool } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearchPreview20250311Tool = { - type: "web_search_preview_2025_03_11", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | *"web_search_preview_2025_03_11"* | :heavy_check_mark: | N/A | | -| `searchContextSize` | [models.ResponsesSearchContextSize](/client-sdks/typescript/models/responsessearchcontextsize) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `userLocation` | [models.WebSearchPreviewToolUserLocation](/client-sdks/typescript/models/websearchpreviewtooluserlocation) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearchpreviewtool.mdx b/client-sdks/typescript/models/openresponseswebsearchpreviewtool.mdx deleted file mode 100644 index ad33df69..00000000 --- a/client-sdks/typescript/models/openresponseswebsearchpreviewtool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesWebSearchPreviewTool - TypeScript SDK -description: OpenResponsesWebSearchPreviewTool method reference -seoTitle: OpenResponsesWebSearchPreviewTool | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseswebsearchpreviewtool -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchPreviewTool | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearchPreviewTool method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchPreviewTool%20-%20TypeScript%20SDK&description=OpenResponsesWebSearchPreviewTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search preview tool configuration - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearchPreviewTool } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearchPreviewTool = { - type: "web_search_preview", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | *"web_search_preview"* | :heavy_check_mark: | N/A | | -| `searchContextSize` | [models.ResponsesSearchContextSize](/client-sdks/typescript/models/responsessearchcontextsize) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `userLocation` | [models.WebSearchPreviewToolUserLocation](/client-sdks/typescript/models/websearchpreviewtooluserlocation) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearchtool.mdx b/client-sdks/typescript/models/openresponseswebsearchtool.mdx deleted file mode 100644 index 542fec10..00000000 --- a/client-sdks/typescript/models/openresponseswebsearchtool.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: OpenResponsesWebSearchTool - TypeScript SDK -description: OpenResponsesWebSearchTool method reference -seoTitle: OpenResponsesWebSearchTool | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/openresponseswebsearchtool' -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchTool | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearchTool method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchTool%20-%20TypeScript%20SDK&description=OpenResponsesWebSearchTool%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Web search tool configuration - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearchTool } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearchTool = { - type: "web_search", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *"web_search"* | :heavy_check_mark: | N/A | | -| `filters` | [models.OpenResponsesWebSearchToolFilters](/client-sdks/typescript/models/openresponseswebsearchtoolfilters) | :heavy_minus_sign: | N/A | | -| `searchContextSize` | [models.ResponsesSearchContextSize](/client-sdks/typescript/models/responsessearchcontextsize) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `userLocation` | [models.ResponsesWebSearchUserLocation](/client-sdks/typescript/models/responseswebsearchuserlocation) | :heavy_minus_sign: | User location information for web search | `{"type": "approximate","city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles"}` | \ No newline at end of file diff --git a/client-sdks/typescript/models/openresponseswebsearchtoolfilters.mdx b/client-sdks/typescript/models/openresponseswebsearchtoolfilters.mdx deleted file mode 100644 index fd102c09..00000000 --- a/client-sdks/typescript/models/openresponseswebsearchtoolfilters.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OpenResponsesWebSearchToolFilters - TypeScript SDK -description: OpenResponsesWebSearchToolFilters method reference -seoTitle: OpenResponsesWebSearchToolFilters | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/openresponseswebsearchtoolfilters -'og:site_name': OpenRouter Documentation -'og:title': OpenResponsesWebSearchToolFilters | OpenRouter TypeScript SDK -'og:description': >- - OpenResponsesWebSearchToolFilters method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OpenResponsesWebSearchToolFilters%20-%20TypeScript%20SDK&description=OpenResponsesWebSearchToolFilters%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OpenResponsesWebSearchToolFilters } from "@openrouter/sdk/models"; - -let value: OpenResponsesWebSearchToolFilters = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/outputitemimagegenerationcall.mdx b/client-sdks/typescript/models/outputitemimagegenerationcall.mdx deleted file mode 100644 index 58ff02d2..00000000 --- a/client-sdks/typescript/models/outputitemimagegenerationcall.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OutputItemImageGenerationCall - TypeScript SDK -description: OutputItemImageGenerationCall method reference -seoTitle: OutputItemImageGenerationCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/outputitemimagegenerationcall -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCall | OpenRouter TypeScript SDK -'og:description': >- - OutputItemImageGenerationCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCall%20-%20TypeScript%20SDK&description=OutputItemImageGenerationCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputItemImageGenerationCall } from "@openrouter/sdk/models"; - -let value: OutputItemImageGenerationCall = { - type: "image_generation_call", - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `type` | [models.OutputItemImageGenerationCallType](/client-sdks/typescript/models/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](/client-sdks/typescript/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/outputitemimagegenerationcalltype.mdx b/client-sdks/typescript/models/outputitemimagegenerationcalltype.mdx deleted file mode 100644 index ff2d3488..00000000 --- a/client-sdks/typescript/models/outputitemimagegenerationcalltype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputItemImageGenerationCallType - TypeScript SDK -description: OutputItemImageGenerationCallType method reference -seoTitle: OutputItemImageGenerationCallType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/outputitemimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': OutputItemImageGenerationCallType | OpenRouter TypeScript SDK -'og:description': >- - OutputItemImageGenerationCallType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputItemImageGenerationCallType%20-%20TypeScript%20SDK&description=OutputItemImageGenerationCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputItemImageGenerationCallType } from "@openrouter/sdk/models"; - -let value: OutputItemImageGenerationCallType = "image_generation_call"; -``` - -## Values - -```typescript lines -"image_generation_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessage.mdx b/client-sdks/typescript/models/outputmessage.mdx deleted file mode 100644 index 0241805f..00000000 --- a/client-sdks/typescript/models/outputmessage.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: OutputMessage - TypeScript SDK -description: OutputMessage method reference -seoTitle: OutputMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessage' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessage | OpenRouter TypeScript SDK -'og:description': >- - OutputMessage method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessage%20-%20TypeScript%20SDK&description=OutputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessage } from "@openrouter/sdk/models"; - -let value: OutputMessage = { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `role` | [models.OutputMessageRole](/client-sdks/typescript/models/outputmessagerole) | :heavy_check_mark: | N/A | -| `type` | [models.OutputMessageType](/client-sdks/typescript/models/outputmessagetype) | :heavy_check_mark: | N/A | -| `status` | *models.OutputMessageStatusUnion* | :heavy_minus_sign: | N/A | -| `content` | *models.OutputMessageContent*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagecontent.mdx b/client-sdks/typescript/models/outputmessagecontent.mdx deleted file mode 100644 index 4ee871ae..00000000 --- a/client-sdks/typescript/models/outputmessagecontent.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OutputMessageContent - TypeScript SDK -description: OutputMessageContent method reference -seoTitle: OutputMessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageContent | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageContent method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageContent%20-%20TypeScript%20SDK&description=OutputMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - type: "output_text", - text: "The capital of France is Paris.", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - type: "refusal", - refusal: "I'm sorry, I cannot assist with that request", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagerole.mdx b/client-sdks/typescript/models/outputmessagerole.mdx deleted file mode 100644 index 9cfe7065..00000000 --- a/client-sdks/typescript/models/outputmessagerole.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMessageRole - TypeScript SDK -description: OutputMessageRole method reference -seoTitle: OutputMessageRole | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageRole | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageRole method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageRole%20-%20TypeScript%20SDK&description=OutputMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageRole } from "@openrouter/sdk/models"; - -let value: OutputMessageRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagestatuscompleted.mdx b/client-sdks/typescript/models/outputmessagestatuscompleted.mdx deleted file mode 100644 index 8a1105cd..00000000 --- a/client-sdks/typescript/models/outputmessagestatuscompleted.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMessageStatusCompleted - TypeScript SDK -description: OutputMessageStatusCompleted method reference -seoTitle: OutputMessageStatusCompleted | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessagestatuscompleted' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusCompleted | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusCompleted method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusCompleted%20-%20TypeScript%20SDK&description=OutputMessageStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusCompleted } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagestatusincomplete.mdx b/client-sdks/typescript/models/outputmessagestatusincomplete.mdx deleted file mode 100644 index 6d2dfef5..00000000 --- a/client-sdks/typescript/models/outputmessagestatusincomplete.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputMessageStatusIncomplete - TypeScript SDK -description: OutputMessageStatusIncomplete method reference -seoTitle: OutputMessageStatusIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/outputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusIncomplete | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusIncomplete method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusIncomplete%20-%20TypeScript%20SDK&description=OutputMessageStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusIncomplete } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagestatusinprogress.mdx b/client-sdks/typescript/models/outputmessagestatusinprogress.mdx deleted file mode 100644 index 4dbd0a81..00000000 --- a/client-sdks/typescript/models/outputmessagestatusinprogress.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: OutputMessageStatusInProgress - TypeScript SDK -description: OutputMessageStatusInProgress method reference -seoTitle: OutputMessageStatusInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/outputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusInProgress | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusInProgress method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusInProgress%20-%20TypeScript%20SDK&description=OutputMessageStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageStatusInProgress } from "@openrouter/sdk/models"; - -let value: OutputMessageStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagestatusunion.mdx b/client-sdks/typescript/models/outputmessagestatusunion.mdx deleted file mode 100644 index a6bd5411..00000000 --- a/client-sdks/typescript/models/outputmessagestatusunion.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: OutputMessageStatusUnion - TypeScript SDK -description: OutputMessageStatusUnion method reference -seoTitle: OutputMessageStatusUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessagestatusunion' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageStatusUnion | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageStatusUnion method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageStatusUnion%20-%20TypeScript%20SDK&description=OutputMessageStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OutputMessageStatusCompleted` - -```typescript lines -const value: models.OutputMessageStatusCompleted = "completed"; -``` - -### `models.OutputMessageStatusIncomplete` - -```typescript lines -const value: models.OutputMessageStatusIncomplete = "incomplete"; -``` - -### `models.OutputMessageStatusInProgress` - -```typescript lines -const value: models.OutputMessageStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmessagetype.mdx b/client-sdks/typescript/models/outputmessagetype.mdx deleted file mode 100644 index a0c75ec9..00000000 --- a/client-sdks/typescript/models/outputmessagetype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: OutputMessageType - TypeScript SDK -description: OutputMessageType method reference -seoTitle: OutputMessageType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmessagetype' -'og:site_name': OpenRouter Documentation -'og:title': OutputMessageType | OpenRouter TypeScript SDK -'og:description': >- - OutputMessageType method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputMessageType%20-%20TypeScript%20SDK&description=OutputMessageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputMessageType } from "@openrouter/sdk/models"; - -let value: OutputMessageType = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputmodality.mdx b/client-sdks/typescript/models/outputmodality.mdx deleted file mode 100644 index e989c25f..00000000 --- a/client-sdks/typescript/models/outputmodality.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputModality - TypeScript SDK -description: OutputModality method reference -seoTitle: OutputModality | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputmodality' -'og:site_name': OpenRouter Documentation -'og:title': OutputModality | OpenRouter TypeScript SDK -'og:description': >- - OutputModality method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputModality%20-%20TypeScript%20SDK&description=OutputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputModality } from "@openrouter/sdk/models"; - -let value: OutputModality = "text"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"text" | "image" | "embeddings" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/outputtokensdetails.mdx b/client-sdks/typescript/models/outputtokensdetails.mdx deleted file mode 100644 index 59a93a12..00000000 --- a/client-sdks/typescript/models/outputtokensdetails.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: OutputTokensDetails - TypeScript SDK -description: OutputTokensDetails method reference -seoTitle: OutputTokensDetails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/outputtokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': OutputTokensDetails | OpenRouter TypeScript SDK -'og:description': >- - OutputTokensDetails method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=OutputTokensDetails%20-%20TypeScript%20SDK&description=OutputTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { OutputTokensDetails } from "@openrouter/sdk/models"; - -let value: OutputTokensDetails = { - reasoningTokens: 4785.27, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoningTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/parameter.mdx b/client-sdks/typescript/models/parameter.mdx deleted file mode 100644 index 9caf7ecc..00000000 --- a/client-sdks/typescript/models/parameter.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Parameter - TypeScript SDK -description: Parameter method reference -seoTitle: Parameter | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/parameter' -'og:site_name': OpenRouter Documentation -'og:title': Parameter | OpenRouter TypeScript SDK -'og:description': >- - Parameter method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Parameter%20-%20TypeScript%20SDK&description=Parameter%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Parameter } from "@openrouter/sdk/models"; - -let value: Parameter = "temperature"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"temperature" | "top_p" | "top_k" | "min_p" | "top_a" | "frequency_penalty" | "presence_penalty" | "repetition_penalty" | "max_tokens" | "logit_bias" | "logprobs" | "top_logprobs" | "seed" | "response_format" | "structured_outputs" | "stop" | "tools" | "tool_choice" | "parallel_tool_calls" | "include_reasoning" | "reasoning" | "reasoning_effort" | "web_search_options" | "verbosity" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/part1.mdx b/client-sdks/typescript/models/part1.mdx deleted file mode 100644 index 8fe23b48..00000000 --- a/client-sdks/typescript/models/part1.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Part1 - TypeScript SDK -description: Part1 method reference -seoTitle: Part1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/part1' -'og:site_name': OpenRouter Documentation -'og:title': Part1 | OpenRouter TypeScript SDK -'og:description': >- - Part1 method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Part1%20-%20TypeScript%20SDK&description=Part1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - type: "output_text", - text: "The capital of France is Paris.", -}; -``` - -### `models.ReasoningTextContent` - -```typescript lines -const value: models.ReasoningTextContent = { - type: "reasoning_text", - text: "Let me think step by step about this problem...", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - type: "refusal", - refusal: "I'm sorry, I cannot assist with that request", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/part2.mdx b/client-sdks/typescript/models/part2.mdx deleted file mode 100644 index 7f3620ee..00000000 --- a/client-sdks/typescript/models/part2.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Part2 - TypeScript SDK -description: Part2 method reference -seoTitle: Part2 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/part2' -'og:site_name': OpenRouter Documentation -'og:title': Part2 | OpenRouter TypeScript SDK -'og:description': >- - Part2 method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Part2%20-%20TypeScript%20SDK&description=Part2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - type: "output_text", - text: "The capital of France is Paris.", -}; -``` - -### `models.ReasoningTextContent` - -```typescript lines -const value: models.ReasoningTextContent = { - type: "reasoning_text", - text: "Let me think step by step about this problem...", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - type: "refusal", - refusal: "I'm sorry, I cannot assist with that request", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/partition.mdx b/client-sdks/typescript/models/partition.mdx deleted file mode 100644 index 10599b13..00000000 --- a/client-sdks/typescript/models/partition.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Partition - TypeScript SDK -description: Partition method reference -seoTitle: Partition | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/partition' -'og:site_name': OpenRouter Documentation -'og:title': Partition | OpenRouter TypeScript SDK -'og:description': >- - Partition method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Partition%20-%20TypeScript%20SDK&description=Partition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Partition } from "@openrouter/sdk/models"; - -let value: Partition = "none"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"model" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/payloadtoolargeresponseerrordata.mdx b/client-sdks/typescript/models/payloadtoolargeresponseerrordata.mdx deleted file mode 100644 index 1485a345..00000000 --- a/client-sdks/typescript/models/payloadtoolargeresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PayloadTooLargeResponseErrorData - TypeScript SDK -description: PayloadTooLargeResponseErrorData method reference -seoTitle: PayloadTooLargeResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/payloadtoolargeresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PayloadTooLargeResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - PayloadTooLargeResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PayloadTooLargeResponseErrorData%20-%20TypeScript%20SDK&description=PayloadTooLargeResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for PayloadTooLargeResponse - -## Example Usage - -```typescript lines -import { PayloadTooLargeResponseErrorData } from "@openrouter/sdk/models"; - -let value: PayloadTooLargeResponseErrorData = { - code: 413, - message: "Request payload too large", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/paymentrequiredresponseerrordata.mdx b/client-sdks/typescript/models/paymentrequiredresponseerrordata.mdx deleted file mode 100644 index d0810038..00000000 --- a/client-sdks/typescript/models/paymentrequiredresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PaymentRequiredResponseErrorData - TypeScript SDK -description: PaymentRequiredResponseErrorData method reference -seoTitle: PaymentRequiredResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/paymentrequiredresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': PaymentRequiredResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - PaymentRequiredResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PaymentRequiredResponseErrorData%20-%20TypeScript%20SDK&description=PaymentRequiredResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for PaymentRequiredResponse - -## Example Usage - -```typescript lines -import { PaymentRequiredResponseErrorData } from "@openrouter/sdk/models"; - -let value: PaymentRequiredResponseErrorData = { - code: 402, - message: "Insufficient credits. Add more using https://openrouter.ai/credits", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/pdf.mdx b/client-sdks/typescript/models/pdf.mdx deleted file mode 100644 index 584f2e5c..00000000 --- a/client-sdks/typescript/models/pdf.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Pdf - TypeScript SDK -description: Pdf method reference -seoTitle: Pdf | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/pdf' -'og:site_name': OpenRouter Documentation -'og:title': Pdf | OpenRouter TypeScript SDK -'og:description': >- - Pdf method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pdf%20-%20TypeScript%20SDK&description=Pdf%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Pdf } from "@openrouter/sdk/models"; - -let value: Pdf = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `engine` | [models.PdfEngine](/client-sdks/typescript/models/pdfengine) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/pdfengine.mdx b/client-sdks/typescript/models/pdfengine.mdx deleted file mode 100644 index 3ef64b17..00000000 --- a/client-sdks/typescript/models/pdfengine.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PdfEngine - TypeScript SDK -description: PdfEngine method reference -seoTitle: PdfEngine | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/pdfengine' -'og:site_name': OpenRouter Documentation -'og:title': PdfEngine | OpenRouter TypeScript SDK -'og:description': >- - PdfEngine method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PdfEngine%20-%20TypeScript%20SDK&description=PdfEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PdfEngine } from "@openrouter/sdk/models"; - -let value: PdfEngine = "pdf-text"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"mistral-ocr" | "pdf-text" | "native" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/pdfparserengine.mdx b/client-sdks/typescript/models/pdfparserengine.mdx deleted file mode 100644 index 311217c9..00000000 --- a/client-sdks/typescript/models/pdfparserengine.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: PDFParserEngine - TypeScript SDK -description: PDFParserEngine method reference -seoTitle: PDFParserEngine | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/pdfparserengine' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserEngine | OpenRouter TypeScript SDK -'og:description': >- - PDFParserEngine method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserEngine%20-%20TypeScript%20SDK&description=PDFParserEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The engine to use for parsing PDF files. - -## Example Usage - -```typescript lines -import { PDFParserEngine } from "@openrouter/sdk/models"; - -let value: PDFParserEngine = "native"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"mistral-ocr" | "pdf-text" | "native" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/pdfparseroptions.mdx b/client-sdks/typescript/models/pdfparseroptions.mdx deleted file mode 100644 index ea6e8060..00000000 --- a/client-sdks/typescript/models/pdfparseroptions.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PDFParserOptions - TypeScript SDK -description: PDFParserOptions method reference -seoTitle: PDFParserOptions | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/pdfparseroptions' -'og:site_name': OpenRouter Documentation -'og:title': PDFParserOptions | OpenRouter TypeScript SDK -'og:description': >- - PDFParserOptions method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PDFParserOptions%20-%20TypeScript%20SDK&description=PDFParserOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Options for PDF parsing. - -## Example Usage - -```typescript lines -import { PDFParserOptions } from "@openrouter/sdk/models"; - -let value: PDFParserOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `engine` | [models.PDFParserEngine](/client-sdks/typescript/models/pdfparserengine) | :heavy_minus_sign: | The engine to use for parsing PDF files. | \ No newline at end of file diff --git a/client-sdks/typescript/models/percentilelatencycutoffs.mdx b/client-sdks/typescript/models/percentilelatencycutoffs.mdx deleted file mode 100644 index f89c12ee..00000000 --- a/client-sdks/typescript/models/percentilelatencycutoffs.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: PercentileLatencyCutoffs - TypeScript SDK -description: PercentileLatencyCutoffs method reference -seoTitle: PercentileLatencyCutoffs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/percentilelatencycutoffs' -'og:site_name': OpenRouter Documentation -'og:title': PercentileLatencyCutoffs | OpenRouter TypeScript SDK -'og:description': >- - PercentileLatencyCutoffs method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileLatencyCutoffs%20-%20TypeScript%20SDK&description=PercentileLatencyCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Percentile-based latency cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Example Usage - -```typescript lines -import { PercentileLatencyCutoffs } from "@openrouter/sdk/models"; - -let value: PercentileLatencyCutoffs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *number* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *number* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *number* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/client-sdks/typescript/models/percentilestats.mdx b/client-sdks/typescript/models/percentilestats.mdx deleted file mode 100644 index da6a39b7..00000000 --- a/client-sdks/typescript/models/percentilestats.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: PercentileStats - TypeScript SDK -description: PercentileStats method reference -seoTitle: PercentileStats | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/percentilestats' -'og:site_name': OpenRouter Documentation -'og:title': PercentileStats | OpenRouter TypeScript SDK -'og:description': >- - PercentileStats method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileStats%20-%20TypeScript%20SDK&description=PercentileStats%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { PercentileStats } from "@openrouter/sdk/models"; - -let value: PercentileStats = { - p50: 25.5, - p75: 35.2, - p90: 48.7, - p99: 85.3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `p50` | *number* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *number* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *number* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *number* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file diff --git a/client-sdks/typescript/models/percentilethroughputcutoffs.mdx b/client-sdks/typescript/models/percentilethroughputcutoffs.mdx deleted file mode 100644 index 838bb394..00000000 --- a/client-sdks/typescript/models/percentilethroughputcutoffs.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: PercentileThroughputCutoffs - TypeScript SDK -description: PercentileThroughputCutoffs method reference -seoTitle: PercentileThroughputCutoffs | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/percentilethroughputcutoffs' -'og:site_name': OpenRouter Documentation -'og:title': PercentileThroughputCutoffs | OpenRouter TypeScript SDK -'og:description': >- - PercentileThroughputCutoffs method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PercentileThroughputCutoffs%20-%20TypeScript%20SDK&description=PercentileThroughputCutoffs%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Percentile-based throughput cutoffs. All specified cutoffs must be met for an endpoint to be preferred. - -## Example Usage - -```typescript lines -import { PercentileThroughputCutoffs } from "@openrouter/sdk/models"; - -let value: PercentileThroughputCutoffs = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *number* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *number* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *number* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/client-sdks/typescript/models/perrequestlimits.mdx b/client-sdks/typescript/models/perrequestlimits.mdx deleted file mode 100644 index 3ac90967..00000000 --- a/client-sdks/typescript/models/perrequestlimits.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: PerRequestLimits - TypeScript SDK -description: PerRequestLimits method reference -seoTitle: PerRequestLimits | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/perrequestlimits' -'og:site_name': OpenRouter Documentation -'og:title': PerRequestLimits | OpenRouter TypeScript SDK -'og:description': >- - PerRequestLimits method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PerRequestLimits%20-%20TypeScript%20SDK&description=PerRequestLimits%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Per-request token limits - -## Example Usage - -```typescript lines -import { PerRequestLimits } from "@openrouter/sdk/models"; - -let value: PerRequestLimits = { - promptTokens: 1000, - completionTokens: 1000, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `promptTokens` | *number* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | -| `completionTokens` | *number* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/models/preferredmaxlatency.mdx b/client-sdks/typescript/models/preferredmaxlatency.mdx deleted file mode 100644 index f64ae591..00000000 --- a/client-sdks/typescript/models/preferredmaxlatency.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PreferredMaxLatency - TypeScript SDK -description: PreferredMaxLatency method reference -seoTitle: PreferredMaxLatency | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/preferredmaxlatency' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMaxLatency | OpenRouter TypeScript SDK -'og:description': >- - PreferredMaxLatency method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMaxLatency%20-%20TypeScript%20SDK&description=PreferredMaxLatency%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `number` - -```typescript lines -const value: number = 5; -``` - -### `models.PercentileLatencyCutoffs` - -```typescript lines -const value: models.PercentileLatencyCutoffs = {}; -``` - -### `any` - -```typescript lines -const value: any = 5; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/preferredminthroughput.mdx b/client-sdks/typescript/models/preferredminthroughput.mdx deleted file mode 100644 index 256de365..00000000 --- a/client-sdks/typescript/models/preferredminthroughput.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PreferredMinThroughput - TypeScript SDK -description: PreferredMinThroughput method reference -seoTitle: PreferredMinThroughput | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/preferredminthroughput' -'og:site_name': OpenRouter Documentation -'og:title': PreferredMinThroughput | OpenRouter TypeScript SDK -'og:description': >- - PreferredMinThroughput method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PreferredMinThroughput%20-%20TypeScript%20SDK&description=PreferredMinThroughput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Supported Types - -### `number` - -```typescript lines -const value: number = 100; -``` - -### `models.PercentileThroughputCutoffs` - -```typescript lines -const value: models.PercentileThroughputCutoffs = {}; -``` - -### `any` - -```typescript lines -const value: any = 100; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/pricing.mdx b/client-sdks/typescript/models/pricing.mdx deleted file mode 100644 index 88c5a43e..00000000 --- a/client-sdks/typescript/models/pricing.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Pricing - TypeScript SDK -description: Pricing method reference -seoTitle: Pricing | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/pricing' -'og:site_name': OpenRouter Documentation -'og:title': Pricing | OpenRouter TypeScript SDK -'og:description': >- - Pricing method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Pricing%20-%20TypeScript%20SDK&description=Pricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Pricing } from "@openrouter/sdk/models"; - -let value: Pricing = { - prompt: "1000", - completion: "1000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *string* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `completion` | *string* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `request` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `imageToken` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `imageOutput` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputAudioCache` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `webSearch` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `internalReasoning` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputCacheRead` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `discount` | *number* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/prompt.mdx b/client-sdks/typescript/models/prompt.mdx deleted file mode 100644 index a97c145e..00000000 --- a/client-sdks/typescript/models/prompt.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Prompt - TypeScript SDK -description: Prompt method reference -seoTitle: Prompt | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/prompt' -'og:site_name': OpenRouter Documentation -'og:title': Prompt | OpenRouter TypeScript SDK -'og:description': >- - Prompt method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Prompt%20-%20TypeScript%20SDK&description=Prompt%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` - -### `number[]` - -```typescript lines -const value: number[] = [ - 3390.48, - 1336.21, - 9437.99, -]; -``` - -### `number[][]` - -```typescript lines -const value: number[][] = [ - [ - 6206.15, - ], - [ - 8419.72, - 5863.71, - ], - [ - 2540.22, - ], -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/prompttokensdetails.mdx b/client-sdks/typescript/models/prompttokensdetails.mdx deleted file mode 100644 index 5e6fbcdf..00000000 --- a/client-sdks/typescript/models/prompttokensdetails.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: PromptTokensDetails - TypeScript SDK -description: PromptTokensDetails method reference -seoTitle: PromptTokensDetails | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/prompttokensdetails' -'og:site_name': OpenRouter Documentation -'og:title': PromptTokensDetails | OpenRouter TypeScript SDK -'og:description': >- - PromptTokensDetails method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PromptTokensDetails%20-%20TypeScript%20SDK&description=PromptTokensDetails%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PromptTokensDetails } from "@openrouter/sdk/models"; - -let value: PromptTokensDetails = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `cachedTokens` | *number* | :heavy_minus_sign: | N/A | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | N/A | -| `audioTokens` | *number* | :heavy_minus_sign: | N/A | -| `videoTokens` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/providername.mdx b/client-sdks/typescript/models/providername.mdx deleted file mode 100644 index bcf6c0d4..00000000 --- a/client-sdks/typescript/models/providername.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ProviderName - TypeScript SDK -description: ProviderName method reference -seoTitle: ProviderName | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providername' -'og:site_name': OpenRouter Documentation -'og:title': ProviderName | OpenRouter TypeScript SDK -'og:description': >- - ProviderName method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderName%20-%20TypeScript%20SDK&description=ProviderName%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderName } from "@openrouter/sdk/models"; - -let value: ProviderName = "OpenAI"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"AI21" | "AionLabs" | "Alibaba" | "Amazon Bedrock" | "Amazon Nova" | "Anthropic" | "Arcee AI" | "AtlasCloud" | "Avian" | "Azure" | "BaseTen" | "BytePlus" | "Black Forest Labs" | "Cerebras" | "Chutes" | "Cirrascale" | "Clarifai" | "Cloudflare" | "Cohere" | "Crusoe" | "DeepInfra" | "DeepSeek" | "Featherless" | "Fireworks" | "Friendli" | "GMICloud" | "Google" | "Google AI Studio" | "Groq" | "Hyperbolic" | "Inception" | "Inceptron" | "InferenceNet" | "Infermatic" | "Inflection" | "Liquid" | "Mara" | "Mancer 2" | "Minimax" | "ModelRun" | "Mistral" | "Modular" | "Moonshot AI" | "Morph" | "NCompass" | "Nebius" | "NextBit" | "Novita" | "Nvidia" | "OpenAI" | "OpenInference" | "Parasail" | "Perplexity" | "Phala" | "Relace" | "SambaNova" | "Seed" | "SiliconFlow" | "Sourceful" | "Stealth" | "StreamLake" | "Switchpoint" | "Together" | "Upstage" | "Venice" | "WandB" | "Xiaomi" | "xAI" | "Z.AI" | "FakeProvider" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/provideroverloadedresponseerrordata.mdx b/client-sdks/typescript/models/provideroverloadedresponseerrordata.mdx deleted file mode 100644 index bbcb9c31..00000000 --- a/client-sdks/typescript/models/provideroverloadedresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ProviderOverloadedResponseErrorData - TypeScript SDK -description: ProviderOverloadedResponseErrorData method reference -seoTitle: ProviderOverloadedResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/provideroverloadedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ProviderOverloadedResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - ProviderOverloadedResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderOverloadedResponseErrorData%20-%20TypeScript%20SDK&description=ProviderOverloadedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ProviderOverloadedResponse - -## Example Usage - -```typescript lines -import { ProviderOverloadedResponseErrorData } from "@openrouter/sdk/models"; - -let value: ProviderOverloadedResponseErrorData = { - code: 529, - message: "Provider returned error", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferences.mdx b/client-sdks/typescript/models/providerpreferences.mdx deleted file mode 100644 index 03c5edc8..00000000 --- a/client-sdks/typescript/models/providerpreferences.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ProviderPreferences - TypeScript SDK -description: ProviderPreferences method reference -seoTitle: ProviderPreferences | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferences' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferences | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferences method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferences%20-%20TypeScript%20SDK&description=ProviderPreferences%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Provider routing preferences for the request. - -## Example Usage - -```typescript lines -import { ProviderPreferences } from "@openrouter/sdk/models"; - -let value: ProviderPreferences = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve `requests
`- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `requireParameters` | *boolean* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `dataCollection` | [models.DataCollection](/client-sdks/typescript/models/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 | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | -| `enforceDistillableText` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `order` | *models.ProviderPreferencesOrder*[] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | | -| `only` | *models.ProviderPreferencesOnly*[] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | | -| `ignore` | *models.ProviderPreferencesIgnore*[] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | | -| `quantizations` | [models.Quantization](/client-sdks/typescript/models/quantization)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `sort` | *models.ProviderPreferencesSortUnion* | :heavy_minus_sign: | N/A | | -| `maxPrice` | [models.ProviderPreferencesMaxPrice](/client-sdks/typescript/models/providerpreferencesmaxprice) | :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. | | -| `preferredMinThroughput` | *models.PreferredMinThroughput* | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `preferredMaxLatency` | *models.PreferredMaxLatency* | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesignore.mdx b/client-sdks/typescript/models/providerpreferencesignore.mdx deleted file mode 100644 index 54348bc3..00000000 --- a/client-sdks/typescript/models/providerpreferencesignore.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesIgnore - TypeScript SDK -description: ProviderPreferencesIgnore method reference -seoTitle: ProviderPreferencesIgnore | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencesignore' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesIgnore | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesIgnore method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesIgnore%20-%20TypeScript%20SDK&description=ProviderPreferencesIgnore%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesmaxprice.mdx b/client-sdks/typescript/models/providerpreferencesmaxprice.mdx deleted file mode 100644 index 82a7875f..00000000 --- a/client-sdks/typescript/models/providerpreferencesmaxprice.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ProviderPreferencesMaxPrice - TypeScript SDK -description: ProviderPreferencesMaxPrice method reference -seoTitle: ProviderPreferencesMaxPrice | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencesmaxprice' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesMaxPrice | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesMaxPrice method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesMaxPrice%20-%20TypeScript%20SDK&description=ProviderPreferencesMaxPrice%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. - -## Example Usage - -```typescript lines -import { ProviderPreferencesMaxPrice } from "@openrouter/sdk/models"; - -let value: ProviderPreferencesMaxPrice = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `completion` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `request` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesonly.mdx b/client-sdks/typescript/models/providerpreferencesonly.mdx deleted file mode 100644 index 17c902a7..00000000 --- a/client-sdks/typescript/models/providerpreferencesonly.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesOnly - TypeScript SDK -description: ProviderPreferencesOnly method reference -seoTitle: ProviderPreferencesOnly | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencesonly' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesOnly | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesOnly method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesOnly%20-%20TypeScript%20SDK&description=ProviderPreferencesOnly%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesorder.mdx b/client-sdks/typescript/models/providerpreferencesorder.mdx deleted file mode 100644 index eb7e2aab..00000000 --- a/client-sdks/typescript/models/providerpreferencesorder.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderPreferencesOrder - TypeScript SDK -description: ProviderPreferencesOrder method reference -seoTitle: ProviderPreferencesOrder | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencesorder' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesOrder | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesOrder method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesOrder%20-%20TypeScript%20SDK&description=ProviderPreferencesOrder%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderName` - -```typescript lines -const value: models.ProviderName = "OpenAI"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencespartition.mdx b/client-sdks/typescript/models/providerpreferencespartition.mdx deleted file mode 100644 index 7d5ed645..00000000 --- a/client-sdks/typescript/models/providerpreferencespartition.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ProviderPreferencesPartition - TypeScript SDK -description: ProviderPreferencesPartition method reference -seoTitle: ProviderPreferencesPartition | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencespartition' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesPartition | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesPartition method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesPartition%20-%20TypeScript%20SDK&description=ProviderPreferencesPartition%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderPreferencesPartition } from "@openrouter/sdk/models"; - -let value: ProviderPreferencesPartition = "model"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"model" | "none" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesprovidersort.mdx b/client-sdks/typescript/models/providerpreferencesprovidersort.mdx deleted file mode 100644 index 16053c33..00000000 --- a/client-sdks/typescript/models/providerpreferencesprovidersort.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ProviderPreferencesProviderSort - TypeScript SDK -description: ProviderPreferencesProviderSort method reference -seoTitle: ProviderPreferencesProviderSort | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/providerpreferencesprovidersort -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesProviderSort | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesProviderSort method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesProviderSort%20-%20TypeScript%20SDK&description=ProviderPreferencesProviderSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderPreferencesProviderSort } from "@openrouter/sdk/models"; - -let value: ProviderPreferencesProviderSort = "latency"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"price" | "throughput" | "latency" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencesprovidersortconfig.mdx b/client-sdks/typescript/models/providerpreferencesprovidersortconfig.mdx deleted file mode 100644 index b8088b1e..00000000 --- a/client-sdks/typescript/models/providerpreferencesprovidersortconfig.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ProviderPreferencesProviderSortConfig - TypeScript SDK -description: ProviderPreferencesProviderSortConfig method reference -seoTitle: ProviderPreferencesProviderSortConfig | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/providerpreferencesprovidersortconfig -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesProviderSortConfig | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesProviderSortConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesProviderSortConfig%20-%20TypeScript%20SDK&description=ProviderPreferencesProviderSortConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderPreferencesProviderSortConfig } from "@openrouter/sdk/models"; - -let value: ProviderPreferencesProviderSortConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `by` | [models.ProviderSort](/client-sdks/typescript/models/providersort) | :heavy_minus_sign: | N/A | price | -| `partition` | [models.ProviderPreferencesPartition](/client-sdks/typescript/models/providerpreferencespartition) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/providerpreferencessortunion.mdx b/client-sdks/typescript/models/providerpreferencessortunion.mdx deleted file mode 100644 index 5c25baf0..00000000 --- a/client-sdks/typescript/models/providerpreferencessortunion.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ProviderPreferencesSortUnion - TypeScript SDK -description: ProviderPreferencesSortUnion method reference -seoTitle: ProviderPreferencesSortUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providerpreferencessortunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderPreferencesSortUnion | OpenRouter TypeScript SDK -'og:description': >- - ProviderPreferencesSortUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderPreferencesSortUnion%20-%20TypeScript%20SDK&description=ProviderPreferencesSortUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. - -## Supported Types - -### `models.ProviderPreferencesProviderSort` - -```typescript lines -const value: models.ProviderPreferencesProviderSort = "throughput"; -``` - -### `models.ProviderSortConfigUnion` - -```typescript lines -const value: models.ProviderSortConfigUnion = "latency"; -``` - -### `models.SortEnum` - -```typescript lines -const value: models.SortEnum = "throughput"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providersort.mdx b/client-sdks/typescript/models/providersort.mdx deleted file mode 100644 index 799f7b55..00000000 --- a/client-sdks/typescript/models/providersort.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ProviderSort - TypeScript SDK -description: ProviderSort method reference -seoTitle: ProviderSort | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providersort' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSort | OpenRouter TypeScript SDK -'og:description': >- - ProviderSort method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSort%20-%20TypeScript%20SDK&description=ProviderSort%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderSort } from "@openrouter/sdk/models"; - -let value: ProviderSort = "price"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"price" | "throughput" | "latency" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providersortconfig.mdx b/client-sdks/typescript/models/providersortconfig.mdx deleted file mode 100644 index 73793f53..00000000 --- a/client-sdks/typescript/models/providersortconfig.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ProviderSortConfig - TypeScript SDK -description: ProviderSortConfig method reference -seoTitle: ProviderSortConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providersortconfig' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfig | OpenRouter TypeScript SDK -'og:description': >- - ProviderSortConfig method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfig%20-%20TypeScript%20SDK&description=ProviderSortConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderSortConfig } from "@openrouter/sdk/models"; - -let value: ProviderSortConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `by` | [models.ProviderSort](/client-sdks/typescript/models/providersort) | :heavy_minus_sign: | N/A | price | -| `partition` | [models.Partition](/client-sdks/typescript/models/partition) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/providersortconfigenum.mdx b/client-sdks/typescript/models/providersortconfigenum.mdx deleted file mode 100644 index c552f5c9..00000000 --- a/client-sdks/typescript/models/providersortconfigenum.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderSortConfigEnum - TypeScript SDK -description: ProviderSortConfigEnum method reference -seoTitle: ProviderSortConfigEnum | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providersortconfigenum' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfigEnum | OpenRouter TypeScript SDK -'og:description': >- - ProviderSortConfigEnum method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfigEnum%20-%20TypeScript%20SDK&description=ProviderSortConfigEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ProviderSortConfigEnum } from "@openrouter/sdk/models"; - -let value: ProviderSortConfigEnum = "throughput"; -``` - -## Values - -```typescript lines -"price" | "throughput" | "latency" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providersortconfigunion.mdx b/client-sdks/typescript/models/providersortconfigunion.mdx deleted file mode 100644 index cdc9fc25..00000000 --- a/client-sdks/typescript/models/providersortconfigunion.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderSortConfigUnion - TypeScript SDK -description: ProviderSortConfigUnion method reference -seoTitle: ProviderSortConfigUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providersortconfigunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortConfigUnion | OpenRouter TypeScript SDK -'og:description': >- - ProviderSortConfigUnion method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortConfigUnion%20-%20TypeScript%20SDK&description=ProviderSortConfigUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderPreferencesProviderSortConfig` - -```typescript lines -const value: models.ProviderPreferencesProviderSortConfig = {}; -``` - -### `models.ProviderSortConfigEnum` - -```typescript lines -const value: models.ProviderSortConfigEnum = "throughput"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/providersortunion.mdx b/client-sdks/typescript/models/providersortunion.mdx deleted file mode 100644 index 5475853b..00000000 --- a/client-sdks/typescript/models/providersortunion.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ProviderSortUnion - TypeScript SDK -description: ProviderSortUnion method reference -seoTitle: ProviderSortUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/providersortunion' -'og:site_name': OpenRouter Documentation -'og:title': ProviderSortUnion | OpenRouter TypeScript SDK -'og:description': >- - ProviderSortUnion method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ProviderSortUnion%20-%20TypeScript%20SDK&description=ProviderSortUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ProviderSort` - -```typescript lines -const value: models.ProviderSort = "price"; -``` - -### `models.ProviderSortConfig` - -```typescript lines -const value: models.ProviderSortConfig = {}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/publicendpoint.mdx b/client-sdks/typescript/models/publicendpoint.mdx deleted file mode 100644 index cac79c3f..00000000 --- a/client-sdks/typescript/models/publicendpoint.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: PublicEndpoint - TypeScript SDK -description: PublicEndpoint method reference -seoTitle: PublicEndpoint | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/publicendpoint' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpoint | OpenRouter TypeScript SDK -'og:description': >- - PublicEndpoint method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpoint%20-%20TypeScript%20SDK&description=PublicEndpoint%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about a specific model endpoint - -## Example Usage - -```typescript expandable lines -import { PublicEndpoint } from "@openrouter/sdk/models"; - -let value: PublicEndpoint = { - name: "OpenAI: GPT-4", - modelName: "GPT-4", - contextLength: 8192, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - providerName: "OpenAI", - tag: "openai", - quantization: "fp16", - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - uptimeLast30m: 99.5, - supportsImplicitCaching: true, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `modelName` | *string* | :heavy_check_mark: | N/A | | -| `contextLength` | *number* | :heavy_check_mark: | N/A | | -| `pricing` | [models.Pricing](/client-sdks/typescript/models/pricing) | :heavy_check_mark: | N/A | | -| `providerName` | [models.ProviderName](/client-sdks/typescript/models/providername) | :heavy_check_mark: | N/A | OpenAI | -| `tag` | *string* | :heavy_check_mark: | N/A | | -| `quantization` | [models.PublicEndpointQuantization](/client-sdks/typescript/models/publicendpointquantization) | :heavy_check_mark: | N/A | fp16 | -| `maxCompletionTokens` | *number* | :heavy_check_mark: | N/A | | -| `maxPromptTokens` | *number* | :heavy_check_mark: | N/A | | -| `supportedParameters` | [models.Parameter](/client-sdks/typescript/models/parameter)[] | :heavy_check_mark: | N/A | | -| `status` | [models.EndpointStatus](/client-sdks/typescript/models/endpointstatus) | :heavy_minus_sign: | N/A | 0 | -| `uptimeLast30m` | *number* | :heavy_check_mark: | N/A | | -| `supportsImplicitCaching` | *boolean* | :heavy_check_mark: | N/A | | -| `latencyLast30m` | [models.PercentileStats](/client-sdks/typescript/models/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. | | -| `throughputLast30m` | [models.PercentileStats](/client-sdks/typescript/models/percentilestats) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/publicendpointquantization.mdx b/client-sdks/typescript/models/publicendpointquantization.mdx deleted file mode 100644 index 25e484fd..00000000 --- a/client-sdks/typescript/models/publicendpointquantization.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: PublicEndpointQuantization - TypeScript SDK -description: PublicEndpointQuantization method reference -seoTitle: PublicEndpointQuantization | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/publicendpointquantization' -'og:site_name': OpenRouter Documentation -'og:title': PublicEndpointQuantization | OpenRouter TypeScript SDK -'og:description': >- - PublicEndpointQuantization method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicEndpointQuantization%20-%20TypeScript%20SDK&description=PublicEndpointQuantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { PublicEndpointQuantization } from "@openrouter/sdk/models"; - -let value: PublicEndpointQuantization = "fp16"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/publicpricing.mdx b/client-sdks/typescript/models/publicpricing.mdx deleted file mode 100644 index 20afee3b..00000000 --- a/client-sdks/typescript/models/publicpricing.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: PublicPricing - TypeScript SDK -description: PublicPricing method reference -seoTitle: PublicPricing | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/publicpricing' -'og:site_name': OpenRouter Documentation -'og:title': PublicPricing | OpenRouter TypeScript SDK -'og:description': >- - PublicPricing method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=PublicPricing%20-%20TypeScript%20SDK&description=PublicPricing%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Pricing information for the model - -## Example Usage - -```typescript lines -import { PublicPricing } from "@openrouter/sdk/models"; - -let value: PublicPricing = { - prompt: "0.00003", - completion: "0.00006", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `prompt` | *string* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `completion` | *string* | :heavy_check_mark: | A value in string format that is a large number | 1000 | -| `request` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `image` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `imageToken` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `imageOutput` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `audio` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputAudioCache` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `webSearch` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `internalReasoning` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputCacheRead` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | A value in string format that is a large number | 1000 | -| `discount` | *number* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/quantization.mdx b/client-sdks/typescript/models/quantization.mdx deleted file mode 100644 index 323634ed..00000000 --- a/client-sdks/typescript/models/quantization.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Quantization - TypeScript SDK -description: Quantization method reference -seoTitle: Quantization | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/quantization' -'og:site_name': OpenRouter Documentation -'og:title': Quantization | OpenRouter TypeScript SDK -'og:description': >- - Quantization method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantization%20-%20TypeScript%20SDK&description=Quantization%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Quantization } from "@openrouter/sdk/models"; - -let value: Quantization = "fp16"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/quantizations.mdx b/client-sdks/typescript/models/quantizations.mdx deleted file mode 100644 index 8d106554..00000000 --- a/client-sdks/typescript/models/quantizations.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Quantizations - TypeScript SDK -description: Quantizations method reference -seoTitle: Quantizations | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/quantizations' -'og:site_name': OpenRouter Documentation -'og:title': Quantizations | OpenRouter TypeScript SDK -'og:description': >- - Quantizations method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Quantizations%20-%20TypeScript%20SDK&description=Quantizations%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Quantizations } from "@openrouter/sdk/models"; - -let value: Quantizations = "fp4"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"int4" | "int8" | "fp4" | "fp6" | "fp8" | "fp16" | "bf16" | "fp32" | "unknown" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/reason.mdx b/client-sdks/typescript/models/reason.mdx deleted file mode 100644 index 9f02396b..00000000 --- a/client-sdks/typescript/models/reason.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Reason - TypeScript SDK -description: Reason method reference -seoTitle: Reason | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reason' -'og:site_name': OpenRouter Documentation -'og:title': Reason | OpenRouter TypeScript SDK -'og:description': >- - Reason method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reason%20-%20TypeScript%20SDK&description=Reason%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Reason } from "@openrouter/sdk/models"; - -let value: Reason = "content_filter"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"max_output_tokens" | "content_filter" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoning.mdx b/client-sdks/typescript/models/reasoning.mdx deleted file mode 100644 index 16e0f5ee..00000000 --- a/client-sdks/typescript/models/reasoning.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Reasoning - TypeScript SDK -description: Reasoning method reference -seoTitle: Reasoning | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoning' -'og:site_name': OpenRouter Documentation -'og:title': Reasoning | OpenRouter TypeScript SDK -'og:description': >- - Reasoning method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Reasoning%20-%20TypeScript%20SDK&description=Reasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Reasoning } from "@openrouter/sdk/models"; - -let value: Reasoning = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `effort` | [models.Effort](/client-sdks/typescript/models/effort) | :heavy_minus_sign: | N/A | -| `summary` | [models.ReasoningSummaryVerbosity](/client-sdks/typescript/models/reasoningsummaryverbosity) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoningsummarytext.mdx b/client-sdks/typescript/models/reasoningsummarytext.mdx deleted file mode 100644 index 27db8dc4..00000000 --- a/client-sdks/typescript/models/reasoningsummarytext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningSummaryText - TypeScript SDK -description: ReasoningSummaryText method reference -seoTitle: ReasoningSummaryText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoningsummarytext' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryText | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryText method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryText%20-%20TypeScript%20SDK&description=ReasoningSummaryText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryText } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryText = { - type: "summary_text", - text: "Analyzed the problem using first principles", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.ReasoningSummaryTextType](/client-sdks/typescript/models/reasoningsummarytexttype) | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoningsummarytexttype.mdx b/client-sdks/typescript/models/reasoningsummarytexttype.mdx deleted file mode 100644 index a5b1274f..00000000 --- a/client-sdks/typescript/models/reasoningsummarytexttype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningSummaryTextType - TypeScript SDK -description: ReasoningSummaryTextType method reference -seoTitle: ReasoningSummaryTextType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoningsummarytexttype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryTextType | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryTextType method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryTextType%20-%20TypeScript%20SDK&description=ReasoningSummaryTextType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryTextType } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryTextType = "summary_text"; -``` - -## Values - -```typescript lines -"summary_text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoningsummaryverbosity.mdx b/client-sdks/typescript/models/reasoningsummaryverbosity.mdx deleted file mode 100644 index 14c20c9d..00000000 --- a/client-sdks/typescript/models/reasoningsummaryverbosity.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ReasoningSummaryVerbosity - TypeScript SDK -description: ReasoningSummaryVerbosity method reference -seoTitle: ReasoningSummaryVerbosity | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoningsummaryverbosity' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningSummaryVerbosity | OpenRouter TypeScript SDK -'og:description': >- - ReasoningSummaryVerbosity method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningSummaryVerbosity%20-%20TypeScript%20SDK&description=ReasoningSummaryVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningSummaryVerbosity } from "@openrouter/sdk/models"; - -let value: ReasoningSummaryVerbosity = "detailed"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "concise" | "detailed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoningtextcontent.mdx b/client-sdks/typescript/models/reasoningtextcontent.mdx deleted file mode 100644 index 18d6b211..00000000 --- a/client-sdks/typescript/models/reasoningtextcontent.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ReasoningTextContent - TypeScript SDK -description: ReasoningTextContent method reference -seoTitle: ReasoningTextContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoningtextcontent' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContent | OpenRouter TypeScript SDK -'og:description': >- - ReasoningTextContent method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContent%20-%20TypeScript%20SDK&description=ReasoningTextContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningTextContent } from "@openrouter/sdk/models"; - -let value: ReasoningTextContent = { - type: "reasoning_text", - text: "Let me think step by step about this problem...", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.ReasoningTextContentType](/client-sdks/typescript/models/reasoningtextcontenttype) | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/reasoningtextcontenttype.mdx b/client-sdks/typescript/models/reasoningtextcontenttype.mdx deleted file mode 100644 index d1ae3108..00000000 --- a/client-sdks/typescript/models/reasoningtextcontenttype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ReasoningTextContentType - TypeScript SDK -description: ReasoningTextContentType method reference -seoTitle: ReasoningTextContentType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/reasoningtextcontenttype' -'og:site_name': OpenRouter Documentation -'og:title': ReasoningTextContentType | OpenRouter TypeScript SDK -'og:description': >- - ReasoningTextContentType method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ReasoningTextContentType%20-%20TypeScript%20SDK&description=ReasoningTextContentType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ReasoningTextContentType } from "@openrouter/sdk/models"; - -let value: ReasoningTextContentType = "reasoning_text"; -``` - -## Values - -```typescript lines -"reasoning_text" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/requesttimeoutresponseerrordata.mdx b/client-sdks/typescript/models/requesttimeoutresponseerrordata.mdx deleted file mode 100644 index ea531ab0..00000000 --- a/client-sdks/typescript/models/requesttimeoutresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: RequestTimeoutResponseErrorData - TypeScript SDK -description: RequestTimeoutResponseErrorData method reference -seoTitle: RequestTimeoutResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/requesttimeoutresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': RequestTimeoutResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - RequestTimeoutResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=RequestTimeoutResponseErrorData%20-%20TypeScript%20SDK&description=RequestTimeoutResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for RequestTimeoutResponse - -## Example Usage - -```typescript lines -import { RequestTimeoutResponseErrorData } from "@openrouter/sdk/models"; - -let value: RequestTimeoutResponseErrorData = { - code: 408, - message: "Operation timed out. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseformatjsonschema.mdx b/client-sdks/typescript/models/responseformatjsonschema.mdx deleted file mode 100644 index b120d086..00000000 --- a/client-sdks/typescript/models/responseformatjsonschema.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponseFormatJSONSchema - TypeScript SDK -description: ResponseFormatJSONSchema method reference -seoTitle: ResponseFormatJSONSchema | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseformatjsonschema' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatJSONSchema | OpenRouter TypeScript SDK -'og:description': >- - ResponseFormatJSONSchema method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatJSONSchema%20-%20TypeScript%20SDK&description=ResponseFormatJSONSchema%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseFormatJSONSchema } from "@openrouter/sdk/models"; - -let value: ResponseFormatJSONSchema = { - type: "json_schema", - jsonSchema: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | -| `jsonSchema` | [models.JSONSchemaConfig](/client-sdks/typescript/models/jsonschemaconfig) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseformattextconfig.mdx b/client-sdks/typescript/models/responseformattextconfig.mdx deleted file mode 100644 index d1ff0472..00000000 --- a/client-sdks/typescript/models/responseformattextconfig.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ResponseFormatTextConfig - TypeScript SDK -description: ResponseFormatTextConfig method reference -seoTitle: ResponseFormatTextConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseformattextconfig' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatTextConfig | OpenRouter TypeScript SDK -'og:description': >- - ResponseFormatTextConfig method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatTextConfig%20-%20TypeScript%20SDK&description=ResponseFormatTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text response format configuration - -## Supported Types - -### `models.ResponsesFormatText` - -```typescript lines -const value: models.ResponsesFormatText = { - type: "text", -}; -``` - -### `models.ResponsesFormatJSONObject` - -```typescript lines -const value: models.ResponsesFormatJSONObject = { - type: "json_object", -}; -``` - -### `models.ResponsesFormatTextJSONSchemaConfig` - -```typescript lines -const value: models.ResponsesFormatTextJSONSchemaConfig = { - type: "json_schema", - name: "", - schema: { - "key": "", - "key1": "", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseformattextgrammar.mdx b/client-sdks/typescript/models/responseformattextgrammar.mdx deleted file mode 100644 index 95112d0b..00000000 --- a/client-sdks/typescript/models/responseformattextgrammar.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponseFormatTextGrammar - TypeScript SDK -description: ResponseFormatTextGrammar method reference -seoTitle: ResponseFormatTextGrammar | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseformattextgrammar' -'og:site_name': OpenRouter Documentation -'og:title': ResponseFormatTextGrammar | OpenRouter TypeScript SDK -'og:description': >- - ResponseFormatTextGrammar method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseFormatTextGrammar%20-%20TypeScript%20SDK&description=ResponseFormatTextGrammar%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseFormatTextGrammar } from "@openrouter/sdk/models"; - -let value: ResponseFormatTextGrammar = { - type: "grammar", - grammar: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"grammar"* | :heavy_check_mark: | N/A | -| `grammar` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputaudio.mdx b/client-sdks/typescript/models/responseinputaudio.mdx deleted file mode 100644 index f75e985a..00000000 --- a/client-sdks/typescript/models/responseinputaudio.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ResponseInputAudio - TypeScript SDK -description: ResponseInputAudio method reference -seoTitle: ResponseInputAudio | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudio | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputAudio method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudio%20-%20TypeScript%20SDK&description=ResponseInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Audio input content item - -## Example Usage - -```typescript lines -import { ResponseInputAudio } from "@openrouter/sdk/models"; - -let value: ResponseInputAudio = { - type: "input_audio", - inputAudio: { - data: "SGVsbG8gV29ybGQ=", - format: "mp3", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | -| `inputAudio` | [models.ResponseInputAudioInputAudio](/client-sdks/typescript/models/responseinputaudioinputaudio) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputaudioformat.mdx b/client-sdks/typescript/models/responseinputaudioformat.mdx deleted file mode 100644 index eb497601..00000000 --- a/client-sdks/typescript/models/responseinputaudioformat.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponseInputAudioFormat - TypeScript SDK -description: ResponseInputAudioFormat method reference -seoTitle: ResponseInputAudioFormat | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputaudioformat' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudioFormat | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputAudioFormat method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudioFormat%20-%20TypeScript%20SDK&description=ResponseInputAudioFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseInputAudioFormat } from "@openrouter/sdk/models"; - -let value: ResponseInputAudioFormat = "mp3"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"mp3" | "wav" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputaudioinputaudio.mdx b/client-sdks/typescript/models/responseinputaudioinputaudio.mdx deleted file mode 100644 index 1cc8ca0d..00000000 --- a/client-sdks/typescript/models/responseinputaudioinputaudio.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponseInputAudioInputAudio - TypeScript SDK -description: ResponseInputAudioInputAudio method reference -seoTitle: ResponseInputAudioInputAudio | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputaudioinputaudio' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputAudioInputAudio | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputAudioInputAudio method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputAudioInputAudio%20-%20TypeScript%20SDK&description=ResponseInputAudioInputAudio%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseInputAudioInputAudio } from "@openrouter/sdk/models"; - -let value: ResponseInputAudioInputAudio = { - data: "", - format: "wav", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | [models.ResponseInputAudioFormat](/client-sdks/typescript/models/responseinputaudioformat) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputfile.mdx b/client-sdks/typescript/models/responseinputfile.mdx deleted file mode 100644 index 03371dde..00000000 --- a/client-sdks/typescript/models/responseinputfile.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ResponseInputFile - TypeScript SDK -description: ResponseInputFile method reference -seoTitle: ResponseInputFile | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputfile' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputFile | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputFile method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputFile%20-%20TypeScript%20SDK&description=ResponseInputFile%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -File input content item - -## Example Usage - -```typescript lines -import { ResponseInputFile } from "@openrouter/sdk/models"; - -let value: ResponseInputFile = { - type: "input_file", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"input_file"* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `fileData` | *string* | :heavy_minus_sign: | N/A | -| `filename` | *string* | :heavy_minus_sign: | N/A | -| `fileUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputimage.mdx b/client-sdks/typescript/models/responseinputimage.mdx deleted file mode 100644 index 30dda882..00000000 --- a/client-sdks/typescript/models/responseinputimage.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponseInputImage - TypeScript SDK -description: ResponseInputImage method reference -seoTitle: ResponseInputImage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputimage' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImage | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputImage method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImage%20-%20TypeScript%20SDK&description=ResponseInputImage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Image input content item - -## Example Usage - -```typescript lines -import { ResponseInputImage } from "@openrouter/sdk/models"; - -let value: ResponseInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.ResponseInputImageType](/client-sdks/typescript/models/responseinputimagetype) | :heavy_check_mark: | N/A | -| `detail` | [models.ResponseInputImageDetail](/client-sdks/typescript/models/responseinputimagedetail) | :heavy_check_mark: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputimagedetail.mdx b/client-sdks/typescript/models/responseinputimagedetail.mdx deleted file mode 100644 index 4eaa46a5..00000000 --- a/client-sdks/typescript/models/responseinputimagedetail.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponseInputImageDetail - TypeScript SDK -description: ResponseInputImageDetail method reference -seoTitle: ResponseInputImageDetail | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputimagedetail' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImageDetail | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputImageDetail method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImageDetail%20-%20TypeScript%20SDK&description=ResponseInputImageDetail%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseInputImageDetail } from "@openrouter/sdk/models"; - -let value: ResponseInputImageDetail = "high"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "high" | "low" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputimagetype.mdx b/client-sdks/typescript/models/responseinputimagetype.mdx deleted file mode 100644 index f2dc1d6d..00000000 --- a/client-sdks/typescript/models/responseinputimagetype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponseInputImageType - TypeScript SDK -description: ResponseInputImageType method reference -seoTitle: ResponseInputImageType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputimagetype' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputImageType | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputImageType method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputImageType%20-%20TypeScript%20SDK&description=ResponseInputImageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseInputImageType } from "@openrouter/sdk/models"; - -let value: ResponseInputImageType = "input_image"; -``` - -## Values - -```typescript lines -"input_image" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputtext.mdx b/client-sdks/typescript/models/responseinputtext.mdx deleted file mode 100644 index 194a5545..00000000 --- a/client-sdks/typescript/models/responseinputtext.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponseInputText - TypeScript SDK -description: ResponseInputText method reference -seoTitle: ResponseInputText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputtext' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputText | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputText method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputText%20-%20TypeScript%20SDK&description=ResponseInputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text input content item - -## Example Usage - -```typescript lines -import { ResponseInputText } from "@openrouter/sdk/models"; - -let value: ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"input_text"* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseinputvideo.mdx b/client-sdks/typescript/models/responseinputvideo.mdx deleted file mode 100644 index ed7a3205..00000000 --- a/client-sdks/typescript/models/responseinputvideo.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponseInputVideo - TypeScript SDK -description: ResponseInputVideo method reference -seoTitle: ResponseInputVideo | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseinputvideo' -'og:site_name': OpenRouter Documentation -'og:title': ResponseInputVideo | OpenRouter TypeScript SDK -'og:description': >- - ResponseInputVideo method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseInputVideo%20-%20TypeScript%20SDK&description=ResponseInputVideo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Video input content item - -## Example Usage - -```typescript lines -import { ResponseInputVideo } from "@openrouter/sdk/models"; - -let value: ResponseInputVideo = { - type: "input_video", - videoUrl: "https://example.com/video.mp4", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | -| `videoUrl` | *string* | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseoutputtext.mdx b/client-sdks/typescript/models/responseoutputtext.mdx deleted file mode 100644 index a8185b6a..00000000 --- a/client-sdks/typescript/models/responseoutputtext.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponseOutputText - TypeScript SDK -description: ResponseOutputText method reference -seoTitle: ResponseOutputText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseoutputtext' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputText | OpenRouter TypeScript SDK -'og:description': >- - ResponseOutputText method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputText%20-%20TypeScript%20SDK&description=ResponseOutputText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseOutputText } from "@openrouter/sdk/models"; - -let value: ResponseOutputText = { - type: "output_text", - text: "The capital of France is Paris.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | *"output_text"* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `annotations` | *models.OpenAIResponsesAnnotation*[] | :heavy_minus_sign: | N/A | -| `logprobs` | [models.Logprob](/client-sdks/typescript/models/logprob)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseoutputtexttoplogprob.mdx b/client-sdks/typescript/models/responseoutputtexttoplogprob.mdx deleted file mode 100644 index 4a5a06f6..00000000 --- a/client-sdks/typescript/models/responseoutputtexttoplogprob.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ResponseOutputTextTopLogprob - TypeScript SDK -description: ResponseOutputTextTopLogprob method reference -seoTitle: ResponseOutputTextTopLogprob | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseoutputtexttoplogprob' -'og:site_name': OpenRouter Documentation -'og:title': ResponseOutputTextTopLogprob | OpenRouter TypeScript SDK -'og:description': >- - ResponseOutputTextTopLogprob method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseOutputTextTopLogprob%20-%20TypeScript%20SDK&description=ResponseOutputTextTopLogprob%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseOutputTextTopLogprob } from "@openrouter/sdk/models"; - -let value: ResponseOutputTextTopLogprob = { - token: "", - bytes: [ - 3036.17, - 344.14, - ], - logprob: 1976.4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `token` | *string* | :heavy_check_mark: | N/A | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseserrorfield.mdx b/client-sdks/typescript/models/responseserrorfield.mdx deleted file mode 100644 index 7290159d..00000000 --- a/client-sdks/typescript/models/responseserrorfield.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponsesErrorField - TypeScript SDK -description: ResponsesErrorField method reference -seoTitle: ResponsesErrorField | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseserrorfield' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesErrorField | OpenRouter TypeScript SDK -'og:description': >- - ResponsesErrorField method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesErrorField%20-%20TypeScript%20SDK&description=ResponsesErrorField%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error information returned from the API - -## Example Usage - -```typescript lines -import { ResponsesErrorField } from "@openrouter/sdk/models"; - -let value: ResponsesErrorField = { - code: "rate_limit_exceeded", - message: "Rate limit exceeded. Please try again later.", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `code` | [models.CodeEnum](/client-sdks/typescript/models/codeenum) | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesformatjsonobject.mdx b/client-sdks/typescript/models/responsesformatjsonobject.mdx deleted file mode 100644 index e58c8138..00000000 --- a/client-sdks/typescript/models/responsesformatjsonobject.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponsesFormatJSONObject - TypeScript SDK -description: ResponsesFormatJSONObject method reference -seoTitle: ResponsesFormatJSONObject | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesformatjsonobject' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatJSONObject | OpenRouter TypeScript SDK -'og:description': >- - ResponsesFormatJSONObject method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatJSONObject%20-%20TypeScript%20SDK&description=ResponsesFormatJSONObject%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON object response format - -## Example Usage - -```typescript lines -import { ResponsesFormatJSONObject } from "@openrouter/sdk/models"; - -let value: ResponsesFormatJSONObject = { - type: "json_object", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesformattext.mdx b/client-sdks/typescript/models/responsesformattext.mdx deleted file mode 100644 index 92862804..00000000 --- a/client-sdks/typescript/models/responsesformattext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponsesFormatText - TypeScript SDK -description: ResponsesFormatText method reference -seoTitle: ResponsesFormatText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesformattext' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatText | OpenRouter TypeScript SDK -'og:description': >- - ResponsesFormatText method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatText%20-%20TypeScript%20SDK&description=ResponsesFormatText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Plain text response format - -## Example Usage - -```typescript lines -import { ResponsesFormatText } from "@openrouter/sdk/models"; - -let value: ResponsesFormatText = { - type: "text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesformattextjsonschemaconfig.mdx b/client-sdks/typescript/models/responsesformattextjsonschemaconfig.mdx deleted file mode 100644 index 13fca7aa..00000000 --- a/client-sdks/typescript/models/responsesformattextjsonschemaconfig.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ResponsesFormatTextJSONSchemaConfig - TypeScript SDK -description: ResponsesFormatTextJSONSchemaConfig method reference -seoTitle: ResponsesFormatTextJSONSchemaConfig | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesformattextjsonschemaconfig -'og:site_name': OpenRouter Documentation -'og:title': ResponsesFormatTextJSONSchemaConfig | OpenRouter TypeScript SDK -'og:description': >- - ResponsesFormatTextJSONSchemaConfig method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesFormatTextJSONSchemaConfig%20-%20TypeScript%20SDK&description=ResponsesFormatTextJSONSchemaConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -JSON schema constrained response format - -## Example Usage - -```typescript lines -import { ResponsesFormatTextJSONSchemaConfig } from "@openrouter/sdk/models"; - -let value: ResponsesFormatTextJSONSchemaConfig = { - type: "json_schema", - name: "", - schema: { - "key": "", - "key1": "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `schema` | `Record` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesimagegenerationcall.mdx b/client-sdks/typescript/models/responsesimagegenerationcall.mdx deleted file mode 100644 index 0d8b7d3f..00000000 --- a/client-sdks/typescript/models/responsesimagegenerationcall.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ResponsesImageGenerationCall - TypeScript SDK -description: ResponsesImageGenerationCall method reference -seoTitle: ResponsesImageGenerationCall | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesimagegenerationcall' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesImageGenerationCall | OpenRouter TypeScript SDK -'og:description': >- - ResponsesImageGenerationCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesImageGenerationCall%20-%20TypeScript%20SDK&description=ResponsesImageGenerationCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesImageGenerationCall } from "@openrouter/sdk/models"; - -let value: ResponsesImageGenerationCall = { - type: "image_generation_call", - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesImageGenerationCallType](/client-sdks/typescript/models/responsesimagegenerationcalltype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](/client-sdks/typescript/models/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesimagegenerationcalltype.mdx b/client-sdks/typescript/models/responsesimagegenerationcalltype.mdx deleted file mode 100644 index 90dc7266..00000000 --- a/client-sdks/typescript/models/responsesimagegenerationcalltype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesImageGenerationCallType - TypeScript SDK -description: ResponsesImageGenerationCallType method reference -seoTitle: ResponsesImageGenerationCallType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesimagegenerationcalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesImageGenerationCallType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesImageGenerationCallType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesImageGenerationCallType%20-%20TypeScript%20SDK&description=ResponsesImageGenerationCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesImageGenerationCallType } from "@openrouter/sdk/models"; - -let value: ResponsesImageGenerationCallType = "image_generation_call"; -``` - -## Values - -```typescript lines -"image_generation_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitem.mdx b/client-sdks/typescript/models/responsesoutputitem.mdx deleted file mode 100644 index 50bb7ce4..00000000 --- a/client-sdks/typescript/models/responsesoutputitem.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: ResponsesOutputItem - TypeScript SDK -description: ResponsesOutputItem method reference -seoTitle: ResponsesOutputItem | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputitem' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItem | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItem method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItem%20-%20TypeScript%20SDK&description=ResponsesOutputItem%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output item from the response - -## Supported Types - -### `models.ResponsesOutputMessage` - -```typescript lines -const value: models.ResponsesOutputMessage = { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], -}; -``` - -### `models.ResponsesOutputItemReasoning` - -```typescript lines -const value: models.ResponsesOutputItemReasoning = { - type: "reasoning", - id: "reasoning-abc123", - summary: [ - { - type: "summary_text", - text: "Analyzed the problem using first principles", - }, - ], -}; -``` - -### `models.ResponsesOutputItemFunctionCall` - -```typescript lines -const value: models.ResponsesOutputItemFunctionCall = { - type: "function_call", - name: "get_weather", - arguments: "{\"location\":\"San Francisco\",\"unit\":\"celsius\"}", - callId: "call-abc123", -}; -``` - -### `models.ResponsesWebSearchCallOutput` - -```typescript lines -const value: models.ResponsesWebSearchCallOutput = { - type: "web_search_call", - id: "search-abc123", - status: "completed", -}; -``` - -### `models.ResponsesOutputItemFileSearchCall` - -```typescript lines -const value: models.ResponsesOutputItemFileSearchCall = { - type: "file_search_call", - id: "filesearch-abc123", - queries: [ - "machine learning algorithms", - "neural networks", - ], - status: "completed", -}; -``` - -### `models.ResponsesImageGenerationCall` - -```typescript lines -const value: models.ResponsesImageGenerationCall = { - type: "image_generation_call", - id: "imagegen-abc123", - result: - "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", - status: "completed", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfilesearchcall.mdx b/client-sdks/typescript/models/responsesoutputitemfilesearchcall.mdx deleted file mode 100644 index 7c547f0d..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfilesearchcall.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ResponsesOutputItemFileSearchCall - TypeScript SDK -description: ResponsesOutputItemFileSearchCall method reference -seoTitle: ResponsesOutputItemFileSearchCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfilesearchcall -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFileSearchCall | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFileSearchCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFileSearchCall%20-%20TypeScript%20SDK&description=ResponsesOutputItemFileSearchCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFileSearchCall } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFileSearchCall = { - type: "file_search_call", - id: "filesearch-abc123", - queries: [ - "machine learning algorithms", - "neural networks", - ], - status: "completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesOutputItemFileSearchCallType](/client-sdks/typescript/models/responsesoutputitemfilesearchcalltype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `queries` | *string*[] | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](/client-sdks/typescript/models/websearchstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfilesearchcalltype.mdx b/client-sdks/typescript/models/responsesoutputitemfilesearchcalltype.mdx deleted file mode 100644 index dd7339c3..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfilesearchcalltype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputItemFileSearchCallType - TypeScript SDK -description: ResponsesOutputItemFileSearchCallType method reference -seoTitle: ResponsesOutputItemFileSearchCallType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfilesearchcalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFileSearchCallType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFileSearchCallType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFileSearchCallType%20-%20TypeScript%20SDK&description=ResponsesOutputItemFileSearchCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFileSearchCallType } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFileSearchCallType = "file_search_call"; -``` - -## Values - -```typescript lines -"file_search_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncall.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncall.mdx deleted file mode 100644 index 5f218640..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncall.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCall - TypeScript SDK -description: ResponsesOutputItemFunctionCall method reference -seoTitle: ResponsesOutputItemFunctionCall | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncall -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCall | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCall method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCall%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCall%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFunctionCall } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFunctionCall = { - type: "function_call", - name: "get_weather", - arguments: "{\"location\":\"San Francisco\",\"unit\":\"celsius\"}", - callId: "call-abc123", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesOutputItemFunctionCallType](/client-sdks/typescript/models/responsesoutputitemfunctioncalltype) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `status` | *models.ResponsesOutputItemFunctionCallStatusUnion* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatuscompleted.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncallstatuscompleted.mdx deleted file mode 100644 index 0a662d4b..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusCompleted - TypeScript SDK -description: ResponsesOutputItemFunctionCallStatusCompleted method reference -seoTitle: ResponsesOutputItemFunctionCallStatusCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncallstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusCompleted | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusCompleted method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusCompleted%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCallStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFunctionCallStatusCompleted } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFunctionCallStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusincomplete.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusincomplete.mdx deleted file mode 100644 index c0e63a39..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusIncomplete - TypeScript SDK -description: ResponsesOutputItemFunctionCallStatusIncomplete method reference -seoTitle: ResponsesOutputItemFunctionCallStatusIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncallstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusIncomplete | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusIncomplete method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusIncomplete%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCallStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFunctionCallStatusIncomplete } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFunctionCallStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusinprogress.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusinprogress.mdx deleted file mode 100644 index f46e63b5..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusInProgress - TypeScript SDK -description: ResponsesOutputItemFunctionCallStatusInProgress method reference -seoTitle: ResponsesOutputItemFunctionCallStatusInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncallstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusInProgress | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusInProgress method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusInProgress%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCallStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFunctionCallStatusInProgress } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFunctionCallStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusunion.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusunion.mdx deleted file mode 100644 index 84b8d055..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncallstatusunion.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallStatusUnion - TypeScript SDK -description: ResponsesOutputItemFunctionCallStatusUnion method reference -seoTitle: ResponsesOutputItemFunctionCallStatusUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncallstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallStatusUnion | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCallStatusUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallStatusUnion%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCallStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponsesOutputItemFunctionCallStatusCompleted` - -```typescript lines -const value: models.ResponsesOutputItemFunctionCallStatusCompleted = - "completed"; -``` - -### `models.ResponsesOutputItemFunctionCallStatusIncomplete` - -```typescript lines -const value: models.ResponsesOutputItemFunctionCallStatusIncomplete = - "incomplete"; -``` - -### `models.ResponsesOutputItemFunctionCallStatusInProgress` - -```typescript lines -const value: models.ResponsesOutputItemFunctionCallStatusInProgress = - "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemfunctioncalltype.mdx b/client-sdks/typescript/models/responsesoutputitemfunctioncalltype.mdx deleted file mode 100644 index d652af68..00000000 --- a/client-sdks/typescript/models/responsesoutputitemfunctioncalltype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputItemFunctionCallType - TypeScript SDK -description: ResponsesOutputItemFunctionCallType method reference -seoTitle: ResponsesOutputItemFunctionCallType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemfunctioncalltype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemFunctionCallType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemFunctionCallType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemFunctionCallType%20-%20TypeScript%20SDK&description=ResponsesOutputItemFunctionCallType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemFunctionCallType } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemFunctionCallType = "function_call"; -``` - -## Values - -```typescript lines -"function_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoning.mdx b/client-sdks/typescript/models/responsesoutputitemreasoning.mdx deleted file mode 100644 index 4f936dd7..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoning.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ResponsesOutputItemReasoning - TypeScript SDK -description: ResponsesOutputItemReasoning method reference -seoTitle: ResponsesOutputItemReasoning | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputitemreasoning' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoning | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoning method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoning%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoning%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output item containing reasoning - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoning } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoning = { - type: "reasoning", - id: "reasoning-abc123", - summary: [ - { - type: "summary_text", - text: "Analyzed the problem using first principles", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesOutputItemReasoningType](/client-sdks/typescript/models/responsesoutputitemreasoningtype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `content` | [models.ReasoningTextContent](/client-sdks/typescript/models/reasoningtextcontent)[] | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](/client-sdks/typescript/models/reasoningsummarytext)[] | :heavy_check_mark: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `status` | *models.ResponsesOutputItemReasoningStatusUnion* | :heavy_minus_sign: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | -| `format` | [models.ResponsesOutputItemReasoningFormat](/client-sdks/typescript/models/responsesoutputitemreasoningformat) | :heavy_minus_sign: | The format of the reasoning content | anthropic-claude-v1 | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningformat.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningformat.mdx deleted file mode 100644 index 1e4c44ef..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningformat.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ResponsesOutputItemReasoningFormat - TypeScript SDK -description: ResponsesOutputItemReasoningFormat method reference -seoTitle: ResponsesOutputItemReasoningFormat | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningformat -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningFormat | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningFormat method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningFormat%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The format of the reasoning content - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoningFormat } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoningFormat = "anthropic-claude-v1"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"unknown" | "openai-responses-v1" | "azure-openai-responses-v1" | "xai-responses-v1" | "anthropic-claude-v1" | "google-gemini-v1" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningstatuscompleted.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningstatuscompleted.mdx deleted file mode 100644 index 229b93cb..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningstatuscompleted.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusCompleted - TypeScript SDK -description: ResponsesOutputItemReasoningStatusCompleted method reference -seoTitle: ResponsesOutputItemReasoningStatusCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningstatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusCompleted | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningStatusCompleted method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusCompleted%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoningStatusCompleted } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoningStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningstatusincomplete.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningstatusincomplete.mdx deleted file mode 100644 index 743a517d..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningstatusincomplete.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusIncomplete - TypeScript SDK -description: ResponsesOutputItemReasoningStatusIncomplete method reference -seoTitle: ResponsesOutputItemReasoningStatusIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningstatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusIncomplete | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningStatusIncomplete method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusIncomplete%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoningStatusIncomplete } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoningStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningstatusinprogress.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningstatusinprogress.mdx deleted file mode 100644 index a7ffd20e..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningstatusinprogress.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusInProgress - TypeScript SDK -description: ResponsesOutputItemReasoningStatusInProgress method reference -seoTitle: ResponsesOutputItemReasoningStatusInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningstatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusInProgress | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningStatusInProgress method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusInProgress%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoningStatusInProgress } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoningStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningstatusunion.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningstatusunion.mdx deleted file mode 100644 index 70126672..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningstatusunion.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: ResponsesOutputItemReasoningStatusUnion - TypeScript SDK -description: ResponsesOutputItemReasoningStatusUnion method reference -seoTitle: ResponsesOutputItemReasoningStatusUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningstatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningStatusUnion | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningStatusUnion method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningStatusUnion%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponsesOutputItemReasoningStatusCompleted` - -```typescript lines -const value: models.ResponsesOutputItemReasoningStatusCompleted = "completed"; -``` - -### `models.ResponsesOutputItemReasoningStatusIncomplete` - -```typescript lines -const value: models.ResponsesOutputItemReasoningStatusIncomplete = "incomplete"; -``` - -### `models.ResponsesOutputItemReasoningStatusInProgress` - -```typescript lines -const value: models.ResponsesOutputItemReasoningStatusInProgress = - "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputitemreasoningtype.mdx b/client-sdks/typescript/models/responsesoutputitemreasoningtype.mdx deleted file mode 100644 index f0743d31..00000000 --- a/client-sdks/typescript/models/responsesoutputitemreasoningtype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputItemReasoningType - TypeScript SDK -description: ResponsesOutputItemReasoningType method reference -seoTitle: ResponsesOutputItemReasoningType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputitemreasoningtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputItemReasoningType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputItemReasoningType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputItemReasoningType%20-%20TypeScript%20SDK&description=ResponsesOutputItemReasoningType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputItemReasoningType } from "@openrouter/sdk/models"; - -let value: ResponsesOutputItemReasoningType = "reasoning"; -``` - -## Values - -```typescript lines -"reasoning" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessage.mdx b/client-sdks/typescript/models/responsesoutputmessage.mdx deleted file mode 100644 index 7d8df293..00000000 --- a/client-sdks/typescript/models/responsesoutputmessage.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ResponsesOutputMessage - TypeScript SDK -description: ResponsesOutputMessage method reference -seoTitle: ResponsesOutputMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputmessage' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessage | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessage method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessage%20-%20TypeScript%20SDK&description=ResponsesOutputMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -An output message item - -## Example Usage - -```typescript lines -import { ResponsesOutputMessage } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessage = { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `role` | [models.ResponsesOutputMessageRole](/client-sdks/typescript/models/responsesoutputmessagerole) | :heavy_check_mark: | N/A | -| `type` | [models.ResponsesOutputMessageType](/client-sdks/typescript/models/responsesoutputmessagetype) | :heavy_check_mark: | N/A | -| `status` | *models.ResponsesOutputMessageStatusUnion* | :heavy_minus_sign: | N/A | -| `content` | *models.ResponsesOutputMessageContent*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagecontent.mdx b/client-sdks/typescript/models/responsesoutputmessagecontent.mdx deleted file mode 100644 index 42166e81..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagecontent.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesOutputMessageContent - TypeScript SDK -description: ResponsesOutputMessageContent method reference -seoTitle: ResponsesOutputMessageContent | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputmessagecontent -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageContent | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageContent method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageContent%20-%20TypeScript%20SDK&description=ResponsesOutputMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponseOutputText` - -```typescript lines -const value: models.ResponseOutputText = { - type: "output_text", - text: "The capital of France is Paris.", -}; -``` - -### `models.OpenAIResponsesRefusalContent` - -```typescript lines -const value: models.OpenAIResponsesRefusalContent = { - type: "refusal", - refusal: "I'm sorry, I cannot assist with that request", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagerole.mdx b/client-sdks/typescript/models/responsesoutputmessagerole.mdx deleted file mode 100644 index 818b1b83..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagerole.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponsesOutputMessageRole - TypeScript SDK -description: ResponsesOutputMessageRole method reference -seoTitle: ResponsesOutputMessageRole | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputmessagerole' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageRole | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageRole method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageRole%20-%20TypeScript%20SDK&description=ResponsesOutputMessageRole%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputMessageRole } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessageRole = "assistant"; -``` - -## Values - -```typescript lines -"assistant" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagestatuscompleted.mdx b/client-sdks/typescript/models/responsesoutputmessagestatuscompleted.mdx deleted file mode 100644 index e23751ce..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagestatuscompleted.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputMessageStatusCompleted - TypeScript SDK -description: ResponsesOutputMessageStatusCompleted method reference -seoTitle: ResponsesOutputMessageStatusCompleted | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputmessagestatuscompleted -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusCompleted | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageStatusCompleted method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusCompleted%20-%20TypeScript%20SDK&description=ResponsesOutputMessageStatusCompleted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputMessageStatusCompleted } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessageStatusCompleted = "completed"; -``` - -## Values - -```typescript lines -"completed" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagestatusincomplete.mdx b/client-sdks/typescript/models/responsesoutputmessagestatusincomplete.mdx deleted file mode 100644 index ba70f104..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagestatusincomplete.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputMessageStatusIncomplete - TypeScript SDK -description: ResponsesOutputMessageStatusIncomplete method reference -seoTitle: ResponsesOutputMessageStatusIncomplete | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputmessagestatusincomplete -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusIncomplete | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageStatusIncomplete method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusIncomplete%20-%20TypeScript%20SDK&description=ResponsesOutputMessageStatusIncomplete%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputMessageStatusIncomplete } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessageStatusIncomplete = "incomplete"; -``` - -## Values - -```typescript lines -"incomplete" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagestatusinprogress.mdx b/client-sdks/typescript/models/responsesoutputmessagestatusinprogress.mdx deleted file mode 100644 index 8122d4b7..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagestatusinprogress.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesOutputMessageStatusInProgress - TypeScript SDK -description: ResponsesOutputMessageStatusInProgress method reference -seoTitle: ResponsesOutputMessageStatusInProgress | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputmessagestatusinprogress -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusInProgress | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageStatusInProgress method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusInProgress%20-%20TypeScript%20SDK&description=ResponsesOutputMessageStatusInProgress%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputMessageStatusInProgress } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessageStatusInProgress = "in_progress"; -``` - -## Values - -```typescript lines -"in_progress" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagestatusunion.mdx b/client-sdks/typescript/models/responsesoutputmessagestatusunion.mdx deleted file mode 100644 index d6b3bbaf..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagestatusunion.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesOutputMessageStatusUnion - TypeScript SDK -description: ResponsesOutputMessageStatusUnion method reference -seoTitle: ResponsesOutputMessageStatusUnion | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responsesoutputmessagestatusunion -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageStatusUnion | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageStatusUnion method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageStatusUnion%20-%20TypeScript%20SDK&description=ResponsesOutputMessageStatusUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ResponsesOutputMessageStatusCompleted` - -```typescript lines -const value: models.ResponsesOutputMessageStatusCompleted = "completed"; -``` - -### `models.ResponsesOutputMessageStatusIncomplete` - -```typescript lines -const value: models.ResponsesOutputMessageStatusIncomplete = "incomplete"; -``` - -### `models.ResponsesOutputMessageStatusInProgress` - -```typescript lines -const value: models.ResponsesOutputMessageStatusInProgress = "in_progress"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmessagetype.mdx b/client-sdks/typescript/models/responsesoutputmessagetype.mdx deleted file mode 100644 index 439991be..00000000 --- a/client-sdks/typescript/models/responsesoutputmessagetype.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ResponsesOutputMessageType - TypeScript SDK -description: ResponsesOutputMessageType method reference -seoTitle: ResponsesOutputMessageType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputmessagetype' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputMessageType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputMessageType method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputMessageType%20-%20TypeScript%20SDK&description=ResponsesOutputMessageType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputMessageType } from "@openrouter/sdk/models"; - -let value: ResponsesOutputMessageType = "message"; -``` - -## Values - -```typescript lines -"message" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsesoutputmodality.mdx b/client-sdks/typescript/models/responsesoutputmodality.mdx deleted file mode 100644 index 55e2af79..00000000 --- a/client-sdks/typescript/models/responsesoutputmodality.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponsesOutputModality - TypeScript SDK -description: ResponsesOutputModality method reference -seoTitle: ResponsesOutputModality | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsesoutputmodality' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesOutputModality | OpenRouter TypeScript SDK -'og:description': >- - ResponsesOutputModality method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesOutputModality%20-%20TypeScript%20SDK&description=ResponsesOutputModality%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesOutputModality } from "@openrouter/sdk/models"; - -let value: ResponsesOutputModality = "image"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"text" | "image" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsessearchcontextsize.mdx b/client-sdks/typescript/models/responsessearchcontextsize.mdx deleted file mode 100644 index c4c9d28a..00000000 --- a/client-sdks/typescript/models/responsessearchcontextsize.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ResponsesSearchContextSize - TypeScript SDK -description: ResponsesSearchContextSize method reference -seoTitle: ResponsesSearchContextSize | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsessearchcontextsize' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesSearchContextSize | OpenRouter TypeScript SDK -'og:description': >- - ResponsesSearchContextSize method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesSearchContextSize%20-%20TypeScript%20SDK&description=ResponsesSearchContextSize%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Size of the search context for web search tools - -## Example Usage - -```typescript lines -import { ResponsesSearchContextSize } from "@openrouter/sdk/models"; - -let value: ResponsesSearchContextSize = "medium"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"low" | "medium" | "high" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseswebsearchcalloutput.mdx b/client-sdks/typescript/models/responseswebsearchcalloutput.mdx deleted file mode 100644 index ff96de9a..00000000 --- a/client-sdks/typescript/models/responseswebsearchcalloutput.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ResponsesWebSearchCallOutput - TypeScript SDK -description: ResponsesWebSearchCallOutput method reference -seoTitle: ResponsesWebSearchCallOutput | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responseswebsearchcalloutput' -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchCallOutput | OpenRouter TypeScript SDK -'og:description': >- - ResponsesWebSearchCallOutput method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchCallOutput%20-%20TypeScript%20SDK&description=ResponsesWebSearchCallOutput%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesWebSearchCallOutput } from "@openrouter/sdk/models"; - -let value: ResponsesWebSearchCallOutput = { - type: "web_search_call", - id: "search-abc123", - status: "completed", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesWebSearchCallOutputType](/client-sdks/typescript/models/responseswebsearchcalloutputtype) | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](/client-sdks/typescript/models/websearchstatus) | :heavy_check_mark: | N/A | completed | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseswebsearchcalloutputtype.mdx b/client-sdks/typescript/models/responseswebsearchcalloutputtype.mdx deleted file mode 100644 index 38110387..00000000 --- a/client-sdks/typescript/models/responseswebsearchcalloutputtype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesWebSearchCallOutputType - TypeScript SDK -description: ResponsesWebSearchCallOutputType method reference -seoTitle: ResponsesWebSearchCallOutputType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responseswebsearchcalloutputtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchCallOutputType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesWebSearchCallOutputType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchCallOutputType%20-%20TypeScript%20SDK&description=ResponsesWebSearchCallOutputType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesWebSearchCallOutputType } from "@openrouter/sdk/models"; - -let value: ResponsesWebSearchCallOutputType = "web_search_call"; -``` - -## Values - -```typescript lines -"web_search_call" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responseswebsearchuserlocation.mdx b/client-sdks/typescript/models/responseswebsearchuserlocation.mdx deleted file mode 100644 index 14c7a2e4..00000000 --- a/client-sdks/typescript/models/responseswebsearchuserlocation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ResponsesWebSearchUserLocation - TypeScript SDK -description: ResponsesWebSearchUserLocation method reference -seoTitle: ResponsesWebSearchUserLocation | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responseswebsearchuserlocation -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchUserLocation | OpenRouter TypeScript SDK -'og:description': >- - ResponsesWebSearchUserLocation method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchUserLocation%20-%20TypeScript%20SDK&description=ResponsesWebSearchUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -User location information for web search - -## Example Usage - -```typescript lines -import { ResponsesWebSearchUserLocation } from "@openrouter/sdk/models"; - -let value: ResponsesWebSearchUserLocation = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [models.ResponsesWebSearchUserLocationType](/client-sdks/typescript/models/responseswebsearchuserlocationtype) | :heavy_minus_sign: | N/A | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/responseswebsearchuserlocationtype.mdx b/client-sdks/typescript/models/responseswebsearchuserlocationtype.mdx deleted file mode 100644 index 59f188dd..00000000 --- a/client-sdks/typescript/models/responseswebsearchuserlocationtype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ResponsesWebSearchUserLocationType - TypeScript SDK -description: ResponsesWebSearchUserLocationType method reference -seoTitle: ResponsesWebSearchUserLocationType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/responseswebsearchuserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': ResponsesWebSearchUserLocationType | OpenRouter TypeScript SDK -'og:description': >- - ResponsesWebSearchUserLocationType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponsesWebSearchUserLocationType%20-%20TypeScript%20SDK&description=ResponsesWebSearchUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponsesWebSearchUserLocationType } from "@openrouter/sdk/models"; - -let value: ResponsesWebSearchUserLocationType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/responsetextconfig.mdx b/client-sdks/typescript/models/responsetextconfig.mdx deleted file mode 100644 index 86e9abca..00000000 --- a/client-sdks/typescript/models/responsetextconfig.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: ResponseTextConfig - TypeScript SDK -description: ResponseTextConfig method reference -seoTitle: ResponseTextConfig | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsetextconfig' -'og:site_name': OpenRouter Documentation -'og:title': ResponseTextConfig | OpenRouter TypeScript SDK -'og:description': >- - ResponseTextConfig method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseTextConfig%20-%20TypeScript%20SDK&description=ResponseTextConfig%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Text output configuration including format and verbosity - -## Example Usage - -```typescript lines -import { ResponseTextConfig } from "@openrouter/sdk/models"; - -let value: ResponseTextConfig = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `format` | *models.ResponseFormatTextConfig* | :heavy_minus_sign: | Text response format configuration | `{"type": "text"}` | -| `verbosity` | [models.ResponseTextConfigVerbosity](/client-sdks/typescript/models/responsetextconfigverbosity) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/models/responsetextconfigverbosity.mdx b/client-sdks/typescript/models/responsetextconfigverbosity.mdx deleted file mode 100644 index 3ced3816..00000000 --- a/client-sdks/typescript/models/responsetextconfigverbosity.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ResponseTextConfigVerbosity - TypeScript SDK -description: ResponseTextConfigVerbosity method reference -seoTitle: ResponseTextConfigVerbosity | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/responsetextconfigverbosity' -'og:site_name': OpenRouter Documentation -'og:title': ResponseTextConfigVerbosity | OpenRouter TypeScript SDK -'og:description': >- - ResponseTextConfigVerbosity method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ResponseTextConfigVerbosity%20-%20TypeScript%20SDK&description=ResponseTextConfigVerbosity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ResponseTextConfigVerbosity } from "@openrouter/sdk/models"; - -let value: ResponseTextConfigVerbosity = "low"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"high" | "low" | "medium" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/route.mdx b/client-sdks/typescript/models/route.mdx deleted file mode 100644 index 3696743d..00000000 --- a/client-sdks/typescript/models/route.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Route - TypeScript SDK -description: Route method reference -seoTitle: Route | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/route' -'og:site_name': OpenRouter Documentation -'og:title': Route | OpenRouter TypeScript SDK -'og:description': >- - Route method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Route%20-%20TypeScript%20SDK&description=Route%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Route } from "@openrouter/sdk/models"; - -let value: Route = "fallback"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"fallback" | "sort" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/schema0.mdx b/client-sdks/typescript/models/schema0.mdx deleted file mode 100644 index afb63b37..00000000 --- a/client-sdks/typescript/models/schema0.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Schema0 - TypeScript SDK -description: Schema0 method reference -seoTitle: Schema0 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema0' -'og:site_name': OpenRouter Documentation -'og:title': Schema0 | OpenRouter TypeScript SDK -'og:description': >- - Schema0 method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema0%20-%20TypeScript%20SDK&description=Schema0%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.Schema0Enum` - -```typescript lines -const value: models.Schema0Enum = "Alibaba"; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/schema0enum.mdx b/client-sdks/typescript/models/schema0enum.mdx deleted file mode 100644 index 4075d2e5..00000000 --- a/client-sdks/typescript/models/schema0enum.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Schema0Enum - TypeScript SDK -description: Schema0Enum method reference -seoTitle: Schema0Enum | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema0enum' -'og:site_name': OpenRouter Documentation -'og:title': Schema0Enum | OpenRouter TypeScript SDK -'og:description': >- - Schema0Enum method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema0Enum%20-%20TypeScript%20SDK&description=Schema0Enum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Schema0Enum } from "@openrouter/sdk/models"; - -let value: Schema0Enum = "WandB"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"AI21" | "AionLabs" | "Alibaba" | "Amazon Bedrock" | "Amazon Nova" | "Anthropic" | "Arcee AI" | "AtlasCloud" | "Avian" | "Azure" | "BaseTen" | "BytePlus" | "Black Forest Labs" | "Cerebras" | "Chutes" | "Cirrascale" | "Clarifai" | "Cloudflare" | "Cohere" | "Crusoe" | "DeepInfra" | "DeepSeek" | "Featherless" | "Fireworks" | "Friendli" | "GMICloud" | "Google" | "Google AI Studio" | "Groq" | "Hyperbolic" | "Inception" | "Inceptron" | "InferenceNet" | "Infermatic" | "Inflection" | "Liquid" | "Mara" | "Mancer 2" | "Minimax" | "ModelRun" | "Mistral" | "Modular" | "Moonshot AI" | "Morph" | "NCompass" | "Nebius" | "NextBit" | "Novita" | "Nvidia" | "OpenAI" | "OpenInference" | "Parasail" | "Perplexity" | "Phala" | "Relace" | "SambaNova" | "Seed" | "SiliconFlow" | "Sourceful" | "Stealth" | "StreamLake" | "Switchpoint" | "Together" | "Upstage" | "Venice" | "WandB" | "Xiaomi" | "xAI" | "Z.AI" | "FakeProvider" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/schema2.mdx b/client-sdks/typescript/models/schema2.mdx deleted file mode 100644 index 70c234ba..00000000 --- a/client-sdks/typescript/models/schema2.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Schema2 - TypeScript SDK -description: Schema2 method reference -seoTitle: Schema2 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema2' -'og:site_name': OpenRouter Documentation -'og:title': Schema2 | OpenRouter TypeScript SDK -'og:description': >- - Schema2 method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2%20-%20TypeScript%20SDK&description=Schema2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.Schema2ReasoningSummary` - -```typescript lines -const value: models.Schema2ReasoningSummary = { - type: "reasoning.summary", - summary: "", -}; -``` - -### `models.Schema2ReasoningEncrypted` - -```typescript lines -const value: models.Schema2ReasoningEncrypted = { - type: "reasoning.encrypted", - data: "", -}; -``` - -### `models.Schema2ReasoningText` - -```typescript lines -const value: models.Schema2ReasoningText = { - type: "reasoning.text", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/schema2reasoningencrypted.mdx b/client-sdks/typescript/models/schema2reasoningencrypted.mdx deleted file mode 100644 index d49f8c4e..00000000 --- a/client-sdks/typescript/models/schema2reasoningencrypted.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Schema2ReasoningEncrypted - TypeScript SDK -description: Schema2ReasoningEncrypted method reference -seoTitle: Schema2ReasoningEncrypted | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema2reasoningencrypted' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningEncrypted | OpenRouter TypeScript SDK -'og:description': >- - Schema2ReasoningEncrypted method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningEncrypted%20-%20TypeScript%20SDK&description=Schema2ReasoningEncrypted%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Schema2ReasoningEncrypted } from "@openrouter/sdk/models"; - -let value: Schema2ReasoningEncrypted = { - type: "reasoning.encrypted", - data: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `type` | *"reasoning.encrypted"* | :heavy_check_mark: | N/A | -| `data` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `format` | [models.Schema4](/client-sdks/typescript/models/schema4) | :heavy_minus_sign: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/schema2reasoningsummary.mdx b/client-sdks/typescript/models/schema2reasoningsummary.mdx deleted file mode 100644 index eed3bfa5..00000000 --- a/client-sdks/typescript/models/schema2reasoningsummary.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Schema2ReasoningSummary - TypeScript SDK -description: Schema2ReasoningSummary method reference -seoTitle: Schema2ReasoningSummary | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema2reasoningsummary' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningSummary | OpenRouter TypeScript SDK -'og:description': >- - Schema2ReasoningSummary method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningSummary%20-%20TypeScript%20SDK&description=Schema2ReasoningSummary%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Schema2ReasoningSummary } from "@openrouter/sdk/models"; - -let value: Schema2ReasoningSummary = { - type: "reasoning.summary", - summary: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `type` | *"reasoning.summary"* | :heavy_check_mark: | N/A | -| `summary` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `format` | [models.Schema4](/client-sdks/typescript/models/schema4) | :heavy_minus_sign: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/schema2reasoningtext.mdx b/client-sdks/typescript/models/schema2reasoningtext.mdx deleted file mode 100644 index ec5be2b3..00000000 --- a/client-sdks/typescript/models/schema2reasoningtext.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Schema2ReasoningText - TypeScript SDK -description: Schema2ReasoningText method reference -seoTitle: Schema2ReasoningText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema2reasoningtext' -'og:site_name': OpenRouter Documentation -'og:title': Schema2ReasoningText | OpenRouter TypeScript SDK -'og:description': >- - Schema2ReasoningText method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema2ReasoningText%20-%20TypeScript%20SDK&description=Schema2ReasoningText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Schema2ReasoningText } from "@openrouter/sdk/models"; - -let value: Schema2ReasoningText = { - type: "reasoning.text", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `type` | *"reasoning.text"* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_minus_sign: | N/A | -| `signature` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `format` | [models.Schema4](/client-sdks/typescript/models/schema4) | :heavy_minus_sign: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/schema4.mdx b/client-sdks/typescript/models/schema4.mdx deleted file mode 100644 index a046bc85..00000000 --- a/client-sdks/typescript/models/schema4.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Schema4 - TypeScript SDK -description: Schema4 method reference -seoTitle: Schema4 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/schema4' -'og:site_name': OpenRouter Documentation -'og:title': Schema4 | OpenRouter TypeScript SDK -'og:description': >- - Schema4 method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Schema4%20-%20TypeScript%20SDK&description=Schema4%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Schema4 } from "@openrouter/sdk/models"; - -let value: Schema4 = "openai-responses-v1"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"unknown" | "openai-responses-v1" | "azure-openai-responses-v1" | "xai-responses-v1" | "anthropic-claude-v1" | "google-gemini-v1" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/security.mdx b/client-sdks/typescript/models/security.mdx deleted file mode 100644 index d6be5409..00000000 --- a/client-sdks/typescript/models/security.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Security - TypeScript SDK -description: Security method reference -seoTitle: Security | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/security' -'og:site_name': OpenRouter Documentation -'og:title': Security | OpenRouter TypeScript SDK -'og:description': >- - Security method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Security%20-%20TypeScript%20SDK&description=Security%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Security } from "@openrouter/sdk/models"; - -let value: Security = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/servicetier.mdx b/client-sdks/typescript/models/servicetier.mdx deleted file mode 100644 index d0465216..00000000 --- a/client-sdks/typescript/models/servicetier.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ServiceTier - TypeScript SDK -description: ServiceTier method reference -seoTitle: ServiceTier | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/servicetier' -'og:site_name': OpenRouter Documentation -'og:title': ServiceTier | OpenRouter TypeScript SDK -'og:description': >- - ServiceTier method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceTier%20-%20TypeScript%20SDK&description=ServiceTier%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ServiceTier } from "@openrouter/sdk/models"; - -let value: ServiceTier = "auto"; -``` - -## Values - -```typescript lines -"auto" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/serviceunavailableresponseerrordata.mdx b/client-sdks/typescript/models/serviceunavailableresponseerrordata.mdx deleted file mode 100644 index b83527a4..00000000 --- a/client-sdks/typescript/models/serviceunavailableresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ServiceUnavailableResponseErrorData - TypeScript SDK -description: ServiceUnavailableResponseErrorData method reference -seoTitle: ServiceUnavailableResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/serviceunavailableresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': ServiceUnavailableResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - ServiceUnavailableResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ServiceUnavailableResponseErrorData%20-%20TypeScript%20SDK&description=ServiceUnavailableResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for ServiceUnavailableResponse - -## Example Usage - -```typescript lines -import { ServiceUnavailableResponseErrorData } from "@openrouter/sdk/models"; - -let value: ServiceUnavailableResponseErrorData = { - code: 503, - message: "Service temporarily unavailable", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/sortenum.mdx b/client-sdks/typescript/models/sortenum.mdx deleted file mode 100644 index 1e9b056c..00000000 --- a/client-sdks/typescript/models/sortenum.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: SortEnum - TypeScript SDK -description: SortEnum method reference -seoTitle: SortEnum | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/sortenum' -'og:site_name': OpenRouter Documentation -'og:title': SortEnum | OpenRouter TypeScript SDK -'og:description': >- - SortEnum method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SortEnum%20-%20TypeScript%20SDK&description=SortEnum%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SortEnum } from "@openrouter/sdk/models"; - -let value: SortEnum = "throughput"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"price" | "throughput" | "latency" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/streamoptions.mdx b/client-sdks/typescript/models/streamoptions.mdx deleted file mode 100644 index edf52ef4..00000000 --- a/client-sdks/typescript/models/streamoptions.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: StreamOptions - TypeScript SDK -description: StreamOptions method reference -seoTitle: StreamOptions | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/streamoptions' -'og:site_name': OpenRouter Documentation -'og:title': StreamOptions | OpenRouter TypeScript SDK -'og:description': >- - StreamOptions method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=StreamOptions%20-%20TypeScript%20SDK&description=StreamOptions%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { StreamOptions } from "@openrouter/sdk/models"; - -let value: StreamOptions = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `includeUsage` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/systemmessage.mdx b/client-sdks/typescript/models/systemmessage.mdx deleted file mode 100644 index 543539a9..00000000 --- a/client-sdks/typescript/models/systemmessage.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: SystemMessage - TypeScript SDK -description: SystemMessage method reference -seoTitle: SystemMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/systemmessage' -'og:site_name': OpenRouter Documentation -'og:title': SystemMessage | OpenRouter TypeScript SDK -'og:description': >- - SystemMessage method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SystemMessage%20-%20TypeScript%20SDK&description=SystemMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { SystemMessage } from "@openrouter/sdk/models"; - -let value: SystemMessage = { - role: "system", - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `role` | *"system"* | :heavy_check_mark: | N/A | -| `content` | *models.SystemMessageContent* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/systemmessagecontent.mdx b/client-sdks/typescript/models/systemmessagecontent.mdx deleted file mode 100644 index d1fc70b4..00000000 --- a/client-sdks/typescript/models/systemmessagecontent.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: SystemMessageContent - TypeScript SDK -description: SystemMessageContent method reference -seoTitle: SystemMessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/systemmessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': SystemMessageContent | OpenRouter TypeScript SDK -'og:description': >- - SystemMessageContent method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SystemMessageContent%20-%20TypeScript%20SDK&description=SystemMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatMessageContentItemText[]` - -```typescript lines -const value: models.ChatMessageContentItemText[] = [ - { - type: "text", - text: "", - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/tokenizer.mdx b/client-sdks/typescript/models/tokenizer.mdx deleted file mode 100644 index 66417d79..00000000 --- a/client-sdks/typescript/models/tokenizer.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Tokenizer - TypeScript SDK -description: Tokenizer method reference -seoTitle: Tokenizer | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/tokenizer' -'og:site_name': OpenRouter Documentation -'og:title': Tokenizer | OpenRouter TypeScript SDK -'og:description': >- - Tokenizer method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Tokenizer%20-%20TypeScript%20SDK&description=Tokenizer%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Tokenizer type used by the model - -## Example Usage - -```typescript lines -import { Tokenizer } from "@openrouter/sdk/models"; - -let value: Tokenizer = "GPT"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"Router" | "Media" | "Other" | "GPT" | "Claude" | "Gemini" | "Grok" | "Cohere" | "Nova" | "Qwen" | "Yi" | "DeepSeek" | "Mistral" | "Llama2" | "Llama3" | "Llama4" | "PaLM" | "RWKV" | "Qwen3" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/toolcallstatus.mdx b/client-sdks/typescript/models/toolcallstatus.mdx deleted file mode 100644 index dc13f9e0..00000000 --- a/client-sdks/typescript/models/toolcallstatus.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ToolCallStatus - TypeScript SDK -description: ToolCallStatus method reference -seoTitle: ToolCallStatus | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/toolcallstatus' -'og:site_name': OpenRouter Documentation -'og:title': ToolCallStatus | OpenRouter TypeScript SDK -'og:description': >- - ToolCallStatus method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolCallStatus%20-%20TypeScript%20SDK&description=ToolCallStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolCallStatus } from "@openrouter/sdk/models"; - -let value: ToolCallStatus = "completed"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"in_progress" | "completed" | "incomplete" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/tooldefinitionjson.mdx b/client-sdks/typescript/models/tooldefinitionjson.mdx deleted file mode 100644 index e58d2273..00000000 --- a/client-sdks/typescript/models/tooldefinitionjson.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ToolDefinitionJson - TypeScript SDK -description: ToolDefinitionJson method reference -seoTitle: ToolDefinitionJson | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/tooldefinitionjson' -'og:site_name': OpenRouter Documentation -'og:title': ToolDefinitionJson | OpenRouter TypeScript SDK -'og:description': >- - ToolDefinitionJson method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolDefinitionJson%20-%20TypeScript%20SDK&description=ToolDefinitionJson%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolDefinitionJson } from "@openrouter/sdk/models"; - -let value: ToolDefinitionJson = { - type: "function", - function: { - name: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | *"function"* | :heavy_check_mark: | N/A | -| `function` | [models.ToolDefinitionJsonFunction](/client-sdks/typescript/models/tooldefinitionjsonfunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/tooldefinitionjsonfunction.mdx b/client-sdks/typescript/models/tooldefinitionjsonfunction.mdx deleted file mode 100644 index 835bd6f4..00000000 --- a/client-sdks/typescript/models/tooldefinitionjsonfunction.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ToolDefinitionJsonFunction - TypeScript SDK -description: ToolDefinitionJsonFunction method reference -seoTitle: ToolDefinitionJsonFunction | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/tooldefinitionjsonfunction' -'og:site_name': OpenRouter Documentation -'og:title': ToolDefinitionJsonFunction | OpenRouter TypeScript SDK -'og:description': >- - ToolDefinitionJsonFunction method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolDefinitionJsonFunction%20-%20TypeScript%20SDK&description=ToolDefinitionJsonFunction%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolDefinitionJsonFunction } from "@openrouter/sdk/models"; - -let value: ToolDefinitionJsonFunction = { - name: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `parameters` | `Record` | :heavy_minus_sign: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/toolresponsemessage.mdx b/client-sdks/typescript/models/toolresponsemessage.mdx deleted file mode 100644 index 67c5fe6d..00000000 --- a/client-sdks/typescript/models/toolresponsemessage.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ToolResponseMessage - TypeScript SDK -description: ToolResponseMessage method reference -seoTitle: ToolResponseMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/toolresponsemessage' -'og:site_name': OpenRouter Documentation -'og:title': ToolResponseMessage | OpenRouter TypeScript SDK -'og:description': >- - ToolResponseMessage method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolResponseMessage%20-%20TypeScript%20SDK&description=ToolResponseMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ToolResponseMessage } from "@openrouter/sdk/models"; - -let value: ToolResponseMessage = { - role: "tool", - content: [], - toolCallId: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `role` | *"tool"* | :heavy_check_mark: | N/A | -| `content` | *models.ToolResponseMessageContent* | :heavy_check_mark: | N/A | -| `toolCallId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/toolresponsemessagecontent.mdx b/client-sdks/typescript/models/toolresponsemessagecontent.mdx deleted file mode 100644 index 6723b70a..00000000 --- a/client-sdks/typescript/models/toolresponsemessagecontent.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ToolResponseMessageContent - TypeScript SDK -description: ToolResponseMessageContent method reference -seoTitle: ToolResponseMessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/toolresponsemessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': ToolResponseMessageContent | OpenRouter TypeScript SDK -'og:description': >- - ToolResponseMessageContent method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ToolResponseMessageContent%20-%20TypeScript%20SDK&description=ToolResponseMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatMessageContentItem[]` - -```typescript lines -const value: models.ChatMessageContentItem[] = [ - { - type: "image_url", - imageUrl: { - url: "https://pretty-reservation.org", - }, - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/toomanyrequestsresponseerrordata.mdx b/client-sdks/typescript/models/toomanyrequestsresponseerrordata.mdx deleted file mode 100644 index 0636ca49..00000000 --- a/client-sdks/typescript/models/toomanyrequestsresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: TooManyRequestsResponseErrorData - TypeScript SDK -description: TooManyRequestsResponseErrorData method reference -seoTitle: TooManyRequestsResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/toomanyrequestsresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': TooManyRequestsResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - TooManyRequestsResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TooManyRequestsResponseErrorData%20-%20TypeScript%20SDK&description=TooManyRequestsResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for TooManyRequestsResponse - -## Example Usage - -```typescript lines -import { TooManyRequestsResponseErrorData } from "@openrouter/sdk/models"; - -let value: TooManyRequestsResponseErrorData = { - code: 429, - message: "Rate limit exceeded", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/topproviderinfo.mdx b/client-sdks/typescript/models/topproviderinfo.mdx deleted file mode 100644 index 68b4dfdf..00000000 --- a/client-sdks/typescript/models/topproviderinfo.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: TopProviderInfo - TypeScript SDK -description: TopProviderInfo method reference -seoTitle: TopProviderInfo | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/topproviderinfo' -'og:site_name': OpenRouter Documentation -'og:title': TopProviderInfo | OpenRouter TypeScript SDK -'og:description': >- - TopProviderInfo method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TopProviderInfo%20-%20TypeScript%20SDK&description=TopProviderInfo%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Information about the top provider for this model - -## Example Usage - -```typescript lines -import { TopProviderInfo } from "@openrouter/sdk/models"; - -let value: TopProviderInfo = { - isModerated: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `contextLength` | *number* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum completion tokens from the top provider | 4096 | -| `isModerated` | *boolean* | :heavy_check_mark: | Whether the top provider moderates content | true | \ No newline at end of file diff --git a/client-sdks/typescript/models/truncation.mdx b/client-sdks/typescript/models/truncation.mdx deleted file mode 100644 index a12fcd30..00000000 --- a/client-sdks/typescript/models/truncation.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Truncation - TypeScript SDK -description: Truncation method reference -seoTitle: Truncation | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/truncation' -'og:site_name': OpenRouter Documentation -'og:title': Truncation | OpenRouter TypeScript SDK -'og:description': >- - Truncation method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Truncation%20-%20TypeScript%20SDK&description=Truncation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Truncation } from "@openrouter/sdk/models"; - -let value: Truncation = "auto"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"auto" | "disabled" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/ttl.mdx b/client-sdks/typescript/models/ttl.mdx deleted file mode 100644 index 25efc0b3..00000000 --- a/client-sdks/typescript/models/ttl.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Ttl - TypeScript SDK -description: Ttl method reference -seoTitle: Ttl | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/ttl' -'og:site_name': OpenRouter Documentation -'og:title': Ttl | OpenRouter TypeScript SDK -'og:description': >- - Ttl method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Ttl%20-%20TypeScript%20SDK&description=Ttl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Ttl } from "@openrouter/sdk/models"; - -let value: Ttl = "5m"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"5m" | "1h" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/type.mdx b/client-sdks/typescript/models/type.mdx deleted file mode 100644 index 2b30a2ac..00000000 --- a/client-sdks/typescript/models/type.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Type - TypeScript SDK -description: Type method reference -seoTitle: Type | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/type' -'og:site_name': OpenRouter Documentation -'og:title': Type | OpenRouter TypeScript SDK -'og:description': >- - Type method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Type%20-%20TypeScript%20SDK&description=Type%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceTypeWebSearchPreview20250311 = - "web_search_preview_2025_03_11"; -``` - -### `models.OpenAIResponsesToolChoiceTypeWebSearchPreview` - -```typescript lines -const value: models.OpenAIResponsesToolChoiceTypeWebSearchPreview = - "web_search_preview"; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/unauthorizedresponseerrordata.mdx b/client-sdks/typescript/models/unauthorizedresponseerrordata.mdx deleted file mode 100644 index a97fcc08..00000000 --- a/client-sdks/typescript/models/unauthorizedresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: UnauthorizedResponseErrorData - TypeScript SDK -description: UnauthorizedResponseErrorData method reference -seoTitle: UnauthorizedResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/unauthorizedresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnauthorizedResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - UnauthorizedResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnauthorizedResponseErrorData%20-%20TypeScript%20SDK&description=UnauthorizedResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for UnauthorizedResponse - -## Example Usage - -```typescript lines -import { UnauthorizedResponseErrorData } from "@openrouter/sdk/models"; - -let value: UnauthorizedResponseErrorData = { - code: 401, - message: "Missing Authentication header", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/unprocessableentityresponseerrordata.mdx b/client-sdks/typescript/models/unprocessableentityresponseerrordata.mdx deleted file mode 100644 index b8cd20ea..00000000 --- a/client-sdks/typescript/models/unprocessableentityresponseerrordata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: UnprocessableEntityResponseErrorData - TypeScript SDK -description: UnprocessableEntityResponseErrorData method reference -seoTitle: UnprocessableEntityResponseErrorData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/unprocessableentityresponseerrordata -'og:site_name': OpenRouter Documentation -'og:title': UnprocessableEntityResponseErrorData | OpenRouter TypeScript SDK -'og:description': >- - UnprocessableEntityResponseErrorData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UnprocessableEntityResponseErrorData%20-%20TypeScript%20SDK&description=UnprocessableEntityResponseErrorData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Error data for UnprocessableEntityResponse - -## Example Usage - -```typescript lines -import { UnprocessableEntityResponseErrorData } from "@openrouter/sdk/models"; - -let value: UnprocessableEntityResponseErrorData = { - code: 422, - message: "Invalid argument", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | `Record` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/urlcitation.mdx b/client-sdks/typescript/models/urlcitation.mdx deleted file mode 100644 index 9064137d..00000000 --- a/client-sdks/typescript/models/urlcitation.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: URLCitation - TypeScript SDK -description: URLCitation method reference -seoTitle: URLCitation | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/urlcitation' -'og:site_name': OpenRouter Documentation -'og:title': URLCitation | OpenRouter TypeScript SDK -'og:description': >- - URLCitation method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=URLCitation%20-%20TypeScript%20SDK&description=URLCitation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { URLCitation } from "@openrouter/sdk/models"; - -let value: URLCitation = { - type: "url_citation", - url: "https://openrouter.ai/docs", - title: "OpenRouter Documentation", - startIndex: 0, - endIndex: 42, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"url_citation"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/usermessage.mdx b/client-sdks/typescript/models/usermessage.mdx deleted file mode 100644 index e5c4b6ad..00000000 --- a/client-sdks/typescript/models/usermessage.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: UserMessage - TypeScript SDK -description: UserMessage method reference -seoTitle: UserMessage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/usermessage' -'og:site_name': OpenRouter Documentation -'og:title': UserMessage | OpenRouter TypeScript SDK -'og:description': >- - UserMessage method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserMessage%20-%20TypeScript%20SDK&description=UserMessage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UserMessage } from "@openrouter/sdk/models"; - -let value: UserMessage = { - role: "user", - content: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `role` | *"user"* | :heavy_check_mark: | N/A | -| `content` | *models.UserMessageContent* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/usermessagecontent.mdx b/client-sdks/typescript/models/usermessagecontent.mdx deleted file mode 100644 index 6b7ee8ae..00000000 --- a/client-sdks/typescript/models/usermessagecontent.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UserMessageContent - TypeScript SDK -description: UserMessageContent method reference -seoTitle: UserMessageContent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/usermessagecontent' -'og:site_name': OpenRouter Documentation -'og:title': UserMessageContent | OpenRouter TypeScript SDK -'og:description': >- - UserMessageContent method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UserMessageContent%20-%20TypeScript%20SDK&description=UserMessageContent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ChatMessageContentItem[]` - -```typescript lines -const value: models.ChatMessageContentItem[] = [ - { - type: "image_url", - imageUrl: { - url: "https://pretty-reservation.org", - }, - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/variables.mdx b/client-sdks/typescript/models/variables.mdx deleted file mode 100644 index d6ed18f1..00000000 --- a/client-sdks/typescript/models/variables.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Variables - TypeScript SDK -description: Variables method reference -seoTitle: Variables | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/variables' -'og:site_name': OpenRouter Documentation -'og:title': Variables | OpenRouter TypeScript SDK -'og:description': >- - Variables method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Variables%20-%20TypeScript%20SDK&description=Variables%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `models.ResponseInputText` - -```typescript lines -const value: models.ResponseInputText = { - type: "input_text", - text: "Hello, how can I help you?", -}; -``` - -### `models.ResponseInputImage` - -```typescript lines -const value: models.ResponseInputImage = { - type: "input_image", - detail: "auto", -}; -``` - -### `models.ResponseInputFile` - -```typescript lines -const value: models.ResponseInputFile = { - type: "input_file", -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/videourl1.mdx b/client-sdks/typescript/models/videourl1.mdx deleted file mode 100644 index bcce4750..00000000 --- a/client-sdks/typescript/models/videourl1.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: VideoUrl1 - TypeScript SDK -description: VideoUrl1 method reference -seoTitle: VideoUrl1 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/videourl1' -'og:site_name': OpenRouter Documentation -'og:title': VideoUrl1 | OpenRouter TypeScript SDK -'og:description': >- - VideoUrl1 method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoUrl1%20-%20TypeScript%20SDK&description=VideoUrl1%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { VideoUrl1 } from "@openrouter/sdk/models"; - -let value: VideoUrl1 = { - url: "https://colorless-milestone.net/", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/videourl2.mdx b/client-sdks/typescript/models/videourl2.mdx deleted file mode 100644 index ff93e4a1..00000000 --- a/client-sdks/typescript/models/videourl2.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: VideoUrl2 - TypeScript SDK -description: VideoUrl2 method reference -seoTitle: VideoUrl2 | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/videourl2' -'og:site_name': OpenRouter Documentation -'og:title': VideoUrl2 | OpenRouter TypeScript SDK -'og:description': >- - VideoUrl2 method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=VideoUrl2%20-%20TypeScript%20SDK&description=VideoUrl2%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { VideoUrl2 } from "@openrouter/sdk/models"; - -let value: VideoUrl2 = { - url: "https://triangular-soup.info", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/websearchengine.mdx b/client-sdks/typescript/models/websearchengine.mdx deleted file mode 100644 index 0f0d5a06..00000000 --- a/client-sdks/typescript/models/websearchengine.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: WebSearchEngine - TypeScript SDK -description: WebSearchEngine method reference -seoTitle: WebSearchEngine | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/websearchengine' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchEngine | OpenRouter TypeScript SDK -'og:description': >- - WebSearchEngine method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchEngine%20-%20TypeScript%20SDK&description=WebSearchEngine%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The search engine to use for web search. - -## Example Usage - -```typescript lines -import { WebSearchEngine } from "@openrouter/sdk/models"; - -let value: WebSearchEngine = "native"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"native" | "exa" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/websearchpreviewtooluserlocation.mdx b/client-sdks/typescript/models/websearchpreviewtooluserlocation.mdx deleted file mode 100644 index 8fe702ac..00000000 --- a/client-sdks/typescript/models/websearchpreviewtooluserlocation.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: WebSearchPreviewToolUserLocation - TypeScript SDK -description: WebSearchPreviewToolUserLocation method reference -seoTitle: WebSearchPreviewToolUserLocation | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/websearchpreviewtooluserlocation -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPreviewToolUserLocation | OpenRouter TypeScript SDK -'og:description': >- - WebSearchPreviewToolUserLocation method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPreviewToolUserLocation%20-%20TypeScript%20SDK&description=WebSearchPreviewToolUserLocation%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchPreviewToolUserLocation } from "@openrouter/sdk/models"; - -let value: WebSearchPreviewToolUserLocation = { - type: "approximate", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.WebSearchPreviewToolUserLocationType](/client-sdks/typescript/models/websearchpreviewtooluserlocationtype) | :heavy_check_mark: | N/A | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/models/websearchpreviewtooluserlocationtype.mdx b/client-sdks/typescript/models/websearchpreviewtooluserlocationtype.mdx deleted file mode 100644 index d7f1f3b5..00000000 --- a/client-sdks/typescript/models/websearchpreviewtooluserlocationtype.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: WebSearchPreviewToolUserLocationType - TypeScript SDK -description: WebSearchPreviewToolUserLocationType method reference -seoTitle: WebSearchPreviewToolUserLocationType | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/models/websearchpreviewtooluserlocationtype -'og:site_name': OpenRouter Documentation -'og:title': WebSearchPreviewToolUserLocationType | OpenRouter TypeScript SDK -'og:description': >- - WebSearchPreviewToolUserLocationType method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchPreviewToolUserLocationType%20-%20TypeScript%20SDK&description=WebSearchPreviewToolUserLocationType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchPreviewToolUserLocationType } from "@openrouter/sdk/models"; - -let value: WebSearchPreviewToolUserLocationType = "approximate"; -``` - -## Values - -```typescript lines -"approximate" -``` \ No newline at end of file diff --git a/client-sdks/typescript/models/websearchstatus.mdx b/client-sdks/typescript/models/websearchstatus.mdx deleted file mode 100644 index 9f1789f5..00000000 --- a/client-sdks/typescript/models/websearchstatus.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: WebSearchStatus - TypeScript SDK -description: WebSearchStatus method reference -seoTitle: WebSearchStatus | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/models/websearchstatus' -'og:site_name': OpenRouter Documentation -'og:title': WebSearchStatus | OpenRouter TypeScript SDK -'og:description': >- - WebSearchStatus method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=WebSearchStatus%20-%20TypeScript%20SDK&description=WebSearchStatus%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { WebSearchStatus } from "@openrouter/sdk/models"; - -let value: WebSearchStatus = "completed"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"completed" | "searching" | "in_progress" | "failed" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/apitype.mdx b/client-sdks/typescript/operations/apitype.mdx deleted file mode 100644 index 11711fc1..00000000 --- a/client-sdks/typescript/operations/apitype.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ApiType - TypeScript SDK -description: ApiType method reference -seoTitle: ApiType | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/apitype' -'og:site_name': OpenRouter Documentation -'og:title': ApiType | OpenRouter TypeScript SDK -'og:description': >- - ApiType method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ApiType%20-%20TypeScript%20SDK&description=ApiType%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Type of API used for the generation - -## Example Usage - -```typescript lines -import { ApiType } from "@openrouter/sdk/models/operations"; - -let value: ApiType = "embeddings"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"completions" | "embeddings" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignkeystoguardrailrequest.mdx b/client-sdks/typescript/operations/bulkassignkeystoguardrailrequest.mdx deleted file mode 100644 index cfd85b09..00000000 --- a/client-sdks/typescript/operations/bulkassignkeystoguardrailrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequest - TypeScript SDK -description: BulkAssignKeysToGuardrailRequest method reference -seoTitle: BulkAssignKeysToGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignkeystoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysToGuardrailRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequest%20-%20TypeScript%20SDK&description=BulkAssignKeysToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysToGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignKeysToGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - requestBody: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `requestBody` | [operations.BulkAssignKeysToGuardrailRequestBody](/client-sdks/typescript/operations/bulkassignkeystoguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignkeystoguardrailrequestbody.mdx b/client-sdks/typescript/operations/bulkassignkeystoguardrailrequestbody.mdx deleted file mode 100644 index 98e182ec..00000000 --- a/client-sdks/typescript/operations/bulkassignkeystoguardrailrequestbody.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailRequestBody - TypeScript SDK -description: BulkAssignKeysToGuardrailRequestBody method reference -seoTitle: BulkAssignKeysToGuardrailRequestBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignkeystoguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailRequestBody | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysToGuardrailRequestBody method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailRequestBody%20-%20TypeScript%20SDK&description=BulkAssignKeysToGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignKeysToGuardrailRequestBody } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignKeysToGuardrailRequestBody = { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignkeystoguardrailresponse.mdx b/client-sdks/typescript/operations/bulkassignkeystoguardrailresponse.mdx deleted file mode 100644 index fe695ffd..00000000 --- a/client-sdks/typescript/operations/bulkassignkeystoguardrailresponse.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: BulkAssignKeysToGuardrailResponse - TypeScript SDK -description: BulkAssignKeysToGuardrailResponse method reference -seoTitle: BulkAssignKeysToGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignkeystoguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignKeysToGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignKeysToGuardrailResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignKeysToGuardrailResponse%20-%20TypeScript%20SDK&description=BulkAssignKeysToGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Assignment result - -## Example Usage - -```typescript lines -import { BulkAssignKeysToGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignKeysToGuardrailResponse = { - assignedCount: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assignedCount` | *number* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequest.mdx b/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequest.mdx deleted file mode 100644 index 77a1f675..00000000 --- a/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequest.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequest - TypeScript SDK -description: BulkAssignMembersToGuardrailRequest method reference -seoTitle: BulkAssignMembersToGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignmemberstoguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersToGuardrailRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequest%20-%20TypeScript%20SDK&description=BulkAssignMembersToGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersToGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignMembersToGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - requestBody: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `requestBody` | [operations.BulkAssignMembersToGuardrailRequestBody](/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequestbody.mdx b/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequestbody.mdx deleted file mode 100644 index 4be381f5..00000000 --- a/client-sdks/typescript/operations/bulkassignmemberstoguardrailrequestbody.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailRequestBody - TypeScript SDK -description: BulkAssignMembersToGuardrailRequestBody method reference -seoTitle: BulkAssignMembersToGuardrailRequestBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignmemberstoguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailRequestBody | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersToGuardrailRequestBody method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailRequestBody%20-%20TypeScript%20SDK&description=BulkAssignMembersToGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkAssignMembersToGuardrailRequestBody } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignMembersToGuardrailRequestBody = { - memberUserIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkassignmemberstoguardrailresponse.mdx b/client-sdks/typescript/operations/bulkassignmemberstoguardrailresponse.mdx deleted file mode 100644 index 19bcefd4..00000000 --- a/client-sdks/typescript/operations/bulkassignmemberstoguardrailresponse.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: BulkAssignMembersToGuardrailResponse - TypeScript SDK -description: BulkAssignMembersToGuardrailResponse method reference -seoTitle: BulkAssignMembersToGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkassignmemberstoguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkAssignMembersToGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - BulkAssignMembersToGuardrailResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkAssignMembersToGuardrailResponse%20-%20TypeScript%20SDK&description=BulkAssignMembersToGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Assignment result - -## Example Usage - -```typescript lines -import { BulkAssignMembersToGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: BulkAssignMembersToGuardrailResponse = { - assignedCount: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assignedCount` | *number* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequest.mdx b/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequest.mdx deleted file mode 100644 index 722edabc..00000000 --- a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequest.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequest - TypeScript SDK -description: BulkUnassignKeysFromGuardrailRequest method reference -seoTitle: BulkUnassignKeysFromGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignkeysfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequest%20-%20TypeScript%20SDK&description=BulkUnassignKeysFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysFromGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignKeysFromGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - requestBody: { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `requestBody` | [operations.BulkUnassignKeysFromGuardrailRequestBody](/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequestbody.mdx b/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequestbody.mdx deleted file mode 100644 index 0e36e8bb..00000000 --- a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailrequestbody.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailRequestBody - TypeScript SDK -description: BulkUnassignKeysFromGuardrailRequestBody method reference -seoTitle: BulkUnassignKeysFromGuardrailRequestBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignkeysfromguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailRequestBody | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysFromGuardrailRequestBody method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailRequestBody%20-%20TypeScript%20SDK&description=BulkUnassignKeysFromGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignKeysFromGuardrailRequestBody } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignKeysFromGuardrailRequestBody = { - keyHashes: [ - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailresponse.mdx b/client-sdks/typescript/operations/bulkunassignkeysfromguardrailresponse.mdx deleted file mode 100644 index fb099e4a..00000000 --- a/client-sdks/typescript/operations/bulkunassignkeysfromguardrailresponse.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: BulkUnassignKeysFromGuardrailResponse - TypeScript SDK -description: BulkUnassignKeysFromGuardrailResponse method reference -seoTitle: BulkUnassignKeysFromGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignkeysfromguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignKeysFromGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignKeysFromGuardrailResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignKeysFromGuardrailResponse%20-%20TypeScript%20SDK&description=BulkUnassignKeysFromGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unassignment result - -## Example Usage - -```typescript lines -import { BulkUnassignKeysFromGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignKeysFromGuardrailResponse = { - unassignedCount: 3, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequest.mdx b/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequest.mdx deleted file mode 100644 index 9f3aefd6..00000000 --- a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequest.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequest - TypeScript SDK -description: BulkUnassignMembersFromGuardrailRequest method reference -seoTitle: BulkUnassignMembersFromGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignmembersfromguardrailrequest -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequest method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequest%20-%20TypeScript%20SDK&description=BulkUnassignMembersFromGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersFromGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignMembersFromGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - requestBody: { - memberUserIds: [ - "user_abc123", - "user_def456", - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `requestBody` | [operations.BulkUnassignMembersFromGuardrailRequestBody](/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequestbody) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequestbody.mdx b/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequestbody.mdx deleted file mode 100644 index 985690de..00000000 --- a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailrequestbody.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailRequestBody - TypeScript SDK -description: BulkUnassignMembersFromGuardrailRequestBody method reference -seoTitle: BulkUnassignMembersFromGuardrailRequestBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignmembersfromguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailRequestBody | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersFromGuardrailRequestBody method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailRequestBody%20-%20TypeScript%20SDK&description=BulkUnassignMembersFromGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { BulkUnassignMembersFromGuardrailRequestBody } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignMembersFromGuardrailRequestBody = { - memberUserIds: [ - "user_abc123", - "user_def456", - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailresponse.mdx b/client-sdks/typescript/operations/bulkunassignmembersfromguardrailresponse.mdx deleted file mode 100644 index d8c339d9..00000000 --- a/client-sdks/typescript/operations/bulkunassignmembersfromguardrailresponse.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: BulkUnassignMembersFromGuardrailResponse - TypeScript SDK -description: BulkUnassignMembersFromGuardrailResponse method reference -seoTitle: BulkUnassignMembersFromGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/bulkunassignmembersfromguardrailresponse -'og:site_name': OpenRouter Documentation -'og:title': BulkUnassignMembersFromGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - BulkUnassignMembersFromGuardrailResponse method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=BulkUnassignMembersFromGuardrailResponse%20-%20TypeScript%20SDK&description=BulkUnassignMembersFromGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Unassignment result - -## Example Usage - -```typescript lines -import { BulkUnassignMembersFromGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: BulkUnassignMembersFromGuardrailResponse = { - unassignedCount: 2, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/calldata.mdx b/client-sdks/typescript/operations/calldata.mdx deleted file mode 100644 index 0669deaa..00000000 --- a/client-sdks/typescript/operations/calldata.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: CallData - TypeScript SDK -description: CallData method reference -seoTitle: CallData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/calldata' -'og:site_name': OpenRouter Documentation -'og:title': CallData | OpenRouter TypeScript SDK -'og:description': >- - CallData method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CallData%20-%20TypeScript%20SDK&description=CallData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CallData } from "@openrouter/sdk/models/operations"; - -let value: CallData = { - deadline: "", - feeAmount: "", - id: "", - operator: "", - prefix: "", - recipient: "", - recipientAmount: "", - recipientCurrency: "", - refundDestination: "", - signature: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `deadline` | *string* | :heavy_check_mark: | N/A | -| `feeAmount` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `operator` | *string* | :heavy_check_mark: | N/A | -| `prefix` | *string* | :heavy_check_mark: | N/A | -| `recipient` | *string* | :heavy_check_mark: | N/A | -| `recipientAmount` | *string* | :heavy_check_mark: | N/A | -| `recipientCurrency` | *string* | :heavy_check_mark: | N/A | -| `refundDestination` | *string* | :heavy_check_mark: | N/A | -| `signature` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/content.mdx b/client-sdks/typescript/operations/content.mdx deleted file mode 100644 index 35bb0639..00000000 --- a/client-sdks/typescript/operations/content.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Content - TypeScript SDK -description: Content method reference -seoTitle: Content | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/content' -'og:site_name': OpenRouter Documentation -'og:title': Content | OpenRouter TypeScript SDK -'og:description': >- - Content method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Content%20-%20TypeScript%20SDK&description=Content%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.ContentText` - -```typescript lines -const value: operations.ContentText = { - type: "text", - text: "", -}; -``` - -### `operations.ContentImageURL` - -```typescript lines -const value: operations.ContentImageURL = { - type: "image_url", - imageUrl: { - url: "https://zealous-march.biz/", - }, -}; -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/contentimageurl.mdx b/client-sdks/typescript/operations/contentimageurl.mdx deleted file mode 100644 index 427adabb..00000000 --- a/client-sdks/typescript/operations/contentimageurl.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ContentImageURL - TypeScript SDK -description: ContentImageURL method reference -seoTitle: ContentImageURL | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/contentimageurl' -'og:site_name': OpenRouter Documentation -'og:title': ContentImageURL | OpenRouter TypeScript SDK -'og:description': >- - ContentImageURL method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentImageURL%20-%20TypeScript%20SDK&description=ContentImageURL%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentImageURL } from "@openrouter/sdk/models/operations"; - -let value: ContentImageURL = { - type: "image_url", - imageUrl: { - url: "https://zealous-march.biz/", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | -| `imageUrl` | [operations.ImageUrl](/client-sdks/typescript/operations/imageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/contenttext.mdx b/client-sdks/typescript/operations/contenttext.mdx deleted file mode 100644 index 5e6b22ee..00000000 --- a/client-sdks/typescript/operations/contenttext.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ContentText - TypeScript SDK -description: ContentText method reference -seoTitle: ContentText | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/contenttext' -'og:site_name': OpenRouter Documentation -'og:title': ContentText | OpenRouter TypeScript SDK -'og:description': >- - ContentText method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ContentText%20-%20TypeScript%20SDK&description=ContentText%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ContentText } from "@openrouter/sdk/models/operations"; - -let value: ContentText = { - type: "text", - text: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createauthkeyscodecodechallengemethod.mdx b/client-sdks/typescript/operations/createauthkeyscodecodechallengemethod.mdx deleted file mode 100644 index 3dca4b2a..00000000 --- a/client-sdks/typescript/operations/createauthkeyscodecodechallengemethod.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: CreateAuthKeysCodeCodeChallengeMethod - TypeScript SDK -description: CreateAuthKeysCodeCodeChallengeMethod method reference -seoTitle: CreateAuthKeysCodeCodeChallengeMethod | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createauthkeyscodecodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeCodeChallengeMethod | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeCodeChallengeMethod method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeCodeChallengeMethod%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeCodeChallengeMethod } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeCodeChallengeMethod = "S256"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"S256" | "plain" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createauthkeyscodedata.mdx b/client-sdks/typescript/operations/createauthkeyscodedata.mdx deleted file mode 100644 index d0d92ba6..00000000 --- a/client-sdks/typescript/operations/createauthkeyscodedata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateAuthKeysCodeData - TypeScript SDK -description: CreateAuthKeysCodeData method reference -seoTitle: CreateAuthKeysCodeData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createauthkeyscodedata' -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeData | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeData%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Auth code data - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeData } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeData = { - id: "auth_code_xyz789", - appId: 12345, - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | -| `appId` | *number* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createauthkeyscoderequest.mdx b/client-sdks/typescript/operations/createauthkeyscoderequest.mdx deleted file mode 100644 index f4e9f84a..00000000 --- a/client-sdks/typescript/operations/createauthkeyscoderequest.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: CreateAuthKeysCodeRequest - TypeScript SDK -description: CreateAuthKeysCodeRequest method reference -seoTitle: CreateAuthKeysCodeRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createauthkeyscoderequest -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeRequest method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeRequest%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeRequest = { - callbackUrl: "https://myapp.com/auth/callback", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `callbackUrl` | *string* | :heavy_check_mark: | The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed. | https://myapp.com/auth/callback | -| `codeChallenge` | *string* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](/client-sdks/typescript/operations/createauthkeyscodecodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `limit` | *number* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional expiration time for the API key to be created | | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createauthkeyscoderesponse.mdx b/client-sdks/typescript/operations/createauthkeyscoderesponse.mdx deleted file mode 100644 index d49f2a16..00000000 --- a/client-sdks/typescript/operations/createauthkeyscoderesponse.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: CreateAuthKeysCodeResponse - TypeScript SDK -description: CreateAuthKeysCodeResponse method reference -seoTitle: CreateAuthKeysCodeResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createauthkeyscoderesponse -'og:site_name': OpenRouter Documentation -'og:title': CreateAuthKeysCodeResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateAuthKeysCodeResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateAuthKeysCodeResponse%20-%20TypeScript%20SDK&description=CreateAuthKeysCodeResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Successfully created authorization code - -## Example Usage - -```typescript lines -import { CreateAuthKeysCodeResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateAuthKeysCodeResponse = { - data: { - id: "auth_code_xyz789", - appId: 12345, - createdAt: "2025-08-24T10:30:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](/client-sdks/typescript/operations/createauthkeyscodedata) | :heavy_check_mark: | Auth code data | `{"id": "auth_code_xyz789","app_id": 12345,"created_at": "2025-08-24T10:30:00Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createcoinbasechargedata.mdx b/client-sdks/typescript/operations/createcoinbasechargedata.mdx deleted file mode 100644 index a22cc655..00000000 --- a/client-sdks/typescript/operations/createcoinbasechargedata.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: CreateCoinbaseChargeData - TypeScript SDK -description: CreateCoinbaseChargeData method reference -seoTitle: CreateCoinbaseChargeData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createcoinbasechargedata' -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeData | OpenRouter TypeScript SDK -'og:description': >- - CreateCoinbaseChargeData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeData%20-%20TypeScript%20SDK&description=CreateCoinbaseChargeData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { CreateCoinbaseChargeData } from "@openrouter/sdk/models/operations"; - -let value: CreateCoinbaseChargeData = { - id: "", - createdAt: "1730810681036", - expiresAt: "1742058293127", - web3Data: { - transferIntent: { - callData: { - deadline: "", - feeAmount: "", - id: "", - operator: "", - prefix: "", - recipient: "", - recipientAmount: "", - recipientCurrency: "", - refundDestination: "", - signature: "", - }, - metadata: { - chainId: 7497.17, - contractAddress: "", - sender: "", - }, - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `expiresAt` | *string* | :heavy_check_mark: | N/A | -| `web3Data` | [operations.Web3Data](/client-sdks/typescript/operations/web3data) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createcoinbasechargeresponse.mdx b/client-sdks/typescript/operations/createcoinbasechargeresponse.mdx deleted file mode 100644 index 42f68f05..00000000 --- a/client-sdks/typescript/operations/createcoinbasechargeresponse.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: CreateCoinbaseChargeResponse - TypeScript SDK -description: CreateCoinbaseChargeResponse method reference -seoTitle: CreateCoinbaseChargeResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createcoinbasechargeresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateCoinbaseChargeResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeResponse%20-%20TypeScript%20SDK&description=CreateCoinbaseChargeResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns the calldata to fulfill the transaction - -## Example Usage - -```typescript expandable lines -import { CreateCoinbaseChargeResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateCoinbaseChargeResponse = { - data: { - id: "", - createdAt: "1723897831264", - expiresAt: "1744713163031", - web3Data: { - transferIntent: { - callData: { - deadline: "", - feeAmount: "", - id: "", - operator: "", - prefix: "", - recipient: "", - recipientAmount: "", - recipientCurrency: "", - refundDestination: "", - signature: "", - }, - metadata: { - chainId: 7497.17, - contractAddress: "", - sender: "", - }, - }, - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | [operations.CreateCoinbaseChargeData](/client-sdks/typescript/operations/createcoinbasechargedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createcoinbasechargesecurity.mdx b/client-sdks/typescript/operations/createcoinbasechargesecurity.mdx deleted file mode 100644 index ef41ab1a..00000000 --- a/client-sdks/typescript/operations/createcoinbasechargesecurity.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: CreateCoinbaseChargeSecurity - TypeScript SDK -description: CreateCoinbaseChargeSecurity method reference -seoTitle: CreateCoinbaseChargeSecurity | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createcoinbasechargesecurity -'og:site_name': OpenRouter Documentation -'og:title': CreateCoinbaseChargeSecurity | OpenRouter TypeScript SDK -'og:description': >- - CreateCoinbaseChargeSecurity method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateCoinbaseChargeSecurity%20-%20TypeScript%20SDK&description=CreateCoinbaseChargeSecurity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateCoinbaseChargeSecurity } from "@openrouter/sdk/models/operations"; - -let value: CreateCoinbaseChargeSecurity = { - bearer: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createembeddingsdata.mdx b/client-sdks/typescript/operations/createembeddingsdata.mdx deleted file mode 100644 index 8ca59312..00000000 --- a/client-sdks/typescript/operations/createembeddingsdata.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: CreateEmbeddingsData - TypeScript SDK -description: CreateEmbeddingsData method reference -seoTitle: CreateEmbeddingsData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createembeddingsdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsData | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsData%20-%20TypeScript%20SDK&description=CreateEmbeddingsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateEmbeddingsData } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsData = { - object: "embedding", - embedding: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `object` | [operations.ObjectEmbedding](/client-sdks/typescript/operations/objectembedding) | :heavy_check_mark: | N/A | -| `embedding` | *operations.Embedding* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createembeddingsrequest.mdx b/client-sdks/typescript/operations/createembeddingsrequest.mdx deleted file mode 100644 index edd034af..00000000 --- a/client-sdks/typescript/operations/createembeddingsrequest.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateEmbeddingsRequest - TypeScript SDK -description: CreateEmbeddingsRequest method reference -seoTitle: CreateEmbeddingsRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createembeddingsrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsRequest method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsRequest%20-%20TypeScript%20SDK&description=CreateEmbeddingsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateEmbeddingsRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsRequest = { - input: [ - [], - [ - 3849.69, - ], - [], - ], - model: "Model Y", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `input` | *operations.InputUnion* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `encodingFormat` | [operations.EncodingFormat](/client-sdks/typescript/operations/encodingformat) | :heavy_minus_sign: | N/A | -| `dimensions` | *number* | :heavy_minus_sign: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `provider` | [models.ProviderPreferences](/client-sdks/typescript/models/providerpreferences) | :heavy_minus_sign: | Provider routing preferences for the request. | -| `inputType` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createembeddingsresponse.mdx b/client-sdks/typescript/operations/createembeddingsresponse.mdx deleted file mode 100644 index 64a224b3..00000000 --- a/client-sdks/typescript/operations/createembeddingsresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateEmbeddingsResponse - TypeScript SDK -description: CreateEmbeddingsResponse method reference -seoTitle: CreateEmbeddingsResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createembeddingsresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponse%20-%20TypeScript%20SDK&description=CreateEmbeddingsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `operations.CreateEmbeddingsResponseBody` - -```typescript lines -const value: operations.CreateEmbeddingsResponseBody = { - object: "list", - data: [], - model: "Focus", -}; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createembeddingsresponsebody.mdx b/client-sdks/typescript/operations/createembeddingsresponsebody.mdx deleted file mode 100644 index 986bfa22..00000000 --- a/client-sdks/typescript/operations/createembeddingsresponsebody.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: CreateEmbeddingsResponseBody - TypeScript SDK -description: CreateEmbeddingsResponseBody method reference -seoTitle: CreateEmbeddingsResponseBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createembeddingsresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateEmbeddingsResponseBody | OpenRouter TypeScript SDK -'og:description': >- - CreateEmbeddingsResponseBody method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateEmbeddingsResponseBody%20-%20TypeScript%20SDK&description=CreateEmbeddingsResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Embedding response - -## Example Usage - -```typescript lines -import { CreateEmbeddingsResponseBody } from "@openrouter/sdk/models/operations"; - -let value: CreateEmbeddingsResponseBody = { - object: "list", - data: [], - model: "Focus", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `object` | [operations.ObjectT](/client-sdks/typescript/operations/objectt) | :heavy_check_mark: | N/A | -| `data` | [operations.CreateEmbeddingsData](/client-sdks/typescript/operations/createembeddingsdata)[] | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `usage` | [operations.Usage](/client-sdks/typescript/operations/usage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createguardraildata.mdx b/client-sdks/typescript/operations/createguardraildata.mdx deleted file mode 100644 index fc3f2263..00000000 --- a/client-sdks/typescript/operations/createguardraildata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: CreateGuardrailData - TypeScript SDK -description: CreateGuardrailData method reference -seoTitle: CreateGuardrailData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailData | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailData%20-%20TypeScript%20SDK&description=CreateGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The created guardrail - -## Example Usage - -```typescript lines -import { CreateGuardrailData } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailData = { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `resetInterval` | [operations.CreateGuardrailResetIntervalResponse](/client-sdks/typescript/operations/createguardrailresetintervalresponse) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createguardrailrequest.mdx b/client-sdks/typescript/operations/createguardrailrequest.mdx deleted file mode 100644 index 084468bf..00000000 --- a/client-sdks/typescript/operations/createguardrailrequest.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateGuardrailRequest - TypeScript SDK -description: CreateGuardrailRequest method reference -seoTitle: CreateGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailRequest%20-%20TypeScript%20SDK&description=CreateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailRequest = { - name: "My New Guardrail", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 50 | -| `resetInterval` | [operations.CreateGuardrailResetIntervalRequest](/client-sdks/typescript/operations/createguardrailresetintervalrequest) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | false | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createguardrailresetintervalrequest.mdx b/client-sdks/typescript/operations/createguardrailresetintervalrequest.mdx deleted file mode 100644 index 3e652d21..00000000 --- a/client-sdks/typescript/operations/createguardrailresetintervalrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: CreateGuardrailResetIntervalRequest - TypeScript SDK -description: CreateGuardrailResetIntervalRequest method reference -seoTitle: CreateGuardrailResetIntervalRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createguardrailresetintervalrequest -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResetIntervalRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailResetIntervalRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResetIntervalRequest%20-%20TypeScript%20SDK&description=CreateGuardrailResetIntervalRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { CreateGuardrailResetIntervalRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailResetIntervalRequest = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createguardrailresetintervalresponse.mdx b/client-sdks/typescript/operations/createguardrailresetintervalresponse.mdx deleted file mode 100644 index 230dabd9..00000000 --- a/client-sdks/typescript/operations/createguardrailresetintervalresponse.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: CreateGuardrailResetIntervalResponse - TypeScript SDK -description: CreateGuardrailResetIntervalResponse method reference -seoTitle: CreateGuardrailResetIntervalResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createguardrailresetintervalresponse -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResetIntervalResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailResetIntervalResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResetIntervalResponse%20-%20TypeScript%20SDK&description=CreateGuardrailResetIntervalResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { CreateGuardrailResetIntervalResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailResetIntervalResponse = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createguardrailresponse.mdx b/client-sdks/typescript/operations/createguardrailresponse.mdx deleted file mode 100644 index 602987d2..00000000 --- a/client-sdks/typescript/operations/createguardrailresponse.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: CreateGuardrailResponse - TypeScript SDK -description: CreateGuardrailResponse method reference -seoTitle: CreateGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateGuardrailResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateGuardrailResponse%20-%20TypeScript%20SDK&description=CreateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Guardrail created successfully - -## Example Usage - -```typescript lines -import { CreateGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateGuardrailResponse = { - data: { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "My New Guardrail", - createdAt: "2025-08-24T10:30:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateGuardrailData](/client-sdks/typescript/operations/createguardraildata) | :heavy_check_mark: | The created guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createkeysdata.mdx b/client-sdks/typescript/operations/createkeysdata.mdx deleted file mode 100644 index 41b2f1ec..00000000 --- a/client-sdks/typescript/operations/createkeysdata.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: CreateKeysData - TypeScript SDK -description: CreateKeysData method reference -seoTitle: CreateKeysData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createkeysdata' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysData | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysData method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysData%20-%20TypeScript%20SDK&description=CreateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The created API key information - -## Example Usage - -```typescript expandable lines -import { CreateKeysData } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysData = { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createkeyslimitreset.mdx b/client-sdks/typescript/operations/createkeyslimitreset.mdx deleted file mode 100644 index afffa9d2..00000000 --- a/client-sdks/typescript/operations/createkeyslimitreset.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: CreateKeysLimitReset - TypeScript SDK -description: CreateKeysLimitReset method reference -seoTitle: CreateKeysLimitReset | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createkeyslimitreset' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysLimitReset | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysLimitReset method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysLimitReset%20-%20TypeScript%20SDK&description=CreateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { CreateKeysLimitReset } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysLimitReset = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createkeysrequest.mdx b/client-sdks/typescript/operations/createkeysrequest.mdx deleted file mode 100644 index b1c96116..00000000 --- a/client-sdks/typescript/operations/createkeysrequest.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: CreateKeysRequest - TypeScript SDK -description: CreateKeysRequest method reference -seoTitle: CreateKeysRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createkeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysRequest | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysRequest%20-%20TypeScript%20SDK&description=CreateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { CreateKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysRequest = { - name: "My New API Key", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `limit` | *number* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limitReset` | [operations.CreateKeysLimitReset](/client-sdks/typescript/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 | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :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 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/createkeysresponse.mdx b/client-sdks/typescript/operations/createkeysresponse.mdx deleted file mode 100644 index 04b2cf5d..00000000 --- a/client-sdks/typescript/operations/createkeysresponse.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: CreateKeysResponse - TypeScript SDK -description: CreateKeysResponse method reference -seoTitle: CreateKeysResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createkeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateKeysResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateKeysResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateKeysResponse%20-%20TypeScript%20SDK&description=CreateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key created successfully - -## Example Usage - -```typescript expandable lines -import { CreateKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: CreateKeysResponse = { - data: { - hash: - "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", - name: "My New API Key", - label: "My New API Key", - disabled: false, - limit: 50, - limitRemaining: 50, - limitReset: "monthly", - includeByokInLimit: true, - usage: 0, - usageDaily: 0, - usageWeekly: 0, - usageMonthly: 0, - byokUsage: 0, - byokUsageDaily: 0, - byokUsageWeekly: 0, - byokUsageMonthly: 0, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: null, - }, - key: - "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", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateKeysData](/client-sdks/typescript/operations/createkeysdata) | :heavy_check_mark: | The created API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | -| `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/client-sdks/typescript/operations/createresponsesresponse.mdx b/client-sdks/typescript/operations/createresponsesresponse.mdx deleted file mode 100644 index e32fe430..00000000 --- a/client-sdks/typescript/operations/createresponsesresponse.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: CreateResponsesResponse - TypeScript SDK -description: CreateResponsesResponse method reference -seoTitle: CreateResponsesResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/createresponsesresponse' -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponse | OpenRouter TypeScript SDK -'og:description': >- - CreateResponsesResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponse%20-%20TypeScript%20SDK&description=CreateResponsesResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.OpenResponsesNonStreamingResponse` - -```typescript expandable lines -const value: models.OpenResponsesNonStreamingResponse = { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "completed", - completedAt: 288.81, - output: [ - { - id: "msg-abc123", - role: "assistant", - type: "message", - content: [ - { - type: "output_text", - text: "Hello! How can I help you today?", - }, - ], - }, - ], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 1980.95, - frequencyPenalty: 5982.72, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, -}; -``` - -### `EventStream` \ No newline at end of file diff --git a/client-sdks/typescript/operations/createresponsesresponsebody.mdx b/client-sdks/typescript/operations/createresponsesresponsebody.mdx deleted file mode 100644 index 7fb79f97..00000000 --- a/client-sdks/typescript/operations/createresponsesresponsebody.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: CreateResponsesResponseBody - TypeScript SDK -description: CreateResponsesResponseBody method reference -seoTitle: CreateResponsesResponseBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/createresponsesresponsebody -'og:site_name': OpenRouter Documentation -'og:title': CreateResponsesResponseBody | OpenRouter TypeScript SDK -'og:description': >- - CreateResponsesResponseBody method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=CreateResponsesResponseBody%20-%20TypeScript%20SDK&description=CreateResponsesResponseBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Successful response - -## Example Usage - -```typescript expandable lines -import { CreateResponsesResponseBody } from "@openrouter/sdk/models/operations"; - -let value: CreateResponsesResponseBody = { - data: { - type: "response.created", - response: { - id: "resp-abc123", - object: "response", - createdAt: 1704067200, - model: "gpt-4", - status: "in_progress", - completedAt: 8101.12, - output: [], - error: null, - incompleteDetails: null, - temperature: null, - topP: null, - presencePenalty: 8087.26, - frequencyPenalty: 4886.88, - instructions: null, - metadata: null, - tools: [], - toolChoice: "auto", - parallelToolCalls: true, - }, - sequenceNumber: 0, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.OpenResponsesStreamEvent* | :heavy_check_mark: | Union of all possible event types emitted during response streaming | `{"type": "response.created","response": {"id": "resp-abc123","object": "response","created_at": 1704067200,"model": "gpt-4","status": "in_progress","output": [],"tools": [],"tool_choice": "auto","parallel_tool_calls": true,"error": null,"incomplete_details": null,"metadata": null,"instructions": null,"temperature": null,"top_p": null,"max_output_tokens": null}`,
"sequence_number": `0
`} | \ No newline at end of file diff --git a/client-sdks/typescript/operations/deleteguardrailrequest.mdx b/client-sdks/typescript/operations/deleteguardrailrequest.mdx deleted file mode 100644 index afef7ec4..00000000 --- a/client-sdks/typescript/operations/deleteguardrailrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: DeleteGuardrailRequest - TypeScript SDK -description: DeleteGuardrailRequest method reference -seoTitle: DeleteGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/deleteguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - DeleteGuardrailRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailRequest%20-%20TypeScript%20SDK&description=DeleteGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/deleteguardrailresponse.mdx b/client-sdks/typescript/operations/deleteguardrailresponse.mdx deleted file mode 100644 index 8b4fe7ca..00000000 --- a/client-sdks/typescript/operations/deleteguardrailresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteGuardrailResponse - TypeScript SDK -description: DeleteGuardrailResponse method reference -seoTitle: DeleteGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/deleteguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - DeleteGuardrailResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteGuardrailResponse%20-%20TypeScript%20SDK&description=DeleteGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Guardrail deleted successfully - -## Example Usage - -```typescript lines -import { DeleteGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: DeleteGuardrailResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/client-sdks/typescript/operations/deletekeysrequest.mdx b/client-sdks/typescript/operations/deletekeysrequest.mdx deleted file mode 100644 index 3d073569..00000000 --- a/client-sdks/typescript/operations/deletekeysrequest.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: DeleteKeysRequest - TypeScript SDK -description: DeleteKeysRequest method reference -seoTitle: DeleteKeysRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/deletekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysRequest | OpenRouter TypeScript SDK -'og:description': >- - DeleteKeysRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysRequest%20-%20TypeScript%20SDK&description=DeleteKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { DeleteKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: DeleteKeysRequest = { - hash: - "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", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to delete | 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 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/deletekeysresponse.mdx b/client-sdks/typescript/operations/deletekeysresponse.mdx deleted file mode 100644 index 241e550e..00000000 --- a/client-sdks/typescript/operations/deletekeysresponse.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: DeleteKeysResponse - TypeScript SDK -description: DeleteKeysResponse method reference -seoTitle: DeleteKeysResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/deletekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': DeleteKeysResponse | OpenRouter TypeScript SDK -'og:description': >- - DeleteKeysResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=DeleteKeysResponse%20-%20TypeScript%20SDK&description=DeleteKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key deleted successfully - -## Example Usage - -```typescript lines -import { DeleteKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: DeleteKeysResponse = { - deleted: true, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/client-sdks/typescript/operations/embedding.mdx b/client-sdks/typescript/operations/embedding.mdx deleted file mode 100644 index 9ef8f8ec..00000000 --- a/client-sdks/typescript/operations/embedding.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Embedding - TypeScript SDK -description: Embedding method reference -seoTitle: Embedding | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/embedding' -'og:site_name': OpenRouter Documentation -'og:title': Embedding | OpenRouter TypeScript SDK -'og:description': >- - Embedding method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Embedding%20-%20TypeScript%20SDK&description=Embedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `number[]` - -```typescript lines -const value: number[] = [ - 3390.48, - 1336.21, - 9437.99, -]; -``` - -### `string` - -```typescript lines -const value: string = ""; -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/encodingformat.mdx b/client-sdks/typescript/operations/encodingformat.mdx deleted file mode 100644 index 78146e33..00000000 --- a/client-sdks/typescript/operations/encodingformat.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: EncodingFormat - TypeScript SDK -description: EncodingFormat method reference -seoTitle: EncodingFormat | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/encodingformat' -'og:site_name': OpenRouter Documentation -'og:title': EncodingFormat | OpenRouter TypeScript SDK -'og:description': >- - EncodingFormat method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=EncodingFormat%20-%20TypeScript%20SDK&description=EncodingFormat%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { EncodingFormat } from "@openrouter/sdk/models/operations"; - -let value: EncodingFormat = "float"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"float" | "base64" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/exchangeauthcodeforapikeycodechallengemethod.mdx b/client-sdks/typescript/operations/exchangeauthcodeforapikeycodechallengemethod.mdx deleted file mode 100644 index 13c493fd..00000000 --- a/client-sdks/typescript/operations/exchangeauthcodeforapikeycodechallengemethod.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyCodeChallengeMethod - TypeScript SDK -description: ExchangeAuthCodeForAPIKeyCodeChallengeMethod method reference -seoTitle: ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/exchangeauthcodeforapikeycodechallengemethod -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyCodeChallengeMethod | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyCodeChallengeMethod method documentation for the - OpenRouter TypeScript SDK. Learn how to use this API endpoint with code - examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyCodeChallengeMethod%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The method used to generate the code challenge - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyCodeChallengeMethod } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyCodeChallengeMethod = "S256"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"S256" | "plain" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/exchangeauthcodeforapikeyrequest.mdx b/client-sdks/typescript/operations/exchangeauthcodeforapikeyrequest.mdx deleted file mode 100644 index 1188bce4..00000000 --- a/client-sdks/typescript/operations/exchangeauthcodeforapikeyrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyRequest - TypeScript SDK -description: ExchangeAuthCodeForAPIKeyRequest method reference -seoTitle: ExchangeAuthCodeForAPIKeyRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/exchangeauthcodeforapikeyrequest -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyRequest | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyRequest%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyRequest = { - code: "auth_code_abc123def456", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *string* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `codeVerifier` | *string* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | -| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](/client-sdks/typescript/operations/exchangeauthcodeforapikeycodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/exchangeauthcodeforapikeyresponse.mdx b/client-sdks/typescript/operations/exchangeauthcodeforapikeyresponse.mdx deleted file mode 100644 index 3ab08e68..00000000 --- a/client-sdks/typescript/operations/exchangeauthcodeforapikeyresponse.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ExchangeAuthCodeForAPIKeyResponse - TypeScript SDK -description: ExchangeAuthCodeForAPIKeyResponse method reference -seoTitle: ExchangeAuthCodeForAPIKeyResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/exchangeauthcodeforapikeyresponse -'og:site_name': OpenRouter Documentation -'og:title': ExchangeAuthCodeForAPIKeyResponse | OpenRouter TypeScript SDK -'og:description': >- - ExchangeAuthCodeForAPIKeyResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ExchangeAuthCodeForAPIKeyResponse%20-%20TypeScript%20SDK&description=ExchangeAuthCodeForAPIKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Successfully exchanged code for an API key - -## Example Usage - -```typescript lines -import { ExchangeAuthCodeForAPIKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: ExchangeAuthCodeForAPIKeyResponse = { - key: - "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", - userId: "user_2yOPcMpKoQhcd4bVgSMlELRaIah", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `userId` | *string* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getcreditsdata.mdx b/client-sdks/typescript/operations/getcreditsdata.mdx deleted file mode 100644 index 09c67bb5..00000000 --- a/client-sdks/typescript/operations/getcreditsdata.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: GetCreditsData - TypeScript SDK -description: GetCreditsData method reference -seoTitle: GetCreditsData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getcreditsdata' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsData | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsData method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsData%20-%20TypeScript%20SDK&description=GetCreditsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetCreditsData } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsData = { - totalCredits: 100.5, - totalUsage: 25.75, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `totalCredits` | *number* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `totalUsage` | *number* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getcreditsresponse.mdx b/client-sdks/typescript/operations/getcreditsresponse.mdx deleted file mode 100644 index a42305f5..00000000 --- a/client-sdks/typescript/operations/getcreditsresponse.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: GetCreditsResponse - TypeScript SDK -description: GetCreditsResponse method reference -seoTitle: GetCreditsResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getcreditsresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetCreditsResponse | OpenRouter TypeScript SDK -'og:description': >- - GetCreditsResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCreditsResponse%20-%20TypeScript%20SDK&description=GetCreditsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Total credits purchased and used - -## Example Usage - -```typescript lines -import { GetCreditsResponse } from "@openrouter/sdk/models/operations"; - -let value: GetCreditsResponse = { - data: { - totalCredits: 100.5, - totalUsage: 25.75, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.GetCreditsData](/client-sdks/typescript/operations/getcreditsdata) | :heavy_check_mark: | N/A | `{"total_credits": 100.5,"total_usage": 25.75}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getcurrentkeydata.mdx b/client-sdks/typescript/operations/getcurrentkeydata.mdx deleted file mode 100644 index f00d305f..00000000 --- a/client-sdks/typescript/operations/getcurrentkeydata.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: GetCurrentKeyData - TypeScript SDK -description: GetCurrentKeyData method reference -seoTitle: GetCurrentKeyData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getcurrentkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyData | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyData%20-%20TypeScript%20SDK&description=GetCurrentKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Current API key information - -## Example Usage - -```typescript expandable lines -import { GetCurrentKeyData } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyData = { - label: "sk-or-v1-au78b3456789012345678901234567890", - limit: 100, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - isFreeTier: false, - isProvisioningKey: false, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - rateLimit: { - requests: 1000, - interval: "1h", - note: "This field is deprecated and safe to ignore.", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | 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 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `isFreeTier` | *boolean* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `isProvisioningKey` | *boolean* | :heavy_check_mark: | Whether this is a provisioning key | false | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| ~~`rateLimit`~~ | [operations.RateLimit](/client-sdks/typescript/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. | `{"requests": 1000,"interval": "1h","note": "This field is deprecated and safe to ignore."}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getcurrentkeyresponse.mdx b/client-sdks/typescript/operations/getcurrentkeyresponse.mdx deleted file mode 100644 index 344a47b7..00000000 --- a/client-sdks/typescript/operations/getcurrentkeyresponse.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: GetCurrentKeyResponse - TypeScript SDK -description: GetCurrentKeyResponse method reference -seoTitle: GetCurrentKeyResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getcurrentkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetCurrentKeyResponse | OpenRouter TypeScript SDK -'og:description': >- - GetCurrentKeyResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetCurrentKeyResponse%20-%20TypeScript%20SDK&description=GetCurrentKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key details - -## Example Usage - -```typescript expandable lines -import { GetCurrentKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: GetCurrentKeyResponse = { - data: { - label: "sk-or-v1-au78b3456789012345678901234567890", - limit: 100, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - isFreeTier: false, - isProvisioningKey: false, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - rateLimit: { - requests: 1000, - interval: "1h", - note: "This field is deprecated and safe to ignore.", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetCurrentKeyData](/client-sdks/typescript/operations/getcurrentkeydata) | :heavy_check_mark: | Current API key information | `{"label": "sk-or-v1-au78b3456789012345678901234567890","limit": 100,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"is_free_tier": false,"is_provisioning_key": false,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"expires_at": "2027-12-31T23:59:59Z","rate_limit": {"requests": 1000,"interval": "1h","note": "This field is deprecated and safe to ignore."}`
} | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getgenerationdata.mdx b/client-sdks/typescript/operations/getgenerationdata.mdx deleted file mode 100644 index e5966801..00000000 --- a/client-sdks/typescript/operations/getgenerationdata.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: GetGenerationData - TypeScript SDK -description: GetGenerationData method reference -seoTitle: GetGenerationData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getgenerationdata' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationData | OpenRouter TypeScript SDK -'og:description': >- - GetGenerationData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationData%20-%20TypeScript%20SDK&description=GetGenerationData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Generation data - -## Example Usage - -```typescript expandable lines -import { GetGenerationData } from "@openrouter/sdk/models/operations"; - -let value: GetGenerationData = { - id: "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", - upstreamId: "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", - totalCost: 0.0015, - cacheDiscount: 0.0002, - upstreamInferenceCost: 0.0012, - createdAt: "2024-07-15T23:33:19.433273+00:00", - model: "sao10k/l3-stheno-8b", - appId: 12345, - streamed: true, - cancelled: false, - providerName: "Infermatic", - latency: 1250, - moderationLatency: 50, - generationTime: 1200, - finishReason: "stop", - tokensPrompt: 10, - tokensCompletion: 25, - nativeTokensPrompt: 10, - nativeTokensCompletion: 25, - nativeTokensCompletionImages: 0, - nativeTokensReasoning: 5, - nativeTokensCached: 3, - numMediaPrompt: 1, - numInputAudioPrompt: 0, - numMediaCompletion: 0, - numSearchResults: 5, - origin: "https://openrouter.ai/", - usage: 0.0015, - isByok: false, - nativeFinishReason: "stop", - externalUser: "user-123", - apiType: "completions", - router: "openrouter/auto", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `upstreamId` | *string* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `totalCost` | *number* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `cacheDiscount` | *number* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `upstreamInferenceCost` | *number* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `model` | *string* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `appId` | *number* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `streamed` | *boolean* | :heavy_check_mark: | Whether the response was streamed | true | -| `cancelled` | *boolean* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `latency` | *number* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `moderationLatency` | *number* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `generationTime` | *number* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `finishReason` | *string* | :heavy_check_mark: | Reason the generation finished | stop | -| `tokensPrompt` | *number* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `tokensCompletion` | *number* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `nativeTokensPrompt` | *number* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `nativeTokensCompletion` | *number* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `nativeTokensCompletionImages` | *number* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `nativeTokensReasoning` | *number* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `nativeTokensCached` | *number* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `numMediaPrompt` | *number* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `numInputAudioPrompt` | *number* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `numMediaCompletion` | *number* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `numSearchResults` | *number* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *string* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `usage` | *number* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `isByok` | *boolean* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `nativeFinishReason` | *string* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `externalUser` | *string* | :heavy_check_mark: | External user identifier | user-123 | -| `apiType` | [operations.ApiType](/client-sdks/typescript/operations/apitype) | :heavy_check_mark: | Type of API used for the generation | | -| `router` | *string* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getgenerationrequest.mdx b/client-sdks/typescript/operations/getgenerationrequest.mdx deleted file mode 100644 index cc271a29..00000000 --- a/client-sdks/typescript/operations/getgenerationrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: GetGenerationRequest - TypeScript SDK -description: GetGenerationRequest method reference -seoTitle: GetGenerationRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getgenerationrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationRequest | OpenRouter TypeScript SDK -'og:description': >- - GetGenerationRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationRequest%20-%20TypeScript%20SDK&description=GetGenerationRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGenerationRequest } from "@openrouter/sdk/models/operations"; - -let value: GetGenerationRequest = { - id: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getgenerationresponse.mdx b/client-sdks/typescript/operations/getgenerationresponse.mdx deleted file mode 100644 index ebe8f600..00000000 --- a/client-sdks/typescript/operations/getgenerationresponse.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: GetGenerationResponse - TypeScript SDK -description: GetGenerationResponse method reference -seoTitle: GetGenerationResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getgenerationresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetGenerationResponse | OpenRouter TypeScript SDK -'og:description': >- - GetGenerationResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGenerationResponse%20-%20TypeScript%20SDK&description=GetGenerationResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Generation response - -## Example Usage - -```typescript expandable lines -import { GetGenerationResponse } from "@openrouter/sdk/models/operations"; - -let value: GetGenerationResponse = { - data: { - id: "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG", - upstreamId: "chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946", - totalCost: 0.0015, - cacheDiscount: 0.0002, - upstreamInferenceCost: 0.0012, - createdAt: "2024-07-15T23:33:19.433273+00:00", - model: "sao10k/l3-stheno-8b", - appId: 12345, - streamed: true, - cancelled: false, - providerName: "Infermatic", - latency: 1250, - moderationLatency: 50, - generationTime: 1200, - finishReason: "stop", - tokensPrompt: 10, - tokensCompletion: 25, - nativeTokensPrompt: 10, - nativeTokensCompletion: 25, - nativeTokensCompletionImages: 0, - nativeTokensReasoning: 5, - nativeTokensCached: 3, - numMediaPrompt: 1, - numInputAudioPrompt: 0, - numMediaCompletion: 0, - numSearchResults: 5, - origin: "https://openrouter.ai/", - usage: 0.0015, - isByok: false, - nativeFinishReason: "stop", - externalUser: "user-123", - apiType: null, - router: "openrouter/auto", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `data` | [operations.GetGenerationData](/client-sdks/typescript/operations/getgenerationdata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getguardraildata.mdx b/client-sdks/typescript/operations/getguardraildata.mdx deleted file mode 100644 index bd289384..00000000 --- a/client-sdks/typescript/operations/getguardraildata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: GetGuardrailData - TypeScript SDK -description: GetGuardrailData method reference -seoTitle: GetGuardrailData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailData | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailData method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailData%20-%20TypeScript%20SDK&description=GetGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The guardrail - -## Example Usage - -```typescript lines -import { GetGuardrailData } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailData = { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `resetInterval` | [operations.GetGuardrailResetInterval](/client-sdks/typescript/operations/getguardrailresetinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getguardrailrequest.mdx b/client-sdks/typescript/operations/getguardrailrequest.mdx deleted file mode 100644 index 81d1ba4a..00000000 --- a/client-sdks/typescript/operations/getguardrailrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: GetGuardrailRequest - TypeScript SDK -description: GetGuardrailRequest method reference -seoTitle: GetGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailRequest%20-%20TypeScript%20SDK&description=GetGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getguardrailresetinterval.mdx b/client-sdks/typescript/operations/getguardrailresetinterval.mdx deleted file mode 100644 index ca0b073d..00000000 --- a/client-sdks/typescript/operations/getguardrailresetinterval.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: GetGuardrailResetInterval - TypeScript SDK -description: GetGuardrailResetInterval method reference -seoTitle: GetGuardrailResetInterval | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/getguardrailresetinterval -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResetInterval | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailResetInterval method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResetInterval%20-%20TypeScript%20SDK&description=GetGuardrailResetInterval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { GetGuardrailResetInterval } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailResetInterval = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/getguardrailresponse.mdx b/client-sdks/typescript/operations/getguardrailresponse.mdx deleted file mode 100644 index cf69212c..00000000 --- a/client-sdks/typescript/operations/getguardrailresponse.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: GetGuardrailResponse - TypeScript SDK -description: GetGuardrailResponse method reference -seoTitle: GetGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - GetGuardrailResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetGuardrailResponse%20-%20TypeScript%20SDK&description=GetGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Guardrail details - -## Example Usage - -```typescript lines -import { GetGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: GetGuardrailResponse = { - data: { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetGuardrailData](/client-sdks/typescript/operations/getguardraildata) | :heavy_check_mark: | The guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getkeydata.mdx b/client-sdks/typescript/operations/getkeydata.mdx deleted file mode 100644 index 90668cb1..00000000 --- a/client-sdks/typescript/operations/getkeydata.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: GetKeyData - TypeScript SDK -description: GetKeyData method reference -seoTitle: GetKeyData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getkeydata' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyData | OpenRouter TypeScript SDK -'og:description': >- - GetKeyData method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyData%20-%20TypeScript%20SDK&description=GetKeyData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The API key information - -## Example Usage - -```typescript expandable lines -import { GetKeyData } from "@openrouter/sdk/models/operations"; - -let value: GetKeyData = { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getkeyrequest.mdx b/client-sdks/typescript/operations/getkeyrequest.mdx deleted file mode 100644 index 537189d1..00000000 --- a/client-sdks/typescript/operations/getkeyrequest.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: GetKeyRequest - TypeScript SDK -description: GetKeyRequest method reference -seoTitle: GetKeyRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getkeyrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyRequest | OpenRouter TypeScript SDK -'og:description': >- - GetKeyRequest method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyRequest%20-%20TypeScript%20SDK&description=GetKeyRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetKeyRequest } from "@openrouter/sdk/models/operations"; - -let value: GetKeyRequest = { - hash: - "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", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to retrieve | 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 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getkeyresponse.mdx b/client-sdks/typescript/operations/getkeyresponse.mdx deleted file mode 100644 index 3ef8ae0a..00000000 --- a/client-sdks/typescript/operations/getkeyresponse.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: GetKeyResponse - TypeScript SDK -description: GetKeyResponse method reference -seoTitle: GetKeyResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getkeyresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetKeyResponse | OpenRouter TypeScript SDK -'og:description': >- - GetKeyResponse method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetKeyResponse%20-%20TypeScript%20SDK&description=GetKeyResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key details - -## Example Usage - -```typescript expandable lines -import { GetKeyResponse } from "@openrouter/sdk/models/operations"; - -let value: GetKeyResponse = { - data: { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetKeyData](/client-sdks/typescript/operations/getkeydata) | :heavy_check_mark: | The API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getmodelsrequest.mdx b/client-sdks/typescript/operations/getmodelsrequest.mdx deleted file mode 100644 index b2a42de6..00000000 --- a/client-sdks/typescript/operations/getmodelsrequest.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: GetModelsRequest - TypeScript SDK -description: GetModelsRequest method reference -seoTitle: GetModelsRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getmodelsrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetModelsRequest | OpenRouter TypeScript SDK -'og:description': >- - GetModelsRequest method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetModelsRequest%20-%20TypeScript%20SDK&description=GetModelsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetModelsRequest } from "@openrouter/sdk/models/operations"; - -let value: GetModelsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `category` | *string* | :heavy_minus_sign: | N/A | -| `supportedParameters` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getuseractivityrequest.mdx b/client-sdks/typescript/operations/getuseractivityrequest.mdx deleted file mode 100644 index 4b8de68e..00000000 --- a/client-sdks/typescript/operations/getuseractivityrequest.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: GetUserActivityRequest - TypeScript SDK -description: GetUserActivityRequest method reference -seoTitle: GetUserActivityRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getuseractivityrequest' -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityRequest | OpenRouter TypeScript SDK -'og:description': >- - GetUserActivityRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityRequest%20-%20TypeScript%20SDK&description=GetUserActivityRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { GetUserActivityRequest } from "@openrouter/sdk/models/operations"; - -let value: GetUserActivityRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `date` | *string* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/getuseractivityresponse.mdx b/client-sdks/typescript/operations/getuseractivityresponse.mdx deleted file mode 100644 index 7c80d74d..00000000 --- a/client-sdks/typescript/operations/getuseractivityresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: GetUserActivityResponse - TypeScript SDK -description: GetUserActivityResponse method reference -seoTitle: GetUserActivityResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/getuseractivityresponse' -'og:site_name': OpenRouter Documentation -'og:title': GetUserActivityResponse | OpenRouter TypeScript SDK -'og:description': >- - GetUserActivityResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=GetUserActivityResponse%20-%20TypeScript%20SDK&description=GetUserActivityResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns user activity data grouped by endpoint - -## Example Usage - -```typescript lines -import { GetUserActivityResponse } from "@openrouter/sdk/models/operations"; - -let value: GetUserActivityResponse = { - data: [ - { - date: "2025-08-24", - model: "openai/gpt-4.1", - modelPermaslug: "openai/gpt-4.1-2025-04-14", - endpointId: "550e8400-e29b-41d4-a716-446655440000", - providerName: "OpenAI", - usage: 0.015, - byokUsageInference: 0.012, - requests: 5, - promptTokens: 50, - completionTokens: 125, - reasoningTokens: 25, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `data` | [models.ActivityItem](/client-sdks/typescript/models/activityitem)[] | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/client-sdks/typescript/operations/imageurl.mdx b/client-sdks/typescript/operations/imageurl.mdx deleted file mode 100644 index f22f51fa..00000000 --- a/client-sdks/typescript/operations/imageurl.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ImageUrl - TypeScript SDK -description: ImageUrl method reference -seoTitle: ImageUrl | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/imageurl' -'og:site_name': OpenRouter Documentation -'og:title': ImageUrl | OpenRouter TypeScript SDK -'og:description': >- - ImageUrl method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ImageUrl%20-%20TypeScript%20SDK&description=ImageUrl%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ImageUrl } from "@openrouter/sdk/models/operations"; - -let value: ImageUrl = { - url: "https://sinful-meal.biz", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/input.mdx b/client-sdks/typescript/operations/input.mdx deleted file mode 100644 index c7187a89..00000000 --- a/client-sdks/typescript/operations/input.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Input - TypeScript SDK -description: Input method reference -seoTitle: Input | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/input' -'og:site_name': OpenRouter Documentation -'og:title': Input | OpenRouter TypeScript SDK -'og:description': >- - Input method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Input%20-%20TypeScript%20SDK&description=Input%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Input } from "@openrouter/sdk/models/operations"; - -let value: Input = { - content: [], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `content` | *operations.Content*[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/inputunion.mdx b/client-sdks/typescript/operations/inputunion.mdx deleted file mode 100644 index c3125188..00000000 --- a/client-sdks/typescript/operations/inputunion.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: InputUnion - TypeScript SDK -description: InputUnion method reference -seoTitle: InputUnion | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/inputunion' -'og:site_name': OpenRouter Documentation -'og:title': InputUnion | OpenRouter TypeScript SDK -'og:description': >- - InputUnion method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=InputUnion%20-%20TypeScript%20SDK&description=InputUnion%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `string` - -```typescript lines -const value: string = ""; -``` - -### `string[]` - -```typescript lines -const value: string[] = [ - "", - "", -]; -``` - -### `number[]` - -```typescript lines -const value: number[] = [ - 3390.48, - 1336.21, - 9437.99, -]; -``` - -### `number[][]` - -```typescript lines -const value: number[][] = [ - [ - 6206.15, - ], - [ - 8419.72, - 5863.71, - ], - [ - 2540.22, - ], -]; -``` - -### `operations.Input[]` - -```typescript lines -const value: operations.Input[] = [ - { - content: [], - }, -]; -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/listdata.mdx b/client-sdks/typescript/operations/listdata.mdx deleted file mode 100644 index b020dc05..00000000 --- a/client-sdks/typescript/operations/listdata.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: ListData - TypeScript SDK -description: ListData method reference -seoTitle: ListData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listdata' -'og:site_name': OpenRouter Documentation -'og:title': ListData | OpenRouter TypeScript SDK -'og:description': >- - ListData method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListData%20-%20TypeScript%20SDK&description=ListData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { ListData } from "@openrouter/sdk/models/operations"; - -let value: ListData = { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listendpointsrequest.mdx b/client-sdks/typescript/operations/listendpointsrequest.mdx deleted file mode 100644 index 4e6f62e4..00000000 --- a/client-sdks/typescript/operations/listendpointsrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: ListEndpointsRequest - TypeScript SDK -description: ListEndpointsRequest method reference -seoTitle: ListEndpointsRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listendpointsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsRequest%20-%20TypeScript%20SDK&description=ListEndpointsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListEndpointsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsRequest = { - author: "", - slug: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `author` | *string* | :heavy_check_mark: | N/A | -| `slug` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listendpointsresponse.mdx b/client-sdks/typescript/operations/listendpointsresponse.mdx deleted file mode 100644 index 07cd96dd..00000000 --- a/client-sdks/typescript/operations/listendpointsresponse.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: ListEndpointsResponse - TypeScript SDK -description: ListEndpointsResponse method reference -seoTitle: ListEndpointsResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listendpointsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsResponse%20-%20TypeScript%20SDK&description=ListEndpointsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Example Usage - -```typescript expandable lines -import { ListEndpointsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsResponse = { - data: { - id: "openai/gpt-4", - name: "GPT-4", - created: 1692901234, - description: - "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.", - architecture: { - tokenizer: "GPT", - instructType: "chatml", - modality: "text->text", - inputModalities: [ - "text", - ], - outputModalities: [ - "text", - ], - }, - endpoints: [ - { - name: "OpenAI: GPT-4", - modelName: "GPT-4", - contextLength: 8192, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - providerName: "OpenAI", - tag: "openai", - quantization: "fp16", - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - "frequency_penalty", - "presence_penalty", - ], - uptimeLast30m: 99.5, - supportsImplicitCaching: true, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - }, - ], - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ListEndpointsResponse](/client-sdks/typescript/models/listendpointsresponse) | :heavy_check_mark: | List of available endpoints for a model | `{"id": "openai/gpt-4","name": "GPT-4","created": 1692901234,"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.","architecture": {"tokenizer": "GPT","instruct_type": "chatml","modality": "text-\u003etext","input_modalities": ["text"],"output_modalities": ["text"]}`,
"endpoints": [
`{"name": "OpenAI: GPT-4","model_name": "GPT-4","context_length": 8192,"pricing": {"prompt": "0.00003","completion": "0.00006","request": "0","image": "0"}`,
"provider_name": "OpenAI",
"tag": "openai",
"quantization": "fp16",
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"status": "default",
"uptime_last_30m": 99.5,
"supports_implicit_caching": true,
"latency_last_30m": `{"p50": 0.25,"p75": 0.35,"p90": 0.48,"p99": 0.85}`,
"throughput_last_30m": `{"p50": 45.2,"p75": 38.5,"p90": 28.3,"p99": 15.1}`
}
]
} | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listendpointszdrresponse.mdx b/client-sdks/typescript/operations/listendpointszdrresponse.mdx deleted file mode 100644 index 16a8bc97..00000000 --- a/client-sdks/typescript/operations/listendpointszdrresponse.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: ListEndpointsZdrResponse - TypeScript SDK -description: ListEndpointsZdrResponse method reference -seoTitle: ListEndpointsZdrResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listendpointszdrresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListEndpointsZdrResponse | OpenRouter TypeScript SDK -'og:description': >- - ListEndpointsZdrResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListEndpointsZdrResponse%20-%20TypeScript%20SDK&description=ListEndpointsZdrResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of endpoints - -## Example Usage - -```typescript expandable lines -import { ListEndpointsZdrResponse } from "@openrouter/sdk/models/operations"; - -let value: ListEndpointsZdrResponse = { - data: [ - { - name: "OpenAI: GPT-4", - modelName: "GPT-4", - contextLength: 8192, - pricing: { - prompt: "0.00003", - completion: "0.00006", - }, - providerName: "OpenAI", - tag: "openai", - quantization: "fp16", - maxCompletionTokens: 4096, - maxPromptTokens: 8192, - supportedParameters: [ - "temperature", - "top_p", - "max_tokens", - ], - uptimeLast30m: 99.5, - supportsImplicitCaching: true, - latencyLast30m: { - p50: 0.25, - p75: 0.35, - p90: 0.48, - p99: 0.85, - }, - throughputLast30m: { - p50: 45.2, - p75: 38.5, - p90: 28.3, - p99: 15.1, - }, - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `data` | [models.PublicEndpoint](/client-sdks/typescript/models/publicendpoint)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailkeyassignmentsdata.mdx b/client-sdks/typescript/operations/listguardrailkeyassignmentsdata.mdx deleted file mode 100644 index 9e0ec60d..00000000 --- a/client-sdks/typescript/operations/listguardrailkeyassignmentsdata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsData - TypeScript SDK -description: ListGuardrailKeyAssignmentsData method reference -seoTitle: ListGuardrailKeyAssignmentsData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailkeyassignmentsdata -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsData | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsData%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsData } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsData = { - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - keyName: "Production Key", - keyLabel: "prod-key", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `keyHash` | *string* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `keyName` | *string* | :heavy_check_mark: | Name of the API key | Production Key | -| `keyLabel` | *string* | :heavy_check_mark: | Label of the API key | prod-key | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailkeyassignmentsrequest.mdx b/client-sdks/typescript/operations/listguardrailkeyassignmentsrequest.mdx deleted file mode 100644 index 99fb4919..00000000 --- a/client-sdks/typescript/operations/listguardrailkeyassignmentsrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsRequest - TypeScript SDK -description: ListGuardrailKeyAssignmentsRequest method reference -seoTitle: ListGuardrailKeyAssignmentsRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsRequest%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *string* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *string* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailkeyassignmentsresponse.mdx b/client-sdks/typescript/operations/listguardrailkeyassignmentsresponse.mdx deleted file mode 100644 index 0bec6276..00000000 --- a/client-sdks/typescript/operations/listguardrailkeyassignmentsresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ListGuardrailKeyAssignmentsResponse - TypeScript SDK -description: ListGuardrailKeyAssignmentsResponse method reference -seoTitle: ListGuardrailKeyAssignmentsResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailKeyAssignmentsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailKeyAssignmentsResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailKeyAssignmentsResponse%20-%20TypeScript%20SDK&description=ListGuardrailKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of key assignments - -## Example Usage - -```typescript lines -import { ListGuardrailKeyAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailKeyAssignmentsResponse = { - data: [ - { - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - keyName: "Production Key", - keyLabel: "prod-key", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - }, - ], - totalCount: 25, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `data` | [operations.ListGuardrailKeyAssignmentsData](/client-sdks/typescript/operations/listguardrailkeyassignmentsdata)[] | :heavy_check_mark: | List of key assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailmemberassignmentsdata.mdx b/client-sdks/typescript/operations/listguardrailmemberassignmentsdata.mdx deleted file mode 100644 index c209365e..00000000 --- a/client-sdks/typescript/operations/listguardrailmemberassignmentsdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsData - TypeScript SDK -description: ListGuardrailMemberAssignmentsData method reference -seoTitle: ListGuardrailMemberAssignmentsData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailmemberassignmentsdata -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsData | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsData method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsData%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsData } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsData = { - id: "550e8400-e29b-41d4-a716-446655440000", - userId: "user_abc123", - organizationId: "org_xyz789", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `userId` | *string* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | -| `organizationId` | *string* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailmemberassignmentsrequest.mdx b/client-sdks/typescript/operations/listguardrailmemberassignmentsrequest.mdx deleted file mode 100644 index ae80118c..00000000 --- a/client-sdks/typescript/operations/listguardrailmemberassignmentsrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsRequest - TypeScript SDK -description: ListGuardrailMemberAssignmentsRequest method reference -seoTitle: ListGuardrailMemberAssignmentsRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsRequest%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *string* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *string* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailmemberassignmentsresponse.mdx b/client-sdks/typescript/operations/listguardrailmemberassignmentsresponse.mdx deleted file mode 100644 index 7a8b3361..00000000 --- a/client-sdks/typescript/operations/listguardrailmemberassignmentsresponse.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: ListGuardrailMemberAssignmentsResponse - TypeScript SDK -description: ListGuardrailMemberAssignmentsResponse method reference -seoTitle: ListGuardrailMemberAssignmentsResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailMemberAssignmentsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailMemberAssignmentsResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailMemberAssignmentsResponse%20-%20TypeScript%20SDK&description=ListGuardrailMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of member assignments - -## Example Usage - -```typescript lines -import { ListGuardrailMemberAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailMemberAssignmentsResponse = { - data: [ - { - id: "550e8400-e29b-41d4-a716-446655440000", - userId: "user_abc123", - organizationId: "org_xyz789", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - }, - ], - totalCount: 10, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.ListGuardrailMemberAssignmentsData](/client-sdks/typescript/operations/listguardrailmemberassignmentsdata)[] | :heavy_check_mark: | List of member assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailsdata.mdx b/client-sdks/typescript/operations/listguardrailsdata.mdx deleted file mode 100644 index 09c56d08..00000000 --- a/client-sdks/typescript/operations/listguardrailsdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListGuardrailsData - TypeScript SDK -description: ListGuardrailsData method reference -seoTitle: ListGuardrailsData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listguardrailsdata' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsData | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsData%20-%20TypeScript%20SDK&description=ListGuardrailsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsData } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsData = { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `resetInterval` | [operations.ListGuardrailsResetInterval](/client-sdks/typescript/operations/listguardrailsresetinterval) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailsrequest.mdx b/client-sdks/typescript/operations/listguardrailsrequest.mdx deleted file mode 100644 index 2a1e833f..00000000 --- a/client-sdks/typescript/operations/listguardrailsrequest.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ListGuardrailsRequest - TypeScript SDK -description: ListGuardrailsRequest method reference -seoTitle: ListGuardrailsRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listguardrailsrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsRequest%20-%20TypeScript%20SDK&description=ListGuardrailsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListGuardrailsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *string* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *string* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailsresetinterval.mdx b/client-sdks/typescript/operations/listguardrailsresetinterval.mdx deleted file mode 100644 index ccb1b319..00000000 --- a/client-sdks/typescript/operations/listguardrailsresetinterval.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: ListGuardrailsResetInterval - TypeScript SDK -description: ListGuardrailsResetInterval method reference -seoTitle: ListGuardrailsResetInterval | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listguardrailsresetinterval -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResetInterval | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsResetInterval method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResetInterval%20-%20TypeScript%20SDK&description=ListGuardrailsResetInterval%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { ListGuardrailsResetInterval } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsResetInterval = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/listguardrailsresponse.mdx b/client-sdks/typescript/operations/listguardrailsresponse.mdx deleted file mode 100644 index 09813893..00000000 --- a/client-sdks/typescript/operations/listguardrailsresponse.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: ListGuardrailsResponse - TypeScript SDK -description: ListGuardrailsResponse method reference -seoTitle: ListGuardrailsResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listguardrailsresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListGuardrailsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListGuardrailsResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListGuardrailsResponse%20-%20TypeScript%20SDK&description=ListGuardrailsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of guardrails - -## Example Usage - -```typescript lines -import { ListGuardrailsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListGuardrailsResponse = { - data: [ - { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", - }, - ], - totalCount: 1, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | [operations.ListGuardrailsData](/client-sdks/typescript/operations/listguardrailsdata)[] | :heavy_check_mark: | List of guardrails | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listkeyassignmentsdata.mdx b/client-sdks/typescript/operations/listkeyassignmentsdata.mdx deleted file mode 100644 index ed517bf3..00000000 --- a/client-sdks/typescript/operations/listkeyassignmentsdata.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: ListKeyAssignmentsData - TypeScript SDK -description: ListKeyAssignmentsData method reference -seoTitle: ListKeyAssignmentsData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listkeyassignmentsdata' -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsData | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsData%20-%20TypeScript%20SDK&description=ListKeyAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsData } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsData = { - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - keyName: "Production Key", - keyLabel: "prod-key", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `keyHash` | *string* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `keyName` | *string* | :heavy_check_mark: | Name of the API key | Production Key | -| `keyLabel` | *string* | :heavy_check_mark: | Label of the API key | prod-key | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listkeyassignmentsrequest.mdx b/client-sdks/typescript/operations/listkeyassignmentsrequest.mdx deleted file mode 100644 index 8a20083e..00000000 --- a/client-sdks/typescript/operations/listkeyassignmentsrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ListKeyAssignmentsRequest - TypeScript SDK -description: ListKeyAssignmentsRequest method reference -seoTitle: ListKeyAssignmentsRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listkeyassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsRequest method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsRequest%20-%20TypeScript%20SDK&description=ListKeyAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *string* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *string* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listkeyassignmentsresponse.mdx b/client-sdks/typescript/operations/listkeyassignmentsresponse.mdx deleted file mode 100644 index 8a2a8ce2..00000000 --- a/client-sdks/typescript/operations/listkeyassignmentsresponse.mdx +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: ListKeyAssignmentsResponse - TypeScript SDK -description: ListKeyAssignmentsResponse method reference -seoTitle: ListKeyAssignmentsResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listkeyassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListKeyAssignmentsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListKeyAssignmentsResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListKeyAssignmentsResponse%20-%20TypeScript%20SDK&description=ListKeyAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of key assignments - -## Example Usage - -```typescript lines -import { ListKeyAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListKeyAssignmentsResponse = { - data: [ - { - id: "550e8400-e29b-41d4-a716-446655440000", - keyHash: - "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - keyName: "Production Key", - keyLabel: "prod-key", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", - }, - ], - totalCount: 25, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `data` | [operations.ListKeyAssignmentsData](/client-sdks/typescript/operations/listkeyassignmentsdata)[] | :heavy_check_mark: | List of key assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listmemberassignmentsdata.mdx b/client-sdks/typescript/operations/listmemberassignmentsdata.mdx deleted file mode 100644 index 235fb6bc..00000000 --- a/client-sdks/typescript/operations/listmemberassignmentsdata.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ListMemberAssignmentsData - TypeScript SDK -description: ListMemberAssignmentsData method reference -seoTitle: ListMemberAssignmentsData | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listmemberassignmentsdata -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsData | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsData method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsData%20-%20TypeScript%20SDK&description=ListMemberAssignmentsData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsData } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsData = { - id: "550e8400-e29b-41d4-a716-446655440000", - userId: "user_abc123", - organizationId: "org_xyz789", - guardrailId: "550e8400-e29b-41d4-a716-446655440001", - assignedBy: "user_abc123", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `userId` | *string* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | -| `organizationId` | *string* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listmemberassignmentsrequest.mdx b/client-sdks/typescript/operations/listmemberassignmentsrequest.mdx deleted file mode 100644 index 2540313e..00000000 --- a/client-sdks/typescript/operations/listmemberassignmentsrequest.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ListMemberAssignmentsRequest - TypeScript SDK -description: ListMemberAssignmentsRequest method reference -seoTitle: ListMemberAssignmentsRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listmemberassignmentsrequest -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsRequest | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsRequest%20-%20TypeScript%20SDK&description=ListMemberAssignmentsRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsRequest } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `offset` | *string* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *string* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listmemberassignmentsresponse.mdx b/client-sdks/typescript/operations/listmemberassignmentsresponse.mdx deleted file mode 100644 index 3ec1c0cb..00000000 --- a/client-sdks/typescript/operations/listmemberassignmentsresponse.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: ListMemberAssignmentsResponse - TypeScript SDK -description: ListMemberAssignmentsResponse method reference -seoTitle: ListMemberAssignmentsResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/listmemberassignmentsresponse -'og:site_name': OpenRouter Documentation -'og:title': ListMemberAssignmentsResponse | OpenRouter TypeScript SDK -'og:description': >- - ListMemberAssignmentsResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListMemberAssignmentsResponse%20-%20TypeScript%20SDK&description=ListMemberAssignmentsResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of member assignments - -## Example Usage - -```typescript lines -import { ListMemberAssignmentsResponse } from "@openrouter/sdk/models/operations"; - -let value: ListMemberAssignmentsResponse = { - data: [], - totalCount: 10, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `data` | [operations.ListMemberAssignmentsData](/client-sdks/typescript/operations/listmemberassignmentsdata)[] | :heavy_check_mark: | List of member assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listmodelsusersecurity.mdx b/client-sdks/typescript/operations/listmodelsusersecurity.mdx deleted file mode 100644 index 410acff9..00000000 --- a/client-sdks/typescript/operations/listmodelsusersecurity.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: ListModelsUserSecurity - TypeScript SDK -description: ListModelsUserSecurity method reference -seoTitle: ListModelsUserSecurity | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listmodelsusersecurity' -'og:site_name': OpenRouter Documentation -'og:title': ListModelsUserSecurity | OpenRouter TypeScript SDK -'og:description': >- - ListModelsUserSecurity method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListModelsUserSecurity%20-%20TypeScript%20SDK&description=ListModelsUserSecurity%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListModelsUserSecurity } from "@openrouter/sdk/models/operations"; - -let value: ListModelsUserSecurity = { - bearer: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listprovidersdata.mdx b/client-sdks/typescript/operations/listprovidersdata.mdx deleted file mode 100644 index 375d8172..00000000 --- a/client-sdks/typescript/operations/listprovidersdata.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: ListProvidersData - TypeScript SDK -description: ListProvidersData method reference -seoTitle: ListProvidersData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listprovidersdata' -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersData | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersData%20-%20TypeScript%20SDK&description=ListProvidersData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListProvidersData } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersData = { - name: "OpenAI", - slug: "openai", - privacyPolicyUrl: "https://openai.com/privacy", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `name` | *string* | :heavy_check_mark: | Display name of the provider | OpenAI | -| `slug` | *string* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `privacyPolicyUrl` | *string* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `termsOfServiceUrl` | *string* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | -| `statusPageUrl` | *string* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listprovidersresponse.mdx b/client-sdks/typescript/operations/listprovidersresponse.mdx deleted file mode 100644 index 90e4d402..00000000 --- a/client-sdks/typescript/operations/listprovidersresponse.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ListProvidersResponse - TypeScript SDK -description: ListProvidersResponse method reference -seoTitle: ListProvidersResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listprovidersresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListProvidersResponse | OpenRouter TypeScript SDK -'og:description': >- - ListProvidersResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListProvidersResponse%20-%20TypeScript%20SDK&description=ListProvidersResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Returns a list of providers - -## Example Usage - -```typescript lines -import { ListProvidersResponse } from "@openrouter/sdk/models/operations"; - -let value: ListProvidersResponse = { - data: [ - { - name: "OpenAI", - slug: "openai", - privacyPolicyUrl: "https://openai.com/privacy", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [operations.ListProvidersData](/client-sdks/typescript/operations/listprovidersdata)[] | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listrequest.mdx b/client-sdks/typescript/operations/listrequest.mdx deleted file mode 100644 index fe8df734..00000000 --- a/client-sdks/typescript/operations/listrequest.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: ListRequest - TypeScript SDK -description: ListRequest method reference -seoTitle: ListRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listrequest' -'og:site_name': OpenRouter Documentation -'og:title': ListRequest | OpenRouter TypeScript SDK -'og:description': >- - ListRequest method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListRequest%20-%20TypeScript%20SDK&description=ListRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ListRequest } from "@openrouter/sdk/models/operations"; - -let value: ListRequest = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `includeDisabled` | *string* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *string* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | \ No newline at end of file diff --git a/client-sdks/typescript/operations/listresponse.mdx b/client-sdks/typescript/operations/listresponse.mdx deleted file mode 100644 index 006a3e77..00000000 --- a/client-sdks/typescript/operations/listresponse.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: ListResponse - TypeScript SDK -description: ListResponse method reference -seoTitle: ListResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/listresponse' -'og:site_name': OpenRouter Documentation -'og:title': ListResponse | OpenRouter TypeScript SDK -'og:description': >- - ListResponse method documentation for the OpenRouter TypeScript SDK. Learn how - to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ListResponse%20-%20TypeScript%20SDK&description=ListResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -List of API keys - -## Example Usage - -```typescript expandable lines -import { ListResponse } from "@openrouter/sdk/models/operations"; - -let value: ListResponse = { - data: [ - { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", - }, - ], -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.ListData](/client-sdks/typescript/operations/listdata)[] | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/client-sdks/typescript/operations/metadata.mdx b/client-sdks/typescript/operations/metadata.mdx deleted file mode 100644 index e3dd6442..00000000 --- a/client-sdks/typescript/operations/metadata.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Metadata - TypeScript SDK -description: Metadata method reference -seoTitle: Metadata | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/metadata' -'og:site_name': OpenRouter Documentation -'og:title': Metadata | OpenRouter TypeScript SDK -'og:description': >- - Metadata method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Metadata%20-%20TypeScript%20SDK&description=Metadata%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Metadata } from "@openrouter/sdk/models/operations"; - -let value: Metadata = { - chainId: 5773.31, - contractAddress: "", - sender: "", -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `chainId` | *number* | :heavy_check_mark: | N/A | -| `contractAddress` | *string* | :heavy_check_mark: | N/A | -| `sender` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/objectembedding.mdx b/client-sdks/typescript/operations/objectembedding.mdx deleted file mode 100644 index f722eeff..00000000 --- a/client-sdks/typescript/operations/objectembedding.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObjectEmbedding - TypeScript SDK -description: ObjectEmbedding method reference -seoTitle: ObjectEmbedding | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/objectembedding' -'og:site_name': OpenRouter Documentation -'og:title': ObjectEmbedding | OpenRouter TypeScript SDK -'og:description': >- - ObjectEmbedding method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectEmbedding%20-%20TypeScript%20SDK&description=ObjectEmbedding%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObjectEmbedding } from "@openrouter/sdk/models/operations"; - -let value: ObjectEmbedding = "embedding"; -``` - -## Values - -```typescript lines -"embedding" -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/objectt.mdx b/client-sdks/typescript/operations/objectt.mdx deleted file mode 100644 index 07755d94..00000000 --- a/client-sdks/typescript/operations/objectt.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ObjectT - TypeScript SDK -description: ObjectT method reference -seoTitle: ObjectT | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/objectt' -'og:site_name': OpenRouter Documentation -'og:title': ObjectT | OpenRouter TypeScript SDK -'og:description': >- - ObjectT method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=ObjectT%20-%20TypeScript%20SDK&description=ObjectT%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { ObjectT } from "@openrouter/sdk/models/operations"; - -let value: ObjectT = "list"; -``` - -## Values - -```typescript lines -"list" -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/ratelimit.mdx b/client-sdks/typescript/operations/ratelimit.mdx deleted file mode 100644 index 0bc31a2a..00000000 --- a/client-sdks/typescript/operations/ratelimit.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: ~~RateLimit~~ - TypeScript SDK -description: ~~RateLimit~~ method reference -seoTitle: ~~RateLimit~~ | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/ratelimit' -'og:site_name': OpenRouter Documentation -'og:title': ~~RateLimit~~ | OpenRouter TypeScript SDK -'og:description': >- - ~~RateLimit~~ method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=~~RateLimit~~%20-%20TypeScript%20SDK&description=~~RateLimit~~%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Legacy rate limit information about a key. Will always return -1. - -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. - -## Example Usage - -```typescript lines -import { RateLimit } from "@openrouter/sdk/models/operations"; - -let value: RateLimit = { - requests: 1000, - interval: "1h", - note: "This field is deprecated and safe to ignore.", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `requests` | *number* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | -| `interval` | *string* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *string* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | \ No newline at end of file diff --git a/client-sdks/typescript/operations/sendchatcompletionrequestresponse.mdx b/client-sdks/typescript/operations/sendchatcompletionrequestresponse.mdx deleted file mode 100644 index c876aa9a..00000000 --- a/client-sdks/typescript/operations/sendchatcompletionrequestresponse.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: SendChatCompletionRequestResponse - TypeScript SDK -description: SendChatCompletionRequestResponse method reference -seoTitle: SendChatCompletionRequestResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/sendchatcompletionrequestresponse -'og:site_name': OpenRouter Documentation -'og:title': SendChatCompletionRequestResponse | OpenRouter TypeScript SDK -'og:description': >- - SendChatCompletionRequestResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=SendChatCompletionRequestResponse%20-%20TypeScript%20SDK&description=SendChatCompletionRequestResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Supported Types - -### `models.ChatResponse` - -```typescript lines -const value: models.ChatResponse = { - id: "", - choices: [], - created: 9184.01, - model: "Focus", - object: "chat.completion", -}; -``` - -### `EventStream` \ No newline at end of file diff --git a/client-sdks/typescript/operations/transferintent.mdx b/client-sdks/typescript/operations/transferintent.mdx deleted file mode 100644 index 75e91767..00000000 --- a/client-sdks/typescript/operations/transferintent.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: TransferIntent - TypeScript SDK -description: TransferIntent method reference -seoTitle: TransferIntent | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/transferintent' -'og:site_name': OpenRouter Documentation -'og:title': TransferIntent | OpenRouter TypeScript SDK -'og:description': >- - TransferIntent method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TransferIntent%20-%20TypeScript%20SDK&description=TransferIntent%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { TransferIntent } from "@openrouter/sdk/models/operations"; - -let value: TransferIntent = { - callData: { - deadline: "", - feeAmount: "", - id: "", - operator: "", - prefix: "", - recipient: "", - recipientAmount: "", - recipientCurrency: "", - refundDestination: "", - signature: "", - }, - metadata: { - chainId: 7497.17, - contractAddress: "", - sender: "", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `callData` | [operations.CallData](/client-sdks/typescript/operations/calldata) | :heavy_check_mark: | N/A | -| `metadata` | [operations.Metadata](/client-sdks/typescript/operations/metadata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardraildata.mdx b/client-sdks/typescript/operations/updateguardraildata.mdx deleted file mode 100644 index 9cf47f0f..00000000 --- a/client-sdks/typescript/operations/updateguardraildata.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: UpdateGuardrailData - TypeScript SDK -description: UpdateGuardrailData method reference -seoTitle: UpdateGuardrailData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updateguardraildata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailData | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailData method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailData%20-%20TypeScript%20SDK&description=UpdateGuardrailData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The updated guardrail - -## Example Usage - -```typescript lines -import { UpdateGuardrailData } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailData = { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Production Guardrail", - createdAt: "2025-08-24T10:30:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `resetInterval` | [operations.UpdateGuardrailResetIntervalResponse](/client-sdks/typescript/operations/updateguardrailresetintervalresponse) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardrailrequest.mdx b/client-sdks/typescript/operations/updateguardrailrequest.mdx deleted file mode 100644 index ae37e829..00000000 --- a/client-sdks/typescript/operations/updateguardrailrequest.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateGuardrailRequest - TypeScript SDK -description: UpdateGuardrailRequest method reference -seoTitle: UpdateGuardrailRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updateguardrailrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequest | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequest%20-%20TypeScript%20SDK&description=UpdateGuardrailRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailRequest = { - id: "550e8400-e29b-41d4-a716-446655440000", - requestBody: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `requestBody` | [operations.UpdateGuardrailRequestBody](/client-sdks/typescript/operations/updateguardrailrequestbody) | :heavy_check_mark: | N/A | `{"name": "Updated Guardrail Name","description": "Updated description","limit_usd": 75,"reset_interval": "weekly"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardrailrequestbody.mdx b/client-sdks/typescript/operations/updateguardrailrequestbody.mdx deleted file mode 100644 index 68e1eb73..00000000 --- a/client-sdks/typescript/operations/updateguardrailrequestbody.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: UpdateGuardrailRequestBody - TypeScript SDK -description: UpdateGuardrailRequestBody method reference -seoTitle: UpdateGuardrailRequestBody | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/updateguardrailrequestbody -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailRequestBody | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailRequestBody method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailRequestBody%20-%20TypeScript%20SDK&description=UpdateGuardrailRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateGuardrailRequestBody } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailRequestBody = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `description` | *string* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `limitUsd` | *number* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `resetInterval` | [operations.UpdateGuardrailResetIntervalRequest](/client-sdks/typescript/operations/updateguardrailresetintervalrequest) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `enforceZdr` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention | true | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardrailresetintervalrequest.mdx b/client-sdks/typescript/operations/updateguardrailresetintervalrequest.mdx deleted file mode 100644 index 1578369e..00000000 --- a/client-sdks/typescript/operations/updateguardrailresetintervalrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: UpdateGuardrailResetIntervalRequest - TypeScript SDK -description: UpdateGuardrailResetIntervalRequest method reference -seoTitle: UpdateGuardrailResetIntervalRequest | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/updateguardrailresetintervalrequest -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResetIntervalRequest | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailResetIntervalRequest method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResetIntervalRequest%20-%20TypeScript%20SDK&description=UpdateGuardrailResetIntervalRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { UpdateGuardrailResetIntervalRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailResetIntervalRequest = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardrailresetintervalresponse.mdx b/client-sdks/typescript/operations/updateguardrailresetintervalresponse.mdx deleted file mode 100644 index 8c92d556..00000000 --- a/client-sdks/typescript/operations/updateguardrailresetintervalresponse.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: UpdateGuardrailResetIntervalResponse - TypeScript SDK -description: UpdateGuardrailResetIntervalResponse method reference -seoTitle: UpdateGuardrailResetIntervalResponse | OpenRouter TypeScript SDK -canonicalUrl: >- - https://openrouter.ai/docs/sdks/typescript/operations/updateguardrailresetintervalresponse -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResetIntervalResponse | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailResetIntervalResponse method documentation for the OpenRouter - TypeScript SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResetIntervalResponse%20-%20TypeScript%20SDK&description=UpdateGuardrailResetIntervalResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Interval at which the limit resets (daily, weekly, monthly) - -## Example Usage - -```typescript lines -import { UpdateGuardrailResetIntervalResponse } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailResetIntervalResponse = "monthly"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/updateguardrailresponse.mdx b/client-sdks/typescript/operations/updateguardrailresponse.mdx deleted file mode 100644 index 24a9fc7d..00000000 --- a/client-sdks/typescript/operations/updateguardrailresponse.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: UpdateGuardrailResponse - TypeScript SDK -description: UpdateGuardrailResponse method reference -seoTitle: UpdateGuardrailResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updateguardrailresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateGuardrailResponse | OpenRouter TypeScript SDK -'og:description': >- - UpdateGuardrailResponse method documentation for the OpenRouter TypeScript - SDK. Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateGuardrailResponse%20-%20TypeScript%20SDK&description=UpdateGuardrailResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -Guardrail updated successfully - -## Example Usage - -```typescript lines -import { UpdateGuardrailResponse } from "@openrouter/sdk/models/operations"; - -let value: UpdateGuardrailResponse = { - data: { - id: "550e8400-e29b-41d4-a716-446655440000", - name: "Updated Guardrail Name", - createdAt: "2025-08-24T10:30:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateGuardrailData](/client-sdks/typescript/operations/updateguardraildata) | :heavy_check_mark: | The updated guardrail | `{"id": "550e8400-e29b-41d4-a716-446655440000","name": "Production Guardrail","description": "Guardrail for production environment","limit_usd": 100,"reset_interval": "monthly","allowed_providers": ["openai","anthropic","google"],"allowed_models": null,"enforce_zdr": false,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updatekeysdata.mdx b/client-sdks/typescript/operations/updatekeysdata.mdx deleted file mode 100644 index be458950..00000000 --- a/client-sdks/typescript/operations/updatekeysdata.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: UpdateKeysData - TypeScript SDK -description: UpdateKeysData method reference -seoTitle: UpdateKeysData | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updatekeysdata' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysData | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysData method documentation for the OpenRouter TypeScript SDK. Learn - how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysData%20-%20TypeScript%20SDK&description=UpdateKeysData%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The updated API key information - -## Example Usage - -```typescript expandable lines -import { UpdateKeysData } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysData = { - hash: - "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", - name: "My Production Key", - label: "Production API Key", - disabled: false, - limit: 100, - limitRemaining: 74.5, - limitReset: "monthly", - includeByokInLimit: false, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T15:45:00Z", -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | 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 | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | Production API Key | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updatekeyslimitreset.mdx b/client-sdks/typescript/operations/updatekeyslimitreset.mdx deleted file mode 100644 index 2db823e6..00000000 --- a/client-sdks/typescript/operations/updatekeyslimitreset.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateKeysLimitReset - TypeScript SDK -description: UpdateKeysLimitReset method reference -seoTitle: UpdateKeysLimitReset | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updatekeyslimitreset' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysLimitReset | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysLimitReset method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysLimitReset%20-%20TypeScript%20SDK&description=UpdateKeysLimitReset%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -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. - -## Example Usage - -```typescript lines -import { UpdateKeysLimitReset } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysLimitReset = "daily"; -``` - -## Values - -This is an open enum. Unrecognized values will be captured as the `Unrecognized` branded type. - -```typescript lines -"daily" | "weekly" | "monthly" | Unrecognized -``` \ No newline at end of file diff --git a/client-sdks/typescript/operations/updatekeysrequest.mdx b/client-sdks/typescript/operations/updatekeysrequest.mdx deleted file mode 100644 index 7f778501..00000000 --- a/client-sdks/typescript/operations/updatekeysrequest.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: UpdateKeysRequest - TypeScript SDK -description: UpdateKeysRequest method reference -seoTitle: UpdateKeysRequest | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updatekeysrequest' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequest | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysRequest method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequest%20-%20TypeScript%20SDK&description=UpdateKeysRequest%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateKeysRequest } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysRequest = { - hash: - "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", - requestBody: {}, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to update | 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 | -| `requestBody` | [operations.UpdateKeysRequestBody](/client-sdks/typescript/operations/updatekeysrequestbody) | :heavy_check_mark: | N/A | `{"name": "Updated API Key Name","disabled": false,"limit": 75,"limit_reset": "daily","include_byok_in_limit": true}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updatekeysrequestbody.mdx b/client-sdks/typescript/operations/updatekeysrequestbody.mdx deleted file mode 100644 index 16c8937c..00000000 --- a/client-sdks/typescript/operations/updatekeysrequestbody.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UpdateKeysRequestBody - TypeScript SDK -description: UpdateKeysRequestBody method reference -seoTitle: UpdateKeysRequestBody | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updatekeysrequestbody' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysRequestBody | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysRequestBody method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysRequestBody%20-%20TypeScript%20SDK&description=UpdateKeysRequestBody%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { UpdateKeysRequestBody } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysRequestBody = {}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether to disable the API key | false | -| `limit` | *number* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limitReset` | [operations.UpdateKeysLimitReset](/client-sdks/typescript/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 | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | \ No newline at end of file diff --git a/client-sdks/typescript/operations/updatekeysresponse.mdx b/client-sdks/typescript/operations/updatekeysresponse.mdx deleted file mode 100644 index c071a719..00000000 --- a/client-sdks/typescript/operations/updatekeysresponse.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: UpdateKeysResponse - TypeScript SDK -description: UpdateKeysResponse method reference -seoTitle: UpdateKeysResponse | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/updatekeysresponse' -'og:site_name': OpenRouter Documentation -'og:title': UpdateKeysResponse | OpenRouter TypeScript SDK -'og:description': >- - UpdateKeysResponse method documentation for the OpenRouter TypeScript SDK. - Learn how to use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=UpdateKeysResponse%20-%20TypeScript%20SDK&description=UpdateKeysResponse%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -API key updated successfully - -## Example Usage - -```typescript expandable lines -import { UpdateKeysResponse } from "@openrouter/sdk/models/operations"; - -let value: UpdateKeysResponse = { - data: { - hash: - "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", - name: "Updated API Key Name", - label: "Updated API Key Name", - disabled: false, - limit: 75, - limitRemaining: 49.5, - limitReset: "daily", - includeByokInLimit: true, - usage: 25.5, - usageDaily: 25.5, - usageWeekly: 25.5, - usageMonthly: 25.5, - byokUsage: 17.38, - byokUsageDaily: 17.38, - byokUsageWeekly: 17.38, - byokUsageMonthly: 17.38, - createdAt: "2025-08-24T10:30:00Z", - updatedAt: "2025-08-24T16:00:00Z", - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateKeysData](/client-sdks/typescript/operations/updatekeysdata) | :heavy_check_mark: | The updated API key information | `{"hash": "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","name": "My Production Key","label": "Production API Key","disabled": false,"limit": 100,"limit_remaining": 74.5,"limit_reset": "monthly","include_byok_in_limit": false,"usage": 25.5,"usage_daily": 25.5,"usage_weekly": 25.5,"usage_monthly": 25.5,"byok_usage": 17.38,"byok_usage_daily": 17.38,"byok_usage_weekly": 17.38,"byok_usage_monthly": 17.38,"created_at": "2025-08-24T10:30:00Z","updated_at": "2025-08-24T15:45:00Z","expires_at": "2027-12-31T23:59:59Z"}` | \ No newline at end of file diff --git a/client-sdks/typescript/operations/usage.mdx b/client-sdks/typescript/operations/usage.mdx deleted file mode 100644 index 9f40004d..00000000 --- a/client-sdks/typescript/operations/usage.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Usage - TypeScript SDK -description: Usage method reference -seoTitle: Usage | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/usage' -'og:site_name': OpenRouter Documentation -'og:title': Usage | OpenRouter TypeScript SDK -'og:description': >- - Usage method documentation for the OpenRouter TypeScript SDK. Learn how to use - this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Usage%20-%20TypeScript%20SDK&description=Usage%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript lines -import { Usage } from "@openrouter/sdk/models/operations"; - -let value: Usage = { - promptTokens: 9797.96, - totalTokens: 7874.4, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `promptTokens` | *number* | :heavy_check_mark: | N/A | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | -| `cost` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/operations/web3data.mdx b/client-sdks/typescript/operations/web3data.mdx deleted file mode 100644 index d9ca06eb..00000000 --- a/client-sdks/typescript/operations/web3data.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Web3Data - TypeScript SDK -description: Web3Data method reference -seoTitle: Web3Data | OpenRouter TypeScript SDK -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript/operations/web3data' -'og:site_name': OpenRouter Documentation -'og:title': Web3Data | OpenRouter TypeScript SDK -'og:description': >- - Web3Data method documentation for the OpenRouter TypeScript SDK. Learn how to - use this API endpoint with code examples. -'og:image': >- - https://openrouter.ai/dynamic-og?title=Web3Data%20-%20TypeScript%20SDK&description=Web3Data%20method%20reference -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouter' -noindex: false -nofollow: false ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -## Example Usage - -```typescript expandable lines -import { Web3Data } from "@openrouter/sdk/models/operations"; - -let value: Web3Data = { - transferIntent: { - callData: { - deadline: "", - feeAmount: "", - id: "", - operator: "", - prefix: "", - recipient: "", - recipientAmount: "", - recipientCurrency: "", - refundDestination: "", - signature: "", - }, - metadata: { - chainId: 7497.17, - contractAddress: "", - sender: "", - }, - }, -}; -``` - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `transferIntent` | [operations.TransferIntent](/client-sdks/typescript/operations/transferintent) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/client-sdks/typescript/overview.mdx b/client-sdks/typescript/overview.mdx deleted file mode 100644 index b48cbe06..00000000 --- a/client-sdks/typescript/overview.mdx +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: TypeScript SDK -description: Official OpenRouter TypeScript SDK documentation -seoTitle: OpenRouter TypeScript SDK | Complete Documentation -canonicalUrl: 'https://openrouter.ai/docs/client-sdks/typescript' -'og:site_name': OpenRouter Documentation -'og:title': OpenRouter TypeScript SDK | Complete Documentation -'og:description': >- - Complete guide to using the OpenRouter TypeScript SDK. Learn how to integrate - AI models into your TypeScript applications. -'og:image': >- - https://openrouter.ai/dynamic-og?title=TypeScript%20SDK&description=Official%20OpenRouter%20TypeScript%20SDK%20documentation -'og:image:width': 1200 -'og:image:height': 630 -'twitter:card': summary_large_image -'twitter:site': '@OpenRouterAI' -noindex: false -nofollow: false -icon: book -sidebarTitle: Overview ---- - -{/* banner:start */} - -The TypeScript SDK and docs are currently in beta. -Report issues on [GitHub](https://github.com/OpenRouterTeam/typescript-sdk/issues). - -{/* banner:end */} - -The OpenRouter TypeScript SDK is a type-safe toolkit for building AI applications with access to 300+ language models through a unified API. - -## Why use the OpenRouter SDK? - -Integrating AI models into applications involves handling different provider APIs, managing model-specific requirements, and avoiding common implementation mistakes. The OpenRouter SDK standardizes these integrations and protects you from footguns. - -```typescript lines -import OpenRouter from '@openrouter/sdk'; - -const client = new OpenRouter({ - apiKey: process.env.OPENROUTER_API_KEY -}); - -const response = await client.chat.send({ - model: "minimax/minimax-m2", - messages: [ - { role: "user", content: "Explain quantum computing" } - ] -}); -``` - -The SDK provides three core benefits: - -### Auto-generated from API specifications - -The SDK is automatically generated from OpenRouter's OpenAPI specs and updated with every API change. New models, parameters, and features appear in your IDE autocomplete immediately. No manual updates. No version drift. - -```typescript lines -// When new models launch, they're available instantly -const response = await client.chat.send({ - model: "minimax/minimax-m2", -}); -``` - -### Type-safe by default - -Every parameter, response field, and configuration option is fully typed. Invalid configurations are caught at compile time, not in production. - -```typescript lines -const response = await client.chat.send({ - model: "minimax/minimax-m2", - messages: [ - { role: "user", content: "Hello" } - // ← Your IDE validates message structure - ], - temperature: 0.7, // ← Type-checked - stream: true // ← Response type changes based on this -}); -``` - -**Actionable error messages:** - -```typescript lines -// Instead of generic errors, get specific guidance: -// "Model 'openai/o1-preview' requires at least 2 messages. -// You provided 1 message. Add a system or user message." -``` - -**Type-safe streaming:** - -```typescript lines -const stream = await client.chat.send({ - model: "minimax/minimax-m2", - messages: [{ role: "user", content: "Write a story" }], - stream: true -}); - -for await (const chunk of stream) { - // Full type information for streaming responses - const content = chunk.choices[0]?.delta?.content; -} -``` - -## Installation - -```bash lines -npm install @openrouter/sdk -``` - -Get your API key from [openrouter.ai/settings/keys](https://openrouter.ai/settings/keys). - -## Quick start - -```typescript lines -import OpenRouter from '@openrouter/sdk'; - -const client = new OpenRouter({ - apiKey: process.env.OPENROUTER_API_KEY -}); - -const response = await client.chat.send({ - model: "minimax/minimax-m2", - messages: [ - { role: "user", content: "Hello!" } - ] -}); - -console.log(response.choices[0].message.content); -``` \ No newline at end of file